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 = 'us-east-1' 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 }}';

All Properties

/*+ create */
INSERT INTO awscc.workspaces.connection_aliases (
  ConnectionString,
  Tags,
  region
)
SELECT
  '{{ connection_string }}',
  '{{ tags }}',
  '{{ region }}';

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 = 'us-east-1';

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