AWS::WorkSpaces::ConnectionAlias - Amazon CloudFormation
SyntaxPropertiesReturn valuesSee also
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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

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 Amazon 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

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

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

The tags to associate with the connection alias.

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

AliasId

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

Associations

The association status of the connection alias.

ConnectionAliasState

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

See also