connection_aliases

Creates, updates, deletes or gets a connection_alias resource or lists connection_aliases in a region

Overview

Name	connection_aliases
Type	Resource
Description	Resource Type definition for AWS::WorkSpaces::ConnectionAlias
Id	awscc.workspaces.connection_aliases

Fields

Name	Datatype	Description
▶associations	array
alias_id	string
connection_string	string
connection_alias_state	string
▶tags	array
region	string	AWS region.

For more information, see AWS::WorkSpaces::ConnectionAlias.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ConnectionString, region
delete_resource	DELETE	Identifier, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual connection_alias.

SELECT
  region,
  associations,
  alias_id,
  connection_string,
  connection_alias_state,
  tags
FROM awscc.workspaces.connection_aliases
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ alias_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new connection_alias resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.workspaces.connection_aliases (
  ConnectionString,
  region
)
SELECT
  '{{ connection_string }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.workspaces.connection_aliases (
  ConnectionString,
  Tags,
  region
)
SELECT
  '{{ connection_string }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: connection_alias
  props:
    - name: connection_string
      value: '{{ connection_string }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.workspaces.connection_aliases
WHERE
  Identifier = '{{ alias_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the connection_aliases resource, the following permissions are required:

Create

workspaces:CreateConnectionAlias,
workspaces:CreateTags,
workspaces:DescribeConnectionAliases,
workspaces:DescribeTags

Read

workspaces:DescribeConnectionAliases,
workspaces:DescribeTags

Delete

workspaces:DeleteConnectionAlias,
workspaces:DeleteTags,
workspaces:DescribeTags,
workspaces:DescribeConnectionAliases