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.CreateEndpoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

Synopsis

data CreateEndpoint = CreateEndpoint' {
- description :: Maybe Text
- replicationConfig :: Maybe ReplicationConfig
- roleArn :: Maybe Text
- name :: Text
- routingConfig :: RoutingConfig
- eventBuses :: NonEmpty EndpointEventBus
}
newCreateEndpoint :: Text -> RoutingConfig -> NonEmpty EndpointEventBus -> CreateEndpoint
createEndpoint_description :: Lens' CreateEndpoint (Maybe Text)
createEndpoint_replicationConfig :: Lens' CreateEndpoint (Maybe ReplicationConfig)
createEndpoint_roleArn :: Lens' CreateEndpoint (Maybe Text)
createEndpoint_name :: Lens' CreateEndpoint Text
createEndpoint_routingConfig :: Lens' CreateEndpoint RoutingConfig
createEndpoint_eventBuses :: Lens' CreateEndpoint (NonEmpty EndpointEventBus)
data CreateEndpointResponse = CreateEndpointResponse' {
- arn :: Maybe Text
- eventBuses :: Maybe (NonEmpty EndpointEventBus)
- name :: Maybe Text
- replicationConfig :: Maybe ReplicationConfig
- roleArn :: Maybe Text
- routingConfig :: Maybe RoutingConfig
- state :: Maybe EndpointState
- httpStatus :: Int
}
newCreateEndpointResponse :: Int -> CreateEndpointResponse
createEndpointResponse_arn :: Lens' CreateEndpointResponse (Maybe Text)
createEndpointResponse_eventBuses :: Lens' CreateEndpointResponse (Maybe (NonEmpty EndpointEventBus))
createEndpointResponse_name :: Lens' CreateEndpointResponse (Maybe Text)
createEndpointResponse_replicationConfig :: Lens' CreateEndpointResponse (Maybe ReplicationConfig)
createEndpointResponse_roleArn :: Lens' CreateEndpointResponse (Maybe Text)
createEndpointResponse_routingConfig :: Lens' CreateEndpointResponse (Maybe RoutingConfig)
createEndpointResponse_state :: Lens' CreateEndpointResponse (Maybe EndpointState)
createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int

Creating a Request

data CreateEndpoint Source #

See: newCreateEndpoint smart constructor.

Constructors

CreateEndpoint'

Fields

description :: Maybe Text
A description of the global endpoint.
replicationConfig :: Maybe ReplicationConfig
Enable or disable event replication.
roleArn :: Maybe Text
The ARN of the role used for replication.
name :: Text
The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".
routingConfig :: RoutingConfig
Configure the routing policy, including the health check and secondary Region..
eventBuses :: NonEmpty EndpointEventBus
Define the event buses used.
The names of the event buses must be identical in each Region.

Instances

Instances details

ToJSON CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods toJSON :: CreateEndpoint -> Value # toEncoding :: CreateEndpoint -> Encoding # toJSONList :: [CreateEndpoint] -> Value # toEncodingList :: [CreateEndpoint] -> Encoding #
ToHeaders CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods toHeaders :: CreateEndpoint -> [Header] #
ToPath CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods toPath :: CreateEndpoint -> ByteString #
ToQuery CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods toQuery :: CreateEndpoint -> QueryString #
AWSRequest CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Associated Types type AWSResponse CreateEndpoint # Methods request :: (Service -> Service) -> CreateEndpoint -> Request CreateEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEndpoint))) #
Generic CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Associated Types type Rep CreateEndpoint :: Type -> Type # Methods from :: CreateEndpoint -> Rep CreateEndpoint x # to :: Rep CreateEndpoint x -> CreateEndpoint #
Read CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods readsPrec :: Int -> ReadS CreateEndpoint # readList :: ReadS [CreateEndpoint] # readPrec :: ReadPrec CreateEndpoint # readListPrec :: ReadPrec [CreateEndpoint] #
Show CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods showsPrec :: Int -> CreateEndpoint -> ShowS # show :: CreateEndpoint -> String # showList :: [CreateEndpoint] -> ShowS #
NFData CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods rnf :: CreateEndpoint -> () #
Eq CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods (==) :: CreateEndpoint -> CreateEndpoint -> Bool # (/=) :: CreateEndpoint -> CreateEndpoint -> Bool #
Hashable CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods hashWithSalt :: Int -> CreateEndpoint -> Int # hash :: CreateEndpoint -> Int #
type AWSResponse CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint type AWSResponse CreateEndpoint = CreateEndpointResponse
type Rep CreateEndpoint Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint type Rep CreateEndpoint = D1 ('MetaData "CreateEndpoint" "Amazonka.CloudWatchEvents.CreateEndpoint" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "CreateEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") '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 "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "routingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RoutingConfig) :*: S1 ('MetaSel ('Just "eventBuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty EndpointEventBus))))))

newCreateEndpoint Source #

Arguments

:: Text	`CreateEndpoint`
-> RoutingConfig	`CreateEndpoint`
-> NonEmpty EndpointEventBus	`CreateEndpoint`
-> CreateEndpoint

Create a value of CreateEndpoint 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:

CreateEndpoint, createEndpoint_description - A description of the global endpoint.

CreateEndpoint, createEndpoint_replicationConfig - Enable or disable event replication.

CreateEndpoint, createEndpoint_roleArn - The ARN of the role used for replication.

CreateEndpoint, createEndpoint_name - The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

CreateEndpoint, createEndpoint_routingConfig - Configure the routing policy, including the health check and secondary Region..

CreateEndpoint, createEndpoint_eventBuses - Define the event buses used.

The names of the event buses must be identical in each Region.

Request Lenses

createEndpoint_description :: Lens' CreateEndpoint (Maybe Text) Source #

A description of the global endpoint.

createEndpoint_replicationConfig :: Lens' CreateEndpoint (Maybe ReplicationConfig) Source #

Enable or disable event replication.

createEndpoint_roleArn :: Lens' CreateEndpoint (Maybe Text) Source #

The ARN of the role used for replication.

createEndpoint_name :: Lens' CreateEndpoint Text Source #

The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

createEndpoint_routingConfig :: Lens' CreateEndpoint RoutingConfig Source #

Configure the routing policy, including the health check and secondary Region..

createEndpoint_eventBuses :: Lens' CreateEndpoint (NonEmpty EndpointEventBus) Source #

Define the event buses used.

The names of the event buses must be identical in each Region.

Destructuring the Response

data CreateEndpointResponse Source #

See: newCreateEndpointResponse smart constructor.

Constructors

CreateEndpointResponse'

Fields

arn :: Maybe Text
The ARN of the endpoint that was created by this request.
eventBuses :: Maybe (NonEmpty EndpointEventBus)
The event buses used by this request.
name :: Maybe Text
The name of the endpoint that was created by this request.
replicationConfig :: Maybe ReplicationConfig
Whether event replication was enabled or disabled by this request.
roleArn :: Maybe Text
The ARN of the role used by event replication for this request.
routingConfig :: Maybe RoutingConfig
The routing configuration defined by this request.
state :: Maybe EndpointState
The state of the endpoint that was created by this request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Associated Types type Rep CreateEndpointResponse :: Type -> Type # Methods from :: CreateEndpointResponse -> Rep CreateEndpointResponse x # to :: Rep CreateEndpointResponse x -> CreateEndpointResponse #
Read CreateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods readsPrec :: Int -> ReadS CreateEndpointResponse # readList :: ReadS [CreateEndpointResponse] # readPrec :: ReadPrec CreateEndpointResponse # readListPrec :: ReadPrec [CreateEndpointResponse] #
Show CreateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods showsPrec :: Int -> CreateEndpointResponse -> ShowS # show :: CreateEndpointResponse -> String # showList :: [CreateEndpointResponse] -> ShowS #
NFData CreateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods rnf :: CreateEndpointResponse -> () #
Eq CreateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint Methods (==) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool # (/=) :: CreateEndpointResponse -> CreateEndpointResponse -> Bool #
type Rep CreateEndpointResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreateEndpoint type Rep CreateEndpointResponse = D1 ('MetaData "CreateEndpointResponse" "Amazonka.CloudWatchEvents.CreateEndpoint" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "CreateEndpointResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventBuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty EndpointEventBus)))) :: (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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateEndpointResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEndpointResponse'`
-> CreateEndpointResponse

Create a value of CreateEndpointResponse 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:

CreateEndpointResponse, createEndpointResponse_arn - The ARN of the endpoint that was created by this request.

CreateEndpoint, createEndpointResponse_eventBuses - The event buses used by this request.

CreateEndpoint, createEndpointResponse_name - The name of the endpoint that was created by this request.

CreateEndpoint, createEndpointResponse_replicationConfig - Whether event replication was enabled or disabled by this request.

CreateEndpoint, createEndpointResponse_roleArn - The ARN of the role used by event replication for this request.

CreateEndpoint, createEndpointResponse_routingConfig - The routing configuration defined by this request.

CreateEndpointResponse, createEndpointResponse_state - The state of the endpoint that was created by this request.

$sel:httpStatus:CreateEndpointResponse', createEndpointResponse_httpStatus - The response's http status code.

Response Lenses

createEndpointResponse_arn :: Lens' CreateEndpointResponse (Maybe Text) Source #

The ARN of the endpoint that was created by this request.

createEndpointResponse_eventBuses :: Lens' CreateEndpointResponse (Maybe (NonEmpty EndpointEventBus)) Source #

The event buses used by this request.

createEndpointResponse_name :: Lens' CreateEndpointResponse (Maybe Text) Source #

The name of the endpoint that was created by this request.

createEndpointResponse_replicationConfig :: Lens' CreateEndpointResponse (Maybe ReplicationConfig) Source #

Whether event replication was enabled or disabled by this request.

createEndpointResponse_roleArn :: Lens' CreateEndpointResponse (Maybe Text) Source #

The ARN of the role used by event replication for this request.

createEndpointResponse_routingConfig :: Lens' CreateEndpointResponse (Maybe RoutingConfig) Source #

The routing configuration defined by this request.

createEndpointResponse_state :: Lens' CreateEndpointResponse (Maybe EndpointState) Source #

The state of the endpoint that was created by this request.

createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #

The response's http status code.