Interface ICfnEndpointProps

Properties for defining a CfnEndpoint.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnEndpointProps

Syntax (vb)

Public Interface ICfnEndpointProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Events;

             var cfnEndpointProps = new CfnEndpointProps {
                 EventBuses = new [] { new EndpointEventBusProperty {
                     EventBusArn = "eventBusArn"
                 } },
                 RoutingConfig = new RoutingConfigProperty {
                     FailoverConfig = new FailoverConfigProperty {
                         Primary = new PrimaryProperty {
                             HealthCheck = "healthCheck"
                         },
                         Secondary = new SecondaryProperty {
                             Route = "route"
                         }
                     }
                 },

                 // the properties below are optional
                 Description = "description",
                 Name = "name",
                 ReplicationConfig = new ReplicationConfigProperty {
                     State = "state"
                 },
                 RoleArn = "roleArn"
             };

Synopsis

Properties

Description	A description for the endpoint.
EventBuses	The event buses being used by the endpoint.
Name	The name of the endpoint.
ReplicationConfig	Whether event replication was enabled or disabled for this endpoint.
RoleArn	The ARN of the role used by event replication for the endpoint.
RoutingConfig	The routing configuration of the endpoint.

Properties

Description

A description for the endpoint.

string? Description { get; }

Property Value

string

Remarks

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

EventBuses

The event buses being used by the endpoint.

object EventBuses { get; }

Property Value

object

Remarks

Exactly : 2

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

Type union: either IResolvable or (either IResolvable or CfnEndpoint.IEndpointEventBusProperty)[]

Name

The name of the endpoint.

string? Name { get; }

Property Value

string

Remarks

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

ReplicationConfig

Whether event replication was enabled or disabled for this endpoint.

object? ReplicationConfig { get; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig

Type union: either IResolvable or CfnEndpoint.IReplicationConfigProperty

RoleArn

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

string? RoleArn { get; }

Property Value

string

Remarks

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

RoutingConfig

The routing configuration of the endpoint.

object RoutingConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnEndpoint.IRoutingConfigProperty