connection_alias

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

Overview

Name	connection_alias
Type	Resource
Id	aws.workspaces.connection_alias

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_connection_alias	insert	region, ConnectionString		Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
associate_connection_alias	update	region, AliasId, ResourceId		Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
disassociate_connection_alias	update	region, AliasId		Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
delete_connection_alias	delete	region		Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

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)

INSERT examples

create_connection_alias

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

INSERT INTO aws.workspaces.connection_alias (
ConnectionString,
Tags,
region
)
SELECT 
'{{ ConnectionString }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
alias_id
;

Manifest

# Description fields are for documentation purposes
- name: connection_alias
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connection_alias resource.
  - name: ConnectionString
    value: "{{ ConnectionString }}"
    description: |
      A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com. After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
  - name: Tags
    description: |
      The tags to associate with the connection alias.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

associate_connection_alias

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

UPDATE aws.workspaces.connection_alias
SET 
AliasId = '{{ AliasId }}',
ResourceId = '{{ ResourceId }}'
WHERE 
region = '{{ region }}' --required
AND AliasId = '{{ AliasId }}' --required
AND ResourceId = '{{ ResourceId }}' --required
RETURNING
connection_identifier;

disassociate_connection_alias

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces. Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

UPDATE aws.workspaces.connection_alias
SET 
AliasId = '{{ AliasId }}'
WHERE 
region = '{{ region }}' --required
AND AliasId = '{{ AliasId }}' --required;

DELETE examples

delete_connection_alias

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces. If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection. To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

DELETE FROM aws.workspaces.connection_alias
WHERE region = '{{ region }}' --required
;