AWS::WorkSpaces::ConnectionAlias
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::WorkSpaces::ConnectionAlias", "Properties" : { "ConnectionString" :
String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::WorkSpaces::ConnectionAlias Properties: ConnectionString:
String
Tags:- Tag
Properties
ConnectionString
-
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
Minimum:
1
Maximum:
255
Pattern:
^[.0-9a-zA-Z\-]{1,255}$
Update requires: Replacement
Tags
-
The tags to associate with the connection alias.
Required: No
Type: List 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 resource name.
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.
See also
-
ConnectionAlias in the Amazon WorkSpaces API Reference
-
Cross-Region Redirection for Amazon WorkSpaces in the Amazon WorkSpaces Administration Guide