Package software.amazon.awscdk.services.events

Class CfnEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.973Z") @Stability(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()))
         .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")
         .name("name")
         .replicationConfig(ReplicationConfigProperty.builder()
                 .state("state")
                 .build())
         .roleArn("roleArn")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEndpoint

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

    • CfnEndpoint

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

    • CfnEndpoint

      @Stability(Stable) public CfnEndpoint(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The ARN of the endpoint.

    • getAttrEndpointId

      @Stability(Stable) @NotNull public String getAttrEndpointId()
      The ID of the endpoint.

    • getAttrEndpointUrl

      @Stability(Stable) @NotNull public String getAttrEndpointUrl()
      The URL of the endpoint.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The current state of the endpoint.

    • getAttrStateReason

      @Stability(Stable) @NotNull public String getAttrStateReason()
      The reason the endpoint is in its current state.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEventBuses

      @Stability(Stable) @NotNull public Object getEventBuses()
      The event buses being used by the endpoint.

      Exactly : 2

    • setEventBuses

      @Stability(Stable) public void setEventBuses(@NotNull IResolvable value)
      The event buses being used by the endpoint.

      Exactly : 2

    • setEventBuses

      @Stability(Stable) public void setEventBuses(@NotNull List<Object> value)
      The event buses being used by the endpoint.

      Exactly : 2

    • getRoutingConfig

      @Stability(Stable) @NotNull public Object getRoutingConfig()
      The routing configuration of the endpoint.

    • setRoutingConfig

      @Stability(Stable) public void setRoutingConfig(@NotNull IResolvable value)
      The routing configuration of the endpoint.

    • setRoutingConfig

      @Stability(Stable) public void setRoutingConfig(@NotNull CfnEndpoint.RoutingConfigProperty value)
      The routing configuration of the endpoint.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the endpoint.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the endpoint.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the endpoint.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the endpoint.

    • getReplicationConfig

      @Stability(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(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 .

    • setReplicationConfig

      @Stability(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 .

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The ARN of the role used by event replication for the endpoint.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The ARN of the role used by event replication for the endpoint.