Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatchEvents.Types.Endpoint

Description

Synopsis

data Endpoint = Endpoint' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- description :: Maybe Text
- endpointId :: Maybe Text
- endpointUrl :: Maybe Text
- eventBuses :: Maybe (NonEmpty EndpointEventBus)
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- replicationConfig :: Maybe ReplicationConfig
- roleArn :: Maybe Text
- routingConfig :: Maybe RoutingConfig
- state :: Maybe EndpointState
- stateReason :: Maybe Text
}
newEndpoint :: Endpoint
endpoint_arn :: Lens' Endpoint (Maybe Text)
endpoint_creationTime :: Lens' Endpoint (Maybe UTCTime)
endpoint_description :: Lens' Endpoint (Maybe Text)
endpoint_endpointId :: Lens' Endpoint (Maybe Text)
endpoint_endpointUrl :: Lens' Endpoint (Maybe Text)
endpoint_eventBuses :: Lens' Endpoint (Maybe (NonEmpty EndpointEventBus))
endpoint_lastModifiedTime :: Lens' Endpoint (Maybe UTCTime)
endpoint_name :: Lens' Endpoint (Maybe Text)
endpoint_replicationConfig :: Lens' Endpoint (Maybe ReplicationConfig)
endpoint_roleArn :: Lens' Endpoint (Maybe Text)
endpoint_routingConfig :: Lens' Endpoint (Maybe RoutingConfig)
endpoint_state :: Lens' Endpoint (Maybe EndpointState)
endpoint_stateReason :: Lens' Endpoint (Maybe Text)

Documentation

data Endpoint Source #

An global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..

See: newEndpoint smart constructor.

Constructors

Endpoint'

Fields

arn :: Maybe Text
The ARN of the endpoint.
creationTime :: Maybe POSIX
The time the endpoint was created.
description :: Maybe Text
A description for the endpoint.
endpointId :: Maybe Text
The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
endpointUrl :: Maybe Text
The URL of the endpoint.
eventBuses :: Maybe (NonEmpty EndpointEventBus)
The event buses being used by the endpoint.
lastModifiedTime :: Maybe POSIX
The last time the endpoint was modified.
name :: Maybe Text
The name of the endpoint.
replicationConfig :: Maybe ReplicationConfig
Whether event replication was enabled or disabled for this endpoint.
roleArn :: Maybe Text
The ARN of the role used by event replication for the endpoint.
routingConfig :: Maybe RoutingConfig
The routing configuration of the endpoint.
state :: Maybe EndpointState
The current state of the endpoint.
stateReason :: Maybe Text
The reason the endpoint is in its current state.

Instances

Instances details

FromJSON Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint Methods parseJSON :: Value -> Parser Endpoint # parseJSONList :: Value -> Parser [Endpoint] #
Generic Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint Associated Types type Rep Endpoint :: Type -> Type # Methods from :: Endpoint -> Rep Endpoint x # to :: Rep Endpoint x -> Endpoint #
Read Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint Methods readsPrec :: Int -> ReadS Endpoint # readList :: ReadS [Endpoint] # readPrec :: ReadPrec Endpoint # readListPrec :: ReadPrec [Endpoint] #
Show Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #
NFData Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint Methods rnf :: Endpoint -> () #
Eq Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Hashable Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint Methods hashWithSalt :: Int -> Endpoint -> Int # hash :: Endpoint -> Int #
type Rep Endpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.CloudWatchEvents.Types.Endpoint" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "endpointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endpointUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventBuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty EndpointEventBus)))))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationConfig)))) :: ((S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "routingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingConfig))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointState)) :: S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newEndpoint :: Endpoint Source #

Create a value of Endpoint with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Endpoint', endpoint_arn - The ARN of the endpoint.

$sel:creationTime:Endpoint', endpoint_creationTime - The time the endpoint was created.

$sel:description:Endpoint', endpoint_description - A description for the endpoint.

$sel:endpointId:Endpoint', endpoint_endpointId - The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

$sel:endpointUrl:Endpoint', endpoint_endpointUrl - The URL of the endpoint.

$sel:eventBuses:Endpoint', endpoint_eventBuses - The event buses being used by the endpoint.

$sel:lastModifiedTime:Endpoint', endpoint_lastModifiedTime - The last time the endpoint was modified.

$sel:name:Endpoint', endpoint_name - The name of the endpoint.

$sel:replicationConfig:Endpoint', endpoint_replicationConfig - Whether event replication was enabled or disabled for this endpoint.

$sel:roleArn:Endpoint', endpoint_roleArn - The ARN of the role used by event replication for the endpoint.

$sel:routingConfig:Endpoint', endpoint_routingConfig - The routing configuration of the endpoint.

Endpoint, endpoint_state - The current state of the endpoint.

$sel:stateReason:Endpoint', endpoint_stateReason - The reason the endpoint is in its current state.

endpoint_arn :: Lens' Endpoint (Maybe Text) Source #

The ARN of the endpoint.

endpoint_creationTime :: Lens' Endpoint (Maybe UTCTime) Source #

The time the endpoint was created.

endpoint_description :: Lens' Endpoint (Maybe Text) Source #

A description for the endpoint.

endpoint_endpointId :: Lens' Endpoint (Maybe Text) Source #

The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

endpoint_endpointUrl :: Lens' Endpoint (Maybe Text) Source #

The URL of the endpoint.

endpoint_eventBuses :: Lens' Endpoint (Maybe (NonEmpty EndpointEventBus)) Source #

The event buses being used by the endpoint.

endpoint_lastModifiedTime :: Lens' Endpoint (Maybe UTCTime) Source #

The last time the endpoint was modified.

endpoint_name :: Lens' Endpoint (Maybe Text) Source #

The name of the endpoint.

endpoint_replicationConfig :: Lens' Endpoint (Maybe ReplicationConfig) Source #

Whether event replication was enabled or disabled for this endpoint.

endpoint_roleArn :: Lens' Endpoint (Maybe Text) Source #

The ARN of the role used by event replication for the endpoint.

endpoint_routingConfig :: Lens' Endpoint (Maybe RoutingConfig) Source #

The routing configuration of the endpoint.

endpoint_state :: Lens' Endpoint (Maybe EndpointState) Source #

The current state of the endpoint.

endpoint_stateReason :: Lens' Endpoint (Maybe Text) Source #

The reason the endpoint is in its current state.