software.amazon.awscdk.services.events

Class CfnEndpoint

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.events.CfnEndpoint

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:53.612Z")
public class CfnEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Events::Endpoint`.

A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
         .eventBuses(List.of(EndpointEventBusProperty.builder()
                 .eventBusArn("eventBusArn")
                 .build()))
         .name("name")
         .routingConfig(RoutingConfigProperty.builder()
                 .failoverConfig(FailoverConfigProperty.builder()
                         .primary(PrimaryProperty.builder()
                                 .healthCheck("healthCheck")
                                 .build())
                         .secondary(SecondaryProperty.builder()
                                 .route("route")
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .replicationConfig(ReplicationConfigProperty.builder()
                 .state("state")
                 .build())
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEndpoint.Builder A fluent builder for CfnEndpoint.
static interface	CfnEndpoint.EndpointEventBusProperty The event buses the endpoint is associated with.
static interface	CfnEndpoint.FailoverConfigProperty The failover configuration for an endpoint.
static interface	CfnEndpoint.PrimaryProperty The primary Region of the endpoint.
static interface	CfnEndpoint.ReplicationConfigProperty Endpoints can replicate all events to the secondary Region.
static interface	CfnEndpoint.RoutingConfigProperty The routing configuration of the endpoint.
static interface	CfnEndpoint.SecondaryProperty The secondary Region that processes events when failover is triggered or replication is enabled.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpoint(Construct scope, java.lang.String id, CfnEndpointProps props) Create a new `AWS::Events::Endpoint`.
protected	CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The ARN of the endpoint.
java.lang.String	getAttrEndpointId() The ID of the endpoint.
java.lang.String	getAttrEndpointUrl() The URL of the endpoint.
java.lang.String	getAttrState() The current state of the endpoint.
java.lang.String	getAttrStateReason() The reason the endpoint is in its current state.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description for the endpoint.
java.lang.Object	getEventBuses() The event buses being used by the endpoint.
java.lang.String	getName() The name of the endpoint.
java.lang.Object	getReplicationConfig() Whether event replication was enabled or disabled for this endpoint.
java.lang.String	getRoleArn() The ARN of the role used by event replication for the endpoint.
java.lang.Object	getRoutingConfig() The routing configuration of the endpoint.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A description for the endpoint.
void	setEventBuses(IResolvable value) The event buses being used by the endpoint.
void	setEventBuses(java.util.List<java.lang.Object> value) The event buses being used by the endpoint.
void	setName(java.lang.String value) The name of the endpoint.
void	setReplicationConfig(CfnEndpoint.ReplicationConfigProperty value) Whether event replication was enabled or disabled for this endpoint.
void	setReplicationConfig(IResolvable value) Whether event replication was enabled or disabled for this endpoint.
void	setRoleArn(java.lang.String value) The ARN of the role used by event replication for the endpoint.
void	setRoutingConfig(CfnEndpoint.RoutingConfigProperty value) The routing configuration of the endpoint.
void	setRoutingConfig(IResolvable value) The routing configuration of the endpoint.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEndpoint

public CfnEndpoint(Construct scope,
                   java.lang.String id,
                   CfnEndpointProps props)

Create a new `AWS::Events::Endpoint`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the endpoint.

getAttrEndpointId

public java.lang.String getAttrEndpointId()

The ID of the endpoint.

getAttrEndpointUrl

public java.lang.String getAttrEndpointUrl()

The URL of the endpoint.

getAttrState

public java.lang.String getAttrState()

The current state of the endpoint.

getAttrStateReason

public java.lang.String getAttrStateReason()

The reason the endpoint is in its current state.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEventBuses

public java.lang.Object getEventBuses()

The event buses being used by the endpoint.

Exactly : 2

setEventBuses

public void setEventBuses(IResolvable value)

The event buses being used by the endpoint.

Exactly : 2

setEventBuses

public void setEventBuses(java.util.List<java.lang.Object> value)

The event buses being used by the endpoint.

Exactly : 2

getName

public java.lang.String getName()

The name of the endpoint.

setName

public void setName(java.lang.String value)

The name of the endpoint.

getRoutingConfig

public java.lang.Object getRoutingConfig()

The routing configuration of the endpoint.

setRoutingConfig

public void setRoutingConfig(IResolvable value)

The routing configuration of the endpoint.

setRoutingConfig

public void setRoutingConfig(CfnEndpoint.RoutingConfigProperty value)

The routing configuration of the endpoint.

getDescription

public java.lang.String getDescription()

A description for the endpoint.

setDescription

public void setDescription(java.lang.String value)

A description for the endpoint.

getReplicationConfig

public java.lang.Object getReplicationConfig()

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 .

setReplicationConfig

public void setReplicationConfig(IResolvable value)

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 .

setReplicationConfig

public void setReplicationConfig(CfnEndpoint.ReplicationConfigProperty value)

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 .

getRoleArn

public java.lang.String getRoleArn()

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

setRoleArn

public void setRoleArn(java.lang.String value)

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