Class CfnEndpoint

A global endpoint used to improve your application's availability by making it regional-fault tolerant.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnEndpoint

Implements

IInspectable

IEndpointRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEndpoint : CfnResource, IInspectable, IEndpointRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnEndpoint Inherits CfnResource Implements IInspectable, IEndpointRef, IConstruct, IDependable, IEnvironmentAware

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

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 cfnEndpoint = new CfnEndpoint(this, "MyCfnEndpoint", 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

CfnEndpoint(Construct, string, ICfnEndpointProps)

Create a new AWS::Events::Endpoint.

Properties

AttrArn	The ARN of the endpoint.
AttrEndpointId	The ID of the endpoint.
AttrEndpointUrl	The URL of the endpoint.
AttrState	The main Region of the endpoint.
AttrStateReason	The reason the endpoint is in its current state.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	A global endpoint used to improve your application's availability by making it regional-fault tolerant.
Description	A description for the endpoint.
EndpointRef	A reference to a Endpoint resource.
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.

Methods

ArnForEndpoint(IEndpointRef)	A global endpoint used to improve your application's availability by making it regional-fault tolerant.
FromEndpointArn(Construct, string, string)	Creates a new IEndpointRef from an ARN.
FromEndpointName(Construct, string, string)	Creates a new IEndpointRef from a endpointName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnEndpoint(object)	Checks whether the given object is a CfnEndpoint.
RenderProperties(IDictionary<string, object>)	A global endpoint used to improve your application's availability by making it regional-fault tolerant.

Constructors

CfnEndpoint(Construct, string, ICfnEndpointProps)

Create a new AWS::Events::Endpoint.

public CfnEndpoint(Construct scope, string id, ICfnEndpointProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnEndpointProps

Resource properties.

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the endpoint.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrEndpointId

The ID of the endpoint.

public virtual string AttrEndpointId { get; }

Property Value

string

Remarks

CloudformationAttribute: EndpointId

AttrEndpointUrl

The URL of the endpoint.

public virtual string AttrEndpointUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: EndpointUrl

AttrState

The main Region of the endpoint.

public virtual string AttrState { get; }

Property Value

string

Remarks

CloudformationAttribute: State

AttrStateReason

The reason the endpoint is in its current state.

public virtual string AttrStateReason { get; }

Property Value

string

Remarks

CloudformationAttribute: StateReason

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

CfnProperties

A global endpoint used to improve your application's availability by making it regional-fault tolerant.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

Description

A description for the endpoint.

public virtual string? Description { get; set; }

Property Value

string

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

EndpointRef

A reference to a Endpoint resource.

public virtual IEndpointReference EndpointRef { get; }

Property Value

IEndpointReference

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

EventBuses

The event buses being used by the endpoint.

public virtual object EventBuses { get; set; }

Property Value

object

Remarks

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

Name

The name of the endpoint.

public virtual string? Name { get; set; }

Property Value

string

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

ReplicationConfig

Whether event replication was enabled or disabled for this endpoint.

public virtual object? ReplicationConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnEndpoint.IReplicationConfigProperty

RoleArn

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

public virtual string? RoleArn { get; set; }

Property Value

string

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

RoutingConfig

The routing configuration of the endpoint.

public virtual object RoutingConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnEndpoint.IRoutingConfigProperty

Methods

ArnForEndpoint(IEndpointRef)

A global endpoint used to improve your application's availability by making it regional-fault tolerant.

public static string ArnForEndpoint(IEndpointRef resource)

Parameters

resource IEndpointRef

Returns

string

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

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 cfnEndpoint = new CfnEndpoint(this, "MyCfnEndpoint", 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"
             });

FromEndpointArn(Construct, string, string)

Creates a new IEndpointRef from an ARN.

public static IEndpointRef FromEndpointArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IEndpointRef

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

FromEndpointName(Construct, string, string)

Creates a new IEndpointRef from a endpointName.

public static IEndpointRef FromEndpointName(Construct scope, string id, string endpointName)

Parameters

scope Construct

id string

endpointName string

Returns

IEndpointRef

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

IsCfnEndpoint(object)

Checks whether the given object is a CfnEndpoint.

public static bool IsCfnEndpoint(object x)

Parameters

x object

Returns

bool

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

A global endpoint used to improve your application's availability by making it regional-fault tolerant.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

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

CloudformationResource: AWS::Events::Endpoint

ExampleMetadata: fixture=_generated

Implements

IInspectable

IEndpointRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware