software.amazon.awscdk.services.events

Class CfnEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.events.CfnEndpoint

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.257Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpoint(software.constructs.Construct scope, 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
String	getAttrArn() The ARN of the endpoint.
String	getAttrEndpointId() The ID of the endpoint.
String	getAttrEndpointUrl() The URL of the endpoint.
String	getAttrState() The current state of the endpoint.
String	getAttrStateReason() The reason the endpoint is in its current state.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description for the endpoint.
Object	getEventBuses() The event buses being used by the endpoint.
String	getName() The name of the endpoint.
Object	getReplicationConfig() Whether event replication was enabled or disabled for this endpoint.
String	getRoleArn() The ARN of the role used by event replication for the endpoint.
Object	getRoutingConfig() The routing configuration of the endpoint.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description for the endpoint.
void	setEventBuses(IResolvable value) The event buses being used by the endpoint.
void	setEventBuses(List<Object> value) The event buses being used by the endpoint.
void	setName(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(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.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnEndpoint(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the endpoint.

getAttrEndpointId

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointId()

The ID of the endpoint.

getAttrEndpointUrl

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointUrl()

The URL of the endpoint.

getAttrState

@Stability(value=Stable)
 @NotNull
public String getAttrState()

The current state of the endpoint.

getAttrStateReason

@Stability(value=Stable)
 @NotNull
public String getAttrStateReason()

The reason the endpoint is in its current state.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEventBuses

@Stability(value=Stable)
 @NotNull
public Object getEventBuses()

The event buses being used by the endpoint.

Exactly : 2

setEventBuses

@Stability(value=Stable)
public void setEventBuses(@NotNull
                                                   IResolvable value)

The event buses being used by the endpoint.

Exactly : 2

setEventBuses

@Stability(value=Stable)
public void setEventBuses(@NotNull
                                                   List<Object> value)

The event buses being used by the endpoint.

Exactly : 2

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the endpoint.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the endpoint.

getRoutingConfig

@Stability(value=Stable)
 @NotNull
public Object getRoutingConfig()

The routing configuration of the endpoint.

setRoutingConfig

@Stability(value=Stable)
public void setRoutingConfig(@NotNull
                                                      CfnEndpoint.RoutingConfigProperty value)

The routing configuration of the endpoint.

setRoutingConfig

@Stability(value=Stable)
public void setRoutingConfig(@NotNull
                                                      IResolvable value)

The routing configuration of the endpoint.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the endpoint.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the endpoint.

getReplicationConfig

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setReplicationConfig(@Nullable
                                                          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 .

setReplicationConfig

@Stability(value=Stable)
public void setReplicationConfig(@Nullable
                                                          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 .

getRoleArn

@Stability(value=Stable)
 @Nullable
public String getRoleArn()

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                String value)

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