connection_alias_permissions

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

Overview

Name	connection_alias_permissions
Type	Resource
Id	aws.workspaces.connection_alias_permissions

Fields

The following fields are returned by SELECT queries:

describe_connection_alias_permissions

Name	Datatype	Description
alias_id	string	The identifier of the connection alias. (pattern: <code>^wsca-[0-9a-z]{8,63}$</code>)
connection_alias_permissions	array	The permissions associated with a connection alias.
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_alias_permissions	select	region		Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
update_connection_alias_permission	update	region, AliasId, ConnectionAliasPermission		Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. 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. 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)

SELECT examples

describe_connection_alias_permissions

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

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

UPDATE examples

update_connection_alias_permission

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. 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. 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.

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