This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Route53RecoveryControl::Cluster
<a name="aws-resource-route53recoverycontrol-cluster"></a>

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
<a name="aws-resource-route53recoverycontrol-cluster-syntax"></a>

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

### JSON
<a name="aws-resource-route53recoverycontrol-cluster-syntax.json"></a>

```
{
  "Type" : "AWS::Route53RecoveryControl::Cluster",
  "Properties" : {
      "[Name](#cfn-route53recoverycontrol-cluster-name)" : {{String}},
      "[NetworkType](#cfn-route53recoverycontrol-cluster-networktype)" : {{String}},
      "[Tags](#cfn-route53recoverycontrol-cluster-tags)" : {{[ Tag, ... ]}}
    }
}
```

### YAML
<a name="aws-resource-route53recoverycontrol-cluster-syntax.yaml"></a>

```
Type: AWS::Route53RecoveryControl::Cluster
Properties:
  [Name](#cfn-route53recoverycontrol-cluster-name): {{String}}
  [NetworkType](#cfn-route53recoverycontrol-cluster-networktype): {{String}}
  [Tags](#cfn-route53recoverycontrol-cluster-tags): {{
    - Tag}}
```

## Properties
<a name="aws-resource-route53recoverycontrol-cluster-properties"></a>

`Name`  <a name="cfn-route53recoverycontrol-cluster-name"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NetworkType`  <a name="cfn-route53recoverycontrol-cluster-networktype"></a>
The network-type can either be IPV4 or DUALSTACK.  
*Required*: No  
*Type*: String  
*Allowed values*: `IPV4 | DUALSTACK`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-route53recoverycontrol-cluster-tags"></a>
The tags associated with the cluster.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-route53recoverycontrol-cluster-tag.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-route53recoverycontrol-cluster-return-values"></a>

### Ref
<a name="aws-resource-route53recoverycontrol-cluster-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-route53recoverycontrol-cluster-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-route53recoverycontrol-cluster-return-values-fn--getatt-fn--getatt"></a>

`ClusterArn`  <a name="ClusterArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the cluster.

`ClusterEndpoints`  <a name="ClusterEndpoints-fn::getatt"></a>
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`  <a name="Status-fn::getatt"></a>
The deployment status of the cluster. Status can be one of the following: PENDING, DEPLOYED, PENDING\_DELETION.