interface CfnEndpointProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Events.CfnEndpointProps |
![]() | software.amazon.awscdk.services.events.CfnEndpointProps |
![]() | aws_cdk.aws_events.CfnEndpointProps |
![]() | @aws-cdk/aws-events » CfnEndpointProps |
Properties for defining a CfnEndpoint
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as events from '@aws-cdk/aws-events';
const cfnEndpointProps: events.CfnEndpointProps = {
eventBuses: [{
eventBusArn: 'eventBusArn',
}],
routingConfig: {
failoverConfig: {
primary: {
healthCheck: 'healthCheck',
},
secondary: {
route: 'route',
},
},
},
// the properties below are optional
description: 'description',
name: 'name',
replicationConfig: {
state: 'state',
},
roleArn: 'roleArn',
};
Properties
Name | Type | Description |
---|---|---|
event | IResolvable | IResolvable | Endpoint [] | The event buses being used by the endpoint. |
routing | IResolvable | Routing | The routing configuration of the endpoint. |
description? | string | A description for the endpoint. |
name? | string | The name of the endpoint. |
replication | IResolvable | Replication | Whether event replication was enabled or disabled for this endpoint. |
role | string | The ARN of the role used by event replication for the endpoint. |
eventBuses
Type:
IResolvable
|
IResolvable
|
Endpoint
[]
The event buses being used by the endpoint.
Exactly : 2
routingConfig
Type:
IResolvable
|
Routing
The routing configuration of the endpoint.
description?
Type:
string
(optional)
A description for the endpoint.
name?
Type:
string
(optional)
The name of the endpoint.
replicationConfig?
Type:
IResolvable
|
Replication
(optional)
Whether event replication was enabled or disabled for this endpoint.
The default state is ENABLED
which means you must supply a RoleArn
. If you don't have a RoleArn
or you don't want event replication enabled, set the state to DISABLED
.
roleArn?
Type:
string
(optional)
The ARN of the role used by event replication for the endpoint.