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::WorkSpaces::ConnectionAlias
<a name="aws-resource-workspaces-connectionalias"></a>

The `AWS::WorkSpaces::ConnectionAlias` resource specifies a connection alias. Connection aliases are used for cross-Region redirection. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

## Syntax
<a name="aws-resource-workspaces-connectionalias-syntax"></a>

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

### JSON
<a name="aws-resource-workspaces-connectionalias-syntax.json"></a>

```
{
  "Type" : "AWS::WorkSpaces::ConnectionAlias",
  "Properties" : {
      "[ConnectionString](#cfn-workspaces-connectionalias-connectionstring)" : String,
      "[Tags](#cfn-workspaces-connectionalias-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-workspaces-connectionalias-syntax.yaml"></a>

```
Type: AWS::WorkSpaces::ConnectionAlias
Properties:
  [ConnectionString](#cfn-workspaces-connectionalias-connectionstring): 
    String
  [Tags](#cfn-workspaces-connectionalias-tags): 
    - Tag
```

## Properties
<a name="aws-resource-workspaces-connectionalias-properties"></a>

`ConnectionString`  <a name="cfn-workspaces-connectionalias-connectionstring"></a>
The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as `www.example.com`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[.0-9a-zA-Z\-]{1,255}$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-workspaces-connectionalias-tags"></a>
The tags to associate with the connection alias.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-workspaces-connectionalias-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-workspaces-connectionalias-return-values"></a>

### Ref
<a name="aws-resource-workspaces-connectionalias-return-values-ref"></a>

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

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-workspaces-connectionalias-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-workspaces-connectionalias-return-values-fn--getatt-fn--getatt"></a>

`AliasId`  <a name="AliasId-fn::getatt"></a>
The identifier of the connection alias, returned as a string.

`Associations`  <a name="Associations-fn::getatt"></a>
The association status of the connection alias.

`ConnectionAliasState`  <a name="ConnectionAliasState-fn::getatt"></a>
The current state of the connection alias, returned as a string.

## See also
<a name="aws-resource-workspaces-connectionalias--seealso"></a>
+ [ConnectionAlias](https://docs.aws.amazon.com/workspaces/latest/api/API_ConnectionAlias.html) in the *Amazon WorkSpaces API Reference*
+ [Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) in the *Amazon WorkSpaces Administration Guide*



# AWS::WorkSpaces::ConnectionAlias ConnectionAliasAssociation
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation"></a>

Describes a connection alias association that is used for cross-Region redirection. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

## Syntax
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-syntax"></a>

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

### JSON
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-syntax.json"></a>

```
{
  "[AssociatedAccountId](#cfn-workspaces-connectionalias-connectionaliasassociation-associatedaccountid)" : String,
  "[AssociationStatus](#cfn-workspaces-connectionalias-connectionaliasassociation-associationstatus)" : String,
  "[ConnectionIdentifier](#cfn-workspaces-connectionalias-connectionaliasassociation-connectionidentifier)" : String,
  "[ResourceId](#cfn-workspaces-connectionalias-connectionaliasassociation-resourceid)" : String
}
```

### YAML
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-syntax.yaml"></a>

```
  [AssociatedAccountId](#cfn-workspaces-connectionalias-connectionaliasassociation-associatedaccountid): String
  [AssociationStatus](#cfn-workspaces-connectionalias-connectionaliasassociation-associationstatus): String
  [ConnectionIdentifier](#cfn-workspaces-connectionalias-connectionaliasassociation-connectionidentifier): String
  [ResourceId](#cfn-workspaces-connectionalias-connectionaliasassociation-resourceid): String
```

## Properties
<a name="aws-properties-workspaces-connectionalias-connectionaliasassociation-properties"></a>

`AssociatedAccountId`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-associatedaccountid"></a>
The identifier of the AWS account that associated the connection alias with a directory.  
*Required*: No  
*Type*: String  
*Pattern*: `^\d{12}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AssociationStatus`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-associationstatus"></a>
The association status of the connection alias.  
*Required*: No  
*Type*: String  
*Allowed values*: `NOT_ASSOCIATED | PENDING_ASSOCIATION | ASSOCIATED_WITH_OWNER_ACCOUNT | ASSOCIATED_WITH_SHARED_ACCOUNT | PENDING_DISASSOCIATION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectionIdentifier`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-connectionidentifier"></a>
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]+$`  
*Minimum*: `1`  
*Maximum*: `20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceId`  <a name="cfn-workspaces-connectionalias-connectionaliasassociation-resourceid"></a>
The identifier of the directory associated with a connection alias.  
*Required*: No  
*Type*: String  
*Pattern*: `.+`  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::WorkSpaces::ConnectionAlias Tag
<a name="aws-properties-workspaces-connectionalias-tag"></a>

Describes a tag.

## Syntax
<a name="aws-properties-workspaces-connectionalias-tag-syntax"></a>

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

### JSON
<a name="aws-properties-workspaces-connectionalias-tag-syntax.json"></a>

```
{
  "[Key](#cfn-workspaces-connectionalias-tag-key)" : String,
  "[Value](#cfn-workspaces-connectionalias-tag-value)" : String
}
```

### YAML
<a name="aws-properties-workspaces-connectionalias-tag-syntax.yaml"></a>

```
  [Key](#cfn-workspaces-connectionalias-tag-key): String
  [Value](#cfn-workspaces-connectionalias-tag-value): String
```

## Properties
<a name="aws-properties-workspaces-connectionalias-tag-properties"></a>

`Key`  <a name="cfn-workspaces-connectionalias-tag-key"></a>
The key of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-workspaces-connectionalias-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)