connection_aliases
Creates, updates, deletes, gets or lists a connection_aliases resource.
Overview
| Name | connection_aliases |
| Type | Resource |
| Id | aws.workspaces.connection_aliases |
Fields
The following fields are returned by SELECT queries:
- describe_connection_aliases
| Name | Datatype | Description |
|---|---|---|
connection_aliases | array | Information about the specified connection aliases. |
next_token | string | The 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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_connection_aliases | select | region | Retrieves 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_connection_aliases
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
;