Class CfnEndpointProps

Properties for defining a CfnEndpoint.

Inheritance

object

CfnEndpointProps

Implements

ICfnEndpointProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEndpointProps : ICfnEndpointProps

Syntax (vb)

Public Class CfnEndpointProps Implements 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

Constructors

CfnEndpointProps()

Properties for defining a CfnEndpoint.

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.

Constructors

CfnEndpointProps()

Properties for defining a CfnEndpoint.

public CfnEndpointProps()

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"
             };

Properties

Description

A description for the endpoint.

public string? Description { get; set; }

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.

public object EventBuses { get; set; }

Property Value

object

Remarks

Exactly : 2

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

Name

The name of the endpoint.

public string? Name { get; set; }

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.

public object? ReplicationConfig { get; set; }

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

RoleArn

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

public string? RoleArn { get; set; }

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.

public object RoutingConfig { get; set; }