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	aws.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.

Methods

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

SELECT examples

Gets all properties from an individual connection_alias.

SELECT
region,
associations,
alias_id,
connection_string,
connection_alias_state,
tags
FROM aws.workspaces.connection_aliases
WHERE region = 'us-east-1' AND data__Identifier = '<AliasId>';

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 aws.workspaces.connection_aliases (
 ConnectionString,
 region
)
SELECT 
'{{ ConnectionString }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspaces.connection_aliases (
 ConnectionString,
 Tags,
 region
)
SELECT 
 '{{ ConnectionString }}',
 '{{ 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: ConnectionString
        value: '{{ ConnectionString }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspaces.connection_aliases
WHERE data__Identifier = '<AliasId>'
AND region = 'us-east-1';

Permissions

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

Create

workspaces:CreateConnectionAlias

Read

workspaces:DescribeConnectionAliases

Delete

workspaces:DeleteConnectionAlias