CfnEndpointProps

class aws_cdk.aws_events.CfnEndpointProps(*, event_buses, routing_config, description=None, name=None, replication_config=None, role_arn=None)

Bases: object

Properties for defining a CfnEndpoint.

Parameters:

event_buses (Union[IResolvable, Sequence[Union[IResolvable, EndpointEventBusProperty, Dict[str, Any]]]]) – The event buses being used by the endpoint. Exactly : 2
routing_config (Union[IResolvable, RoutingConfigProperty, Dict[str, Any]]) – The routing configuration of the endpoint.
description (Optional[str]) – A description for the endpoint.
name (Optional[str]) – The name of the endpoint.
replication_config (Union[IResolvable, ReplicationConfigProperty, Dict[str, Any], None]) – 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 .
role_arn (Optional[str]) – The ARN of the role used by event replication for the endpoint.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_events as events

cfn_endpoint_props = events.CfnEndpointProps(
    event_buses=[events.CfnEndpoint.EndpointEventBusProperty(
        event_bus_arn="eventBusArn"
    )],
    routing_config=events.CfnEndpoint.RoutingConfigProperty(
        failover_config=events.CfnEndpoint.FailoverConfigProperty(
            primary=events.CfnEndpoint.PrimaryProperty(
                health_check="healthCheck"
            ),
            secondary=events.CfnEndpoint.SecondaryProperty(
                route="route"
            )
        )
    ),

    # the properties below are optional
    description="description",
    name="name",
    replication_config=events.CfnEndpoint.ReplicationConfigProperty(
        state="state"
    ),
    role_arn="roleArn"
)

Attributes

description

A description for the endpoint.

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

event_buses

The event buses being used by the endpoint.

Exactly : 2

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

name

The name of the endpoint.

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

replication_config

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 .

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

role_arn

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

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

routing_config

The routing configuration of the endpoint.

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