Package software.amazon.awscdk.services.route53recoverycontrol

Class CfnCluster

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.route53recoverycontrol.CfnCluster
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:35.024Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable
A CloudFormation AWS::Route53RecoveryControl::Cluster.

Creates a cluster in Amazon Route 53 Application Recovery Controller. A cluster is a set of redundant Regional endpoints that you can run Route 53 ARC API calls against to update or get the state of one or more routing controls.

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.route53recoverycontrol.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .name("name")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnCluster

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

    • CfnCluster

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

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull Construct scope, @NotNull String id, @NotNull CfnClusterProps props)
      Create a new AWS::Route53RecoveryControl::Cluster.

      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.

    • getAttrClusterArn

      @Stability(Stable) @NotNull public String getAttrClusterArn()
      The Amazon Resource Name (ARN) of the cluster.

    • getAttrClusterEndpoints

      @Stability(Stable) @NotNull public IResolvable getAttrClusterEndpoints()
      An array of endpoints for the cluster.

      You specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The deployment status of the cluster.

      Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The value for a tag.

    • getName

      @Stability(Stable) @NotNull public String getName()
      Name of the cluster.

      You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon).

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      Name of the cluster.

      You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon).