Skip to main content

connection_aliases

Creates, updates, deletes, gets or lists a connection_aliases resource.

Overview​

Nameconnection_aliases
TypeResource
Idaws.workspaces.connection_aliases

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
connection_aliasesarrayInformation about the specified connection aliases.
next_tokenstringThe token to use to retrieve the next page of results. This value is null when there are no more results to return.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_connection_aliasesselectregionRetrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

SELECT
connection_aliases,
next_token
FROM aws.workspaces.connection_aliases
WHERE region = '{{ region }}' -- required
;