CfnEndpointProps Struct
Properties for defining a CfnEndpoint.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
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
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description for the endpoint.
eventBusesIResolvable | IResolvable | CfnEndpoint.EndpointEventBusProperty[]event_busestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EndpointEventBusProperty]]]eventBusesIResolvableEventBusesIResolvableEventBusesinterface{}required#The event buses being used by the endpoint.
Exactly : 2
The name of the endpoint.
replicationConfigoptionalIResolvable | CfnEndpoint.ReplicationConfigPropertyreplication_configoptionaltyping.Union[IResolvable, ReplicationConfigProperty]replicationConfigoptionalIResolvableReplicationConfigoptionalIResolvableReplicationConfigoptionalinterface{}#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 .
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string#The ARN of the role used by event replication for the endpoint.
routingConfigIResolvable | CfnEndpoint.RoutingConfigPropertyrouting_configtyping.Union[IResolvable, RoutingConfigProperty]routingConfigIResolvableRoutingConfigIResolvableRoutingConfiginterface{}required#The routing configuration of the endpoint.