Class CfnEndpoint
A global endpoint used to improve your application's availability by making it regional-fault tolerant.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEndpoint : CfnResource, IInspectable
Syntax (vb)
Public Class CfnEndpoint
Inherits CfnResource
Implements IInspectable
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEndpoint(Construct, String, ICfnEndpointProps) |
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 | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEndpoint(Construct, String, ICfnEndpointProps)
public CfnEndpoint(Construct scope, string id, ICfnEndpointProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEndpointProps
Resource properties.
Properties
AttrArn
The ARN of the endpoint.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrEndpointId
The ID of the endpoint.
public virtual string AttrEndpointId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EndpointId
AttrEndpointUrl
The URL of the endpoint.
public virtual string AttrEndpointUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EndpointUrl
AttrState
The main Region of the endpoint.
public virtual string AttrState { get; }
Property Value
System.String
Remarks
CloudformationAttribute: State
AttrStateReason
The reason the endpoint is in its current state.
public virtual string AttrStateReason { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the endpoint.
public virtual string Description { get; set; }
Property Value
System.String
EventBuses
The event buses being used by the endpoint.
public virtual object EventBuses { get; set; }
Property Value
System.Object
Name
The name of the endpoint.
public virtual string Name { get; set; }
Property Value
System.String
ReplicationConfig
Whether event replication was enabled or disabled for this endpoint.
public virtual object ReplicationConfig { get; set; }
Property Value
System.Object
RoleArn
The ARN of the role used by event replication for the endpoint.
public virtual string RoleArn { get; set; }
Property Value
System.String
RoutingConfig
The routing configuration of the endpoint.
public virtual object RoutingConfig { get; set; }
Property Value
System.Object
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>