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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
connection_id	string	The ID of the connection.
domain_id	string	The ID of the domain in which the connection is created.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	connections	INSERT	DomainIdentifier, EnvironmentIdentifier, Name, region
delete_resource	connections	DELETE	Identifier, region
update_resource	connections	UPDATE	Identifier, PatchDocument, region
list_resources	connections_list_only	SELECT	region
get_resource	connections	SELECT	Identifier, region

SELECT examples

get (all properties)

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
  Identifier = '{{ domain_id }}|{{ connection_id }}';

list (identifiers only)

Lists all connections in a region.

SELECT
  region,
  domain_id,
  connection_id
FROM awscc.datazone.connections_list_only
WHERE
  region = 'us-east-1';

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
  '{{ domain_identifier }}',
  '{{ environment_identifier }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.datazone.connections (
  AwsLocation,
  Description,
  DomainIdentifier,
  EnvironmentIdentifier,
  Name,
  Props,
  region
)
SELECT
  '{{ aws_location }}',
  '{{ description }}',
  '{{ domain_identifier }}',
  '{{ environment_identifier }}',
  '{{ 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: aws_location
        value:
          access_role: '{{ access_role }}'
          aws_account_id: '{{ aws_account_id }}'
          aws_region: '{{ aws_region }}'
          iam_connection_id: '{{ iam_connection_id }}'
      - name: description
        value: '{{ description }}'
      - name: domain_identifier
        value: '{{ domain_identifier }}'
      - name: environment_identifier
        value: '{{ environment_identifier }}'
      - name: name
        value: '{{ name }}'
      - name: props
        value: null

UPDATE example

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

/*+ update */
UPDATE awscc.datazone.connections
SET PatchDocument = string('{{ {
    "AwsLocation": aws_location,
    "Description": description,
    "Props": props
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ connection_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.connections
WHERE
  Identifier = '{{ domain_id }}|{{ connection_id }}' 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