interface CfnEndpointProps

Language	Type name
.NET	Amazon.CDK.AWS.Events.CfnEndpointProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnEndpointProps
Java	software.amazon.awscdk.services.events.CfnEndpointProps
Python	aws_cdk.aws_events.CfnEndpointProps
TypeScript	aws-cdk-lib » aws_events » CfnEndpointProps

Properties for defining a CfnEndpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html

Example

// 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

Name	Type	Description
eventBuses	IResolvable | (IResolvable | EndpointEventBusProperty)[]	The event buses being used by the endpoint.
routingConfig	IResolvable | RoutingConfigProperty	The routing configuration of the endpoint.
description?	string	A description for the endpoint.
name?	string	The name of the endpoint.
replicationConfig?	IResolvable | ReplicationConfigProperty	Whether event replication was enabled or disabled for this endpoint.
roleArn?	string	The ARN of the role used by event replication for the endpoint.

---

eventBuses

Type: IResolvable | (IResolvable | EndpointEventBusProperty)[]

The event buses being used by the endpoint.

Exactly : 2

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses

---

routingConfig

Type: IResolvable | RoutingConfigProperty

The routing configuration of the endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig

---

description?

Type: string (optional)

A description for the endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description

---

name?

Type: string (optional)

The name of the endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name

---

replicationConfig?

Type: IResolvable | ReplicationConfigProperty (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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig

---

roleArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn