Class CfnMultiRegionEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMultiRegionEndpointRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:14.487Z") @Stability(Stable) public class CfnMultiRegionEndpoint extends CfnResource implements IInspectable, IMultiRegionEndpointRef, ITaggableV2
Creates a multi-region endpoint (global-endpoint).

The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed.

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.ses.*;
 CfnMultiRegionEndpoint cfnMultiRegionEndpoint = CfnMultiRegionEndpoint.Builder.create(this, "MyCfnMultiRegionEndpoint")
         .details(DetailsProperty.builder()
                 .routeDetails(List.of(RouteDetailsItemsProperty.builder()
                         .region("region")
                         .build()))
                 .build())
         .endpointName("endpointName")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:
  • 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

    • CfnMultiRegionEndpoint

      protected CfnMultiRegionEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnMultiRegionEndpoint

      protected CfnMultiRegionEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnMultiRegionEndpoint

      @Stability(Stable) public CfnMultiRegionEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMultiRegionEndpointProps props)
      Create a new AWS::SES::MultiRegionEndpoint.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.
    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2
    • getCfnProperties

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

      @Stability(Stable) @NotNull public MultiRegionEndpointReference getMultiRegionEndpointRef()
      A reference to a MultiRegionEndpoint resource.
      Specified by:
      getMultiRegionEndpointRef in interface IMultiRegionEndpointRef
    • getDetails

      @Stability(Stable) @NotNull public Object getDetails()
      Contains details of a multi-region endpoint (global-endpoint) being created.

      Returns union: either IResolvable or CfnMultiRegionEndpoint.DetailsProperty

    • setDetails

      @Stability(Stable) public void setDetails(@NotNull IResolvable value)
      Contains details of a multi-region endpoint (global-endpoint) being created.
    • setDetails

      @Stability(Stable) public void setDetails(@NotNull CfnMultiRegionEndpoint.DetailsProperty value)
      Contains details of a multi-region endpoint (global-endpoint) being created.
    • getEndpointName

      @Stability(Stable) @NotNull public String getEndpointName()
      The name of the multi-region endpoint (global-endpoint).
    • setEndpointName

      @Stability(Stable) public void setEndpointName(@NotNull String value)
      The name of the multi-region endpoint (global-endpoint).
    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of objects that define the tags (keys and values) to associate with the multi-region endpoint (global-endpoint).
    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of objects that define the tags (keys and values) to associate with the multi-region endpoint (global-endpoint).