AWS::Route53RecoveryControl::Cluster - AWS CloudFormation
SyntaxPropertiesReturn values

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Route53RecoveryControl::Cluster",
  "Properties" : {
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Route53RecoveryControl::Cluster
Properties:
  Name: String
  Tags: 
    - Tag

Properties

Name

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

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

Tags

The tags associated with the cluster.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ClusterArn object.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ClusterArn

The Amazon Resource Name (ARN) of the cluster.

ClusterEndpoints

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.

Status

The deployment status of the cluster. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.