connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	aws.datazone.connections

Fields

The following fields are returned by SELECT queries:

get_connection

Name	Datatype	Description
name	string	The name of the connection.
configurations	array	The configurations of the connection.
connection_credentials	object	Connection credentials.
connection_id	string	The ID of the connection.
description	string	Connection description.
domain_id	string	The domain ID of the connection. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
domain_unit_id	string	The domain unit ID of the connection. (pattern: <code>[a-z0-9_-]+</code>)
environment_id	string	The ID of the environment. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
environment_user_role	string	The environment user role.
physical_endpoints	array	The physical endpoints of the connection.
project_id	string	The ID of the project. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
props	object	Connection props.
scope	string	The scope of the connection. (DOMAIN, PROJECT)
type_	string	The type of the connection. (ATHENA, BIGQUERY, DATABRICKS, DOCUMENTDB, DYNAMODB, HYPERPOD, IAM, MYSQL, OPENSEARCH, ORACLE, POSTGRESQL, REDSHIFT, S3, SAPHANA, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, VERTICA, WORKFLOWS_MWAA, AMAZON_Q, MLFLOW, VPC, GIT)

list_connections

Name	Datatype	Description
name	string	The connection name.
configurations	array	The configurations of a connection summary.
connection_id	string	The ID of a connection.
domain_id	string	The domain ID of a connection. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
domain_unit_id	string	The domain unit ID of a connection. (pattern: <code>[a-z0-9_-]+</code>)
environment_id	string	The environment ID of a connection. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
physical_endpoints	array	The connection physical endpoints.
project_id	string	The connection project ID. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
props	object	The connection props.
scope	string	The scope of the connection. (DOMAIN, PROJECT)
type_	string	The connection type. (ATHENA, BIGQUERY, DATABRICKS, DOCUMENTDB, DYNAMODB, HYPERPOD, IAM, MYSQL, OPENSEARCH, ORACLE, POSTGRESQL, REDSHIFT, S3, SAPHANA, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, VERTICA, WORKFLOWS_MWAA, AMAZON_Q, MLFLOW, VPC, GIT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connection	select	domain_identifier, identifier, region	withSecret	Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
list_connections	select	domain_identifier, region	maxResults, nextToken, sortBy, sortOrder, name, environmentIdentifier, projectIdentifier, type, scope	Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
create_connection	insert	domain_identifier, region, name		Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
update_connection	update	domain_identifier, identifier, region		Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
delete_connection	delete	domain_identifier, identifier, region		Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The ID of the domain where the connection is deleted.
identifier	string	The ID of the connection that is deleted.
region	string	AWS region (default: us-east-1)
environmentIdentifier	string	The ID of the environment where you want to list connections.
maxResults	integer	The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.
name	string	The name of the connection.
nextToken	string	When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.
projectIdentifier	string	The ID of the project where you want to list connections.
scope	string	The scope of the connection.
sortBy	string	Specifies how you want to sort the listed connections.
sortOrder	string	Specifies the sort order for the listed connections.
type	string	The type of connection.
withSecret	boolean	Specifies whether a connection has a secret.

SELECT examples

get_connection

Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

SELECT
name,
configurations,
connection_credentials,
connection_id,
description,
domain_id,
domain_unit_id,
environment_id,
environment_user_role,
physical_endpoints,
project_id,
props,
scope,
type_
FROM aws.datazone.connections
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND withSecret = '{{ withSecret }}'
;

list_connections

Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

SELECT
name,
configurations,
connection_id,
domain_id,
domain_unit_id,
environment_id,
physical_endpoints,
project_id,
props,
scope,
type_
FROM aws.datazone.connections
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND name = '{{ name }}'
AND environmentIdentifier = '{{ environmentIdentifier }}'
AND projectIdentifier = '{{ projectIdentifier }}'
AND type = '{{ type }}'
AND scope = '{{ scope }}'
;

INSERT examples

create_connection

Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

INSERT INTO aws.datazone.connections (
awsLocation,
clientToken,
configurations,
description,
environmentIdentifier,
name,
props,
enableTrustedIdentityPropagation,
scope,
domain_identifier,
region
)
SELECT 
'{{ awsLocation }}',
'{{ clientToken }}',
'{{ configurations }}',
'{{ description }}',
'{{ environmentIdentifier }}',
'{{ name }}' /* required */,
'{{ props }}',
{{ enableTrustedIdentityPropagation }},
'{{ scope }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
name,
configurations,
connection_id,
description,
domain_id,
domain_unit_id,
environment_id,
physical_endpoints,
project_id,
props,
scope,
type_
;

Manifest

# Description fields are for documentation purposes
- name: connections
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the connections resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connections resource.
  - name: awsLocation
    description: |
      The location of a project.
    value:
      accessRole: "{{ accessRole }}"
      awsAccountId: "{{ awsAccountId }}"
      awsRegion: "{{ awsRegion }}"
      iamConnectionId: "{{ iamConnectionId }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: configurations
    value:
      - classification: "{{ classification }}"
        properties_: "{{ properties_ }}"
  - name: description
    value: "{{ description }}"
  - name: environmentIdentifier
    value: "{{ environmentIdentifier }}"
  - name: name
    value: "{{ name }}"
  - name: props
    description: |
      The properties of a connection.
    value:
      athenaProperties:
        workgroupName: "{{ workgroupName }}"
      glueProperties:
        glueConnectionInput:
          connectionProperties: "{{ connectionProperties }}"
          physicalConnectionRequirements:
            subnetId: "{{ subnetId }}"
            subnetIdList:
              - "{{ subnetIdList }}"
            securityGroupIdList:
              - "{{ securityGroupIdList }}"
            availabilityZone: "{{ availabilityZone }}"
          name: "{{ name }}"
          description: "{{ description }}"
          connectionType: "{{ connectionType }}"
          matchCriteria: "{{ matchCriteria }}"
          validateCredentials: {{ validateCredentials }}
          validateForComputeEnvironments:
            - "{{ validateForComputeEnvironments }}"
          sparkProperties: "{{ sparkProperties }}"
          athenaProperties: "{{ athenaProperties }}"
          pythonProperties: "{{ pythonProperties }}"
          authenticationConfiguration:
            authenticationType: "{{ authenticationType }}"
            oAuth2Properties:
              oAuth2GrantType: "{{ oAuth2GrantType }}"
              oAuth2ClientApplication: "{{ oAuth2ClientApplication }}"
              tokenUrl: "{{ tokenUrl }}"
              tokenUrlParametersMap: "{{ tokenUrlParametersMap }}"
              authorizationCodeProperties: "{{ authorizationCodeProperties }}"
              oAuth2Credentials: "{{ oAuth2Credentials }}"
            secretArn: "{{ secretArn }}"
            kmsKeyArn: "{{ kmsKeyArn }}"
            basicAuthenticationCredentials:
              userName: "{{ userName }}"
              password: "{{ password }}"
            customAuthenticationCredentials: "{{ customAuthenticationCredentials }}"
      hyperPodProperties:
        clusterName: "{{ clusterName }}"
      iamProperties:
        glueLineageSyncEnabled: {{ glueLineageSyncEnabled }}
      redshiftProperties:
        storage:
          clusterName: "{{ clusterName }}"
          workgroupName: "{{ workgroupName }}"
        databaseName: "{{ databaseName }}"
        host: "{{ host }}"
        port: {{ port }}
        credentials:
          secretArn: "{{ secretArn }}"
          usernamePassword:
            password: "{{ password }}"
            username: "{{ username }}"
        lineageSync:
          enabled: {{ enabled }}
          schedule:
            schedule: "{{ schedule }}"
      sparkEmrProperties:
        computeArn: "{{ computeArn }}"
        instanceProfileArn: "{{ instanceProfileArn }}"
        javaVirtualEnv: "{{ javaVirtualEnv }}"
        logUri: "{{ logUri }}"
        pythonVirtualEnv: "{{ pythonVirtualEnv }}"
        runtimeRole: "{{ runtimeRole }}"
        trustedCertificatesS3Uri: "{{ trustedCertificatesS3Uri }}"
        managedEndpointArn: "{{ managedEndpointArn }}"
      sparkGlueProperties:
        additionalArgs:
          connection: "{{ connection }}"
        glueConnectionName: "{{ glueConnectionName }}"
        glueConnectionNames:
          - "{{ glueConnectionNames }}"
        glueVersion: "{{ glueVersion }}"
        idleTimeout: {{ idleTimeout }}
        javaVirtualEnv: "{{ javaVirtualEnv }}"
        numberOfWorkers: {{ numberOfWorkers }}
        pythonVirtualEnv: "{{ pythonVirtualEnv }}"
        workerType: "{{ workerType }}"
      s3Properties:
        s3Uri: "{{ s3Uri }}"
        s3AccessGrantLocationId: "{{ s3AccessGrantLocationId }}"
        registerS3AccessGrantLocation: {{ registerS3AccessGrantLocation }}
      snowflakeProperties:
        connectivityProperties:
          connectionProperties: "{{ connectionProperties }}"
          physicalConnectionRequirements:
            subnetId: "{{ subnetId }}"
            subnetIdList:
              - "{{ subnetIdList }}"
            securityGroupIdList:
              - "{{ securityGroupIdList }}"
            availabilityZone: "{{ availabilityZone }}"
          name: "{{ name }}"
          description: "{{ description }}"
          validateCredentials: {{ validateCredentials }}
          validateForComputeEnvironments:
            - "{{ validateForComputeEnvironments }}"
          sparkProperties: "{{ sparkProperties }}"
          athenaProperties: "{{ athenaProperties }}"
          pythonProperties: "{{ pythonProperties }}"
          authenticationConfiguration:
            authenticationType: "{{ authenticationType }}"
            oAuth2Properties:
              oAuth2GrantType: "{{ oAuth2GrantType }}"
              oAuth2ClientApplication: "{{ oAuth2ClientApplication }}"
              tokenUrl: "{{ tokenUrl }}"
              tokenUrlParametersMap: "{{ tokenUrlParametersMap }}"
              authorizationCodeProperties: "{{ authorizationCodeProperties }}"
              oAuth2Credentials: "{{ oAuth2Credentials }}"
            secretArn: "{{ secretArn }}"
            kmsKeyArn: "{{ kmsKeyArn }}"
            basicAuthenticationCredentials:
              userName: "{{ userName }}"
              password: "{{ password }}"
            customAuthenticationCredentials: "{{ customAuthenticationCredentials }}"
        snowflakeRole: "{{ snowflakeRole }}"
        identityMapping:
          usernameAttribute: "{{ usernameAttribute }}"
          prefix: "{{ prefix }}"
        lineageSync:
          timezone: "{{ timezone }}"
          enabled: {{ enabled }}
          schedule: "{{ schedule }}"
      amazonQProperties:
        isEnabled: {{ isEnabled }}
        profileArn: "{{ profileArn }}"
        authMode: "{{ authMode }}"
      mlflowProperties:
        trackingServerArn: "{{ trackingServerArn }}"
      workflowsMwaaProperties:
        mwaaEnvironmentName: "{{ mwaaEnvironmentName }}"
      workflowsServerlessProperties: "{{ workflowsServerlessProperties }}"
      lakehouseProperties:
        glueLineageSyncEnabled: {{ glueLineageSyncEnabled }}
      vpcProperties:
        vpcId: "{{ vpcId }}"
        subnetIds:
          - "{{ subnetIds }}"
        securityGroupId: "{{ securityGroupId }}"
      gitProperties:
        codeConnectionArn: "{{ codeConnectionArn }}"
        repositoryId: "{{ repositoryId }}"
        defaultBranch: "{{ defaultBranch }}"
  - name: enableTrustedIdentityPropagation
    value: {{ enableTrustedIdentityPropagation }}
  - name: scope
    value: "{{ scope }}"
    valid_values: ['DOMAIN', 'PROJECT']

UPDATE examples

update_connection

Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

UPDATE aws.datazone.connections
SET 
configurations = '{{ configurations }}',
description = '{{ description }}',
awsLocation = '{{ awsLocation }}',
props = '{{ props }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
configurations,
connection_id,
description,
domain_id,
domain_unit_id,
environment_id,
physical_endpoints,
project_id,
props,
scope,
type_;

DELETE examples

delete_connection

Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

DELETE FROM aws.datazone.connections
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;