AWS::WorkSpaces::ConnectionAlias - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.


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


{ "Type" : "AWS::WorkSpaces::ConnectionAlias", "Properties" : { "ConnectionString" : String, "Tags" : [ Tag, ... ] } }


Type: AWS::WorkSpaces::ConnectionAlias Properties: ConnectionString: String Tags: - Tag



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

Required: Yes

Type: String

Pattern: ^[.0-9a-zA-Z\-]{1,255}$

Minimum: 1

Maximum: 255

Update requires: Replacement


The tags to associate with the connection alias.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values


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 Ref.


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.


The identifier of the connection alias, returned as a string.


The association status of the connection alias.


The current state of the connection alias, returned as a string.

See also