ConnectionAlias - Amazon WorkSpaces Service
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).

ConnectionAlias

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Contents

AliasId

The identifier of the connection alias.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 68.

Pattern: ^wsca-[0-9a-z]{8,63}$

Required: No

Associations

The association status of the connection alias.

Type: Array of ConnectionAliasAssociation objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Required: No

OwnerAccountId

The identifier of the Amazon Web Services account that owns the connection alias.

Type: String

Pattern: ^\d{12}$

Required: No

State

The current state of the connection alias.

Type: String

Valid Values: CREATING | CREATED | DELETING

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: