connections

Creates, updates, deletes or gets a connection resource or lists connections in a region

Overview

Name	connections
Type	Resource
Description	Connections enables users to connect their DataZone resources (domains, projects, and environments) to external resources/services (data, compute, etc)
Id	awscc.datazone.connections

Fields

Name	Datatype	Description
▶aws_location	object	AWS Location of project
connection_id	string	The ID of the connection.
description	string	The description of the connection.
domain_id	string	The ID of the domain in which the connection is created.
domain_identifier	string	The identifier of the domain in which the connection is created.
domain_unit_id	string	The ID of the domain unit in which the connection is created.
environment_id	string	The ID of the environment in which the connection is created.
environment_identifier	string	The identifier of the environment in which the connection is created.
environment_user_role	string	The role of the user in the environment.
name	string	The name of the connection.
project_id	string	The ID of the project in which the connection is created.
props	object
type	string	Connection Type
region	string	AWS region.

For more information, see AWS::DataZone::Connection.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainIdentifier, EnvironmentIdentifier, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual connection.

SELECT
region,
aws_location,
connection_id,
description,
domain_id,
domain_identifier,
domain_unit_id,
environment_id,
environment_identifier,
environment_user_role,
name,
project_id,
props,
type
FROM awscc.datazone.connections
WHERE region = 'us-east-1' AND data__Identifier = '<DomainId>|<ConnectionId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.datazone.connections (
 DomainIdentifier,
 EnvironmentIdentifier,
 Name,
 region
)
SELECT 
'{{ DomainIdentifier }}',
 '{{ EnvironmentIdentifier }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.datazone.connections (
 AwsLocation,
 Description,
 DomainIdentifier,
 EnvironmentIdentifier,
 Name,
 Props,
 region
)
SELECT 
 '{{ AwsLocation }}',
 '{{ Description }}',
 '{{ DomainIdentifier }}',
 '{{ EnvironmentIdentifier }}',
 '{{ Name }}',
 '{{ Props }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connection
    props:
      - name: AwsLocation
        value:
          AccessRole: '{{ AccessRole }}'
          AwsAccountId: '{{ AwsAccountId }}'
          AwsRegion: '{{ AwsRegion }}'
          IamConnectionId: '{{ IamConnectionId }}'
      - name: Description
        value: '{{ Description }}'
      - name: DomainIdentifier
        value: '{{ DomainIdentifier }}'
      - name: EnvironmentIdentifier
        value: '{{ EnvironmentIdentifier }}'
      - name: Name
        value: '{{ Name }}'
      - name: Props
        value: null

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.connections
WHERE data__Identifier = '<DomainId|ConnectionId>'
AND region = 'us-east-1';

Permissions

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

Create

datazone:CreateConnection,
datazone:GetConnection,
datazone:DeleteConnection

Read

datazone:GetConnection

Update

datazone:UpdateConnection,
datazone:GetConnection,
datazone:DeleteConnection

Delete

datazone:DeleteConnection,
datazone:GetConnection

List

datazone:ListConnections