DataZone / Client / create_connection

create_connection#

DataZone.Client.create_connection(**kwargs)#

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

Request Syntax

response = client.create_connection(
    awsLocation={
        'accessRole': 'string',
        'awsAccountId': 'string',
        'awsRegion': 'string',
        'iamConnectionId': 'string'
    },
    clientToken='string',
    description='string',
    domainIdentifier='string',
    environmentIdentifier='string',
    name='string',
    props={
        'athenaProperties': {
            'workgroupName': 'string'
        },
        'glueProperties': {
            'glueConnectionInput': {
                'athenaProperties': {
                    'string': 'string'
                },
                'authenticationConfiguration': {
                    'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM',
                    'basicAuthenticationCredentials': {
                        'password': 'string',
                        'userName': 'string'
                    },
                    'customAuthenticationCredentials': {
                        'string': 'string'
                    },
                    'kmsKeyArn': 'string',
                    'oAuth2Properties': {
                        'authorizationCodeProperties': {
                            'authorizationCode': 'string',
                            'redirectUri': 'string'
                        },
                        'oAuth2ClientApplication': {
                            'aWSManagedClientApplicationReference': 'string',
                            'userManagedClientApplicationClientId': 'string'
                        },
                        'oAuth2Credentials': {
                            'accessToken': 'string',
                            'jwtToken': 'string',
                            'refreshToken': 'string',
                            'userManagedClientApplicationClientSecret': 'string'
                        },
                        'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER',
                        'tokenUrl': 'string',
                        'tokenUrlParametersMap': {
                            'string': 'string'
                        }
                    },
                    'secretArn': 'string'
                },
                'connectionProperties': {
                    'string': 'string'
                },
                'connectionType': 'SNOWFLAKE'|'BIGQUERY'|'DOCUMENTDB'|'DYNAMODB'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'SAPHANA'|'SQLSERVER'|'TERADATA'|'VERTICA',
                'description': 'string',
                'matchCriteria': 'string',
                'name': 'string',
                'physicalConnectionRequirements': {
                    'availabilityZone': 'string',
                    'securityGroupIdList': [
                        'string',
                    ],
                    'subnetId': 'string',
                    'subnetIdList': [
                        'string',
                    ]
                },
                'pythonProperties': {
                    'string': 'string'
                },
                'sparkProperties': {
                    'string': 'string'
                },
                'validateCredentials': True|False,
                'validateForComputeEnvironments': [
                    'SPARK'|'ATHENA'|'PYTHON',
                ]
            }
        },
        'hyperPodProperties': {
            'clusterName': 'string'
        },
        'iamProperties': {
            'glueLineageSyncEnabled': True|False
        },
        'redshiftProperties': {
            'credentials': {
                'secretArn': 'string',
                'usernamePassword': {
                    'password': 'string',
                    'username': 'string'
                }
            },
            'databaseName': 'string',
            'host': 'string',
            'lineageSync': {
                'enabled': True|False,
                'schedule': {
                    'schedule': 'string'
                }
            },
            'port': 123,
            'storage': {
                'clusterName': 'string',
                'workgroupName': 'string'
            }
        },
        'sparkEmrProperties': {
            'computeArn': 'string',
            'instanceProfileArn': 'string',
            'javaVirtualEnv': 'string',
            'logUri': 'string',
            'pythonVirtualEnv': 'string',
            'runtimeRole': 'string',
            'trustedCertificatesS3Uri': 'string'
        },
        'sparkGlueProperties': {
            'additionalArgs': {
                'connection': 'string'
            },
            'glueConnectionName': 'string',
            'glueVersion': 'string',
            'idleTimeout': 123,
            'javaVirtualEnv': 'string',
            'numberOfWorkers': 123,
            'pythonVirtualEnv': 'string',
            'workerType': 'string'
        }
    }
)

Parameters:

awsLocation (dict) –
The location where the connection is created.
- accessRole (string) –
  
  The access role of a connection.
- awsAccountId (string) –
  
  The account ID of a connection.
- awsRegion (string) –
  
  The Region of a connection.
- iamConnectionId (string) –
  
  The IAM connection ID of a connection.
clientToken (string) –
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

This field is autopopulated if not provided.
description (string) – A connection description.
domainIdentifier (string) –
[REQUIRED]

The ID of the domain where the connection is created.
environmentIdentifier (string) –
[REQUIRED]

The ID of the environment where the connection is created.
name (string) –
[REQUIRED]

The connection name.
props (dict) –
The connection props.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: athenaProperties, glueProperties, hyperPodProperties, iamProperties, redshiftProperties, sparkEmrProperties, sparkGlueProperties.
- athenaProperties (dict) –
  
  The Amazon Athena properties of a connection.
  - workgroupName (string) –
    
    The Amazon Athena workgroup name of a connection.
- glueProperties (dict) –
  
  The Amazon Web Services Glue properties of a connection.
  - glueConnectionInput (dict) –
    
    The Amazon Web Services Glue connection.
    - athenaProperties (dict) –
      
      The Amazon Athena properties of the Amazon Web Services Glue connection.
      - (string) –
        
        (string) –
    - authenticationConfiguration (dict) –
      
      The authentication configuration of the Amazon Web Services Glue connection.
      - authenticationType (string) –
        
        The authentication type of a connection.
      - basicAuthenticationCredentials (dict) –
        
        The basic authentication credentials of a connection.
        
        password (string) –
        
        The password for a connection.
        
        userName (string) –
        
        The user name for the connecion.
      - customAuthenticationCredentials (dict) –
        
        The custom authentication credentials of a connection.
        
        (string) –
        
        (string) –
      - kmsKeyArn (string) –
        
        The KMS key ARN of a connection.
      - oAuth2Properties (dict) –
        
        The oAuth2 properties of a connection.
        
        authorizationCodeProperties (dict) –
        
        The authorization code properties of the OAuth2 properties.
        
        authorizationCode (string) –
        
        The authorization code of a connection.
        
        redirectUri (string) –
        
        The redirect URI of a connection.
        
        oAuth2ClientApplication (dict) –
        
        The OAuth2 client application of the OAuth2 properties.
        
        aWSManagedClientApplicationReference (string) –
        
        The Amazon Web Services managed client application reference in the OAuth2Client application.
        
        userManagedClientApplicationClientId (string) –
        
        The user managed client application client ID in the OAuth2Client application.
        
        oAuth2Credentials (dict) –
        
        The OAuth2 credentials of the OAuth2 properties.
        
        accessToken (string) –
        
        The access token of a connection.
        
        jwtToken (string) –
        
        The jwt token of the connection.
        
        refreshToken (string) –
        
        The refresh token of the connection.
        
        userManagedClientApplicationClientSecret (string) –
        
        The user managed client application client secret of the connection.
        
        oAuth2GrantType (string) –
        
        The OAuth2 grant type of the OAuth2 properties.
        
        tokenUrl (string) –
        
        The OAuth2 token URL of the OAuth2 properties.
        
        tokenUrlParametersMap (dict) –
        
        The OAuth2 token URL parameter map of the OAuth2 properties.
        
        (string) –
        
        (string) –
      - secretArn (string) –
        
        The secret ARN of a connection.
    - connectionProperties (dict) –
      
      The connection properties of the Amazon Web Services Glue connection.
      - (string) –
        
        (string) –
    - connectionType (string) –
      
      The connection type of the Amazon Web Services Glue connection.
    - description (string) –
      
      The description of the Amazon Web Services Glue connection.
    - matchCriteria (string) –
      
      The match criteria of the Amazon Web Services Glue connection.
    - name (string) –
      
      The name of the Amazon Web Services Glue connection.
    - physicalConnectionRequirements (dict) –
      
      The physical connection requirements for the Amazon Web Services Glue connection.
      - availabilityZone (string) –
        
        The availability zone of the physical connection requirements of a connection.
      - securityGroupIdList (list) –
        
        The group ID list of the physical connection requirements of a connection.
        
        (string) –
      - subnetId (string) –
        
        The subnet ID of the physical connection requirements of a connection.
      - subnetIdList (list) –
        
        The subnet ID list of the physical connection requirements of a connection.
        
        (string) –
    - pythonProperties (dict) –
      
      The Python properties of the Amazon Web Services Glue connection.
      - (string) –
        
        (string) –
    - sparkProperties (dict) –
      
      The Spark properties of the Amazon Web Services Glue connection.
      - (string) –
        
        (string) –
    - validateCredentials (boolean) –
      
      Speciefies whether to validate credentials of the Amazon Web Services Glue connection.
    - validateForComputeEnvironments (list) –
      
      Speciefies whether to validate for compute environments of the Amazon Web Services Glue connection.
      - (string) –
- hyperPodProperties (dict) –
  
  The hyper pod properties of a connection.
  - clusterName (string) – [REQUIRED]
    
    The cluster name the hyper pod properties.
- iamProperties (dict) –
  
  The IAM properties of a connection.
  - glueLineageSyncEnabled (boolean) –
    
    Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.
- redshiftProperties (dict) –
  
  The Amazon Redshift properties of a connection.
  - credentials (dict) –
    
    The Amaon Redshift credentials.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: secretArn, usernamePassword.
    - secretArn (string) –
      
      The secret ARN of the Amazon Redshift credentials of a connection.
    - usernamePassword (dict) –
      
      The username and password of the Amazon Redshift credentials of a connection.
      - password (string) – [REQUIRED]
        
        The password of a connection.
      - username (string) – [REQUIRED]
        
        The username of a connection.
  - databaseName (string) –
    
    The Amazon Redshift database name.
  - host (string) –
    
    The Amazon Redshift host.
  - lineageSync (dict) –
    
    The lineage sync of the Amazon Redshift.
    - enabled (boolean) –
      
      Specifies whether the Amaon Redshift lineage sync configuration is enabled.
    - schedule (dict) –
      
      The schedule of the Amaon Redshift lineage sync configuration.
      - schedule (string) –
        
        The lineage sync schedule.
  - port (integer) –
    
    The Amaon Redshift port.
  - storage (dict) –
    
    The Amazon Redshift storage.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: clusterName, workgroupName.
    - clusterName (string) –
      
      The cluster name in the Amazon Redshift storage properties.
    - workgroupName (string) –
      
      The workgroup name in the Amazon Redshift storage properties.
- sparkEmrProperties (dict) –
  
  The Spark EMR properties of a connection.
  - computeArn (string) –
    
    The compute ARN of Spark EMR.
  - instanceProfileArn (string) –
    
    The instance profile ARN of Spark EMR.
  - javaVirtualEnv (string) –
    
    The java virtual env of the Spark EMR.
  - logUri (string) –
    
    The log URI of the Spark EMR.
  - pythonVirtualEnv (string) –
    
    The Python virtual env of the Spark EMR.
  - runtimeRole (string) –
    
    The runtime role of the Spark EMR.
  - trustedCertificatesS3Uri (string) –
    
    The certificates S3 URI of the Spark EMR.
- sparkGlueProperties (dict) –
  
  The Spark Amazon Web Services Glue properties of a connection.
  - additionalArgs (dict) –
    
    The additional args in the Spark Amazon Web Services Glue properties.
    - connection (string) –
      
      The connection in the Spark Amazon Web Services Glue args.
  - glueConnectionName (string) –
    
    The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties.
  - glueVersion (string) –
    
    The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.
  - idleTimeout (integer) –
    
    The idle timeout in the Spark Amazon Web Services Glue properties.
  - javaVirtualEnv (string) –
    
    The Java virtual env in the Spark Amazon Web Services Glue properties.
  - numberOfWorkers (integer) –
    
    The number of workers in the Spark Amazon Web Services Glue properties.
  - pythonVirtualEnv (string) –
    
    The Python virtual env in the Spark Amazon Web Services Glue properties.
  - workerType (string) –
    
    The worker type in the Spark Amazon Web Services Glue properties.

Return type:

dict

Returns:

Response Syntax

{
    'connectionId': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'environmentId': 'string',
    'name': 'string',
    'physicalEndpoints': [
        {
            'awsLocation': {
                'accessRole': 'string',
                'awsAccountId': 'string',
                'awsRegion': 'string',
                'iamConnectionId': 'string'
            },
            'glueConnection': {
                'athenaProperties': {
                    'string': 'string'
                },
                'authenticationConfiguration': {
                    'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM',
                    'oAuth2Properties': {
                        'authorizationCodeProperties': {
                            'authorizationCode': 'string',
                            'redirectUri': 'string'
                        },
                        'oAuth2ClientApplication': {
                            'aWSManagedClientApplicationReference': 'string',
                            'userManagedClientApplicationClientId': 'string'
                        },
                        'oAuth2Credentials': {
                            'accessToken': 'string',
                            'jwtToken': 'string',
                            'refreshToken': 'string',
                            'userManagedClientApplicationClientSecret': 'string'
                        },
                        'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER',
                        'tokenUrl': 'string',
                        'tokenUrlParametersMap': {
                            'string': 'string'
                        }
                    },
                    'secretArn': 'string'
                },
                'compatibleComputeEnvironments': [
                    'SPARK'|'ATHENA'|'PYTHON',
                ],
                'connectionProperties': {
                    'string': 'string'
                },
                'connectionSchemaVersion': 123,
                'connectionType': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA',
                'creationTime': datetime(2015, 1, 1),
                'description': 'string',
                'lastConnectionValidationTime': datetime(2015, 1, 1),
                'lastUpdatedBy': 'string',
                'lastUpdatedTime': datetime(2015, 1, 1),
                'matchCriteria': [
                    'string',
                ],
                'name': 'string',
                'physicalConnectionRequirements': {
                    'availabilityZone': 'string',
                    'securityGroupIdList': [
                        'string',
                    ],
                    'subnetId': 'string',
                    'subnetIdList': [
                        'string',
                    ]
                },
                'pythonProperties': {
                    'string': 'string'
                },
                'sparkProperties': {
                    'string': 'string'
                },
                'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
                'statusReason': 'string'
            },
            'glueConnectionName': 'string',
            'host': 'string',
            'port': 123,
            'protocol': 'ATHENA'|'GLUE_INTERACTIVE_SESSION'|'HTTPS'|'JDBC'|'LIVY'|'ODBC'|'PRISM',
            'stage': 'string'
        },
    ],
    'projectId': 'string',
    'props': {
        'athenaProperties': {
            'workgroupName': 'string'
        },
        'glueProperties': {
            'errorMessage': 'string',
            'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED'
        },
        'hyperPodProperties': {
            'clusterArn': 'string',
            'clusterName': 'string',
            'orchestrator': 'EKS'|'SLURM'
        },
        'iamProperties': {
            'environmentId': 'string',
            'glueLineageSyncEnabled': True|False
        },
        'redshiftProperties': {
            'credentials': {
                'secretArn': 'string',
                'usernamePassword': {
                    'password': 'string',
                    'username': 'string'
                }
            },
            'databaseName': 'string',
            'isProvisionedSecret': True|False,
            'jdbcIamUrl': 'string',
            'jdbcUrl': 'string',
            'lineageSync': {
                'enabled': True|False,
                'lineageJobId': 'string',
                'schedule': {
                    'schedule': 'string'
                }
            },
            'redshiftTempDir': 'string',
            'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
            'storage': {
                'clusterName': 'string',
                'workgroupName': 'string'
            }
        },
        'sparkEmrProperties': {
            'computeArn': 'string',
            'credentials': {
                'password': 'string',
                'username': 'string'
            },
            'credentialsExpiration': datetime(2015, 1, 1),
            'governanceType': 'AWS_MANAGED'|'USER_MANAGED',
            'instanceProfileArn': 'string',
            'javaVirtualEnv': 'string',
            'livyEndpoint': 'string',
            'logUri': 'string',
            'pythonVirtualEnv': 'string',
            'runtimeRole': 'string',
            'trustedCertificatesS3Uri': 'string'
        },
        'sparkGlueProperties': {
            'additionalArgs': {
                'connection': 'string'
            },
            'glueConnectionName': 'string',
            'glueVersion': 'string',
            'idleTimeout': 123,
            'javaVirtualEnv': 'string',
            'numberOfWorkers': 123,
            'pythonVirtualEnv': 'string',
            'workerType': 'string'
        }
    },
    'type': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA'
}

Response Structure

(dict) –
- connectionId (string) –
  
  The ID of the connection.
- description (string) –
  
  The connection description.
- domainId (string) –
  
  The ID of the domain where the connection is created.
- domainUnitId (string) –
  
  The ID of the domain unit where the connection is created.
- environmentId (string) –
  
  The ID of the environment where the connection is created.
- name (string) –
  
  The connection name.
- physicalEndpoints (list) –
  
  The physical endpoints of the connection.
  - (dict) –
    
    The physical endpoints of a connection.
    - awsLocation (dict) –
      
      The location of a connection.
      - accessRole (string) –
        
        The access role of a connection.
      - awsAccountId (string) –
        
        The account ID of a connection.
      - awsRegion (string) –
        
        The Region of a connection.
      - iamConnectionId (string) –
        
        The IAM connection ID of a connection.
    - glueConnection (dict) –
      
      The Amazon Web Services Glue connection.
      - athenaProperties (dict) –
        
        The Amazon Athena properties of the Amazon Web Services Glue connection.
        
        (string) –
        
        (string) –
      - authenticationConfiguration (dict) –
        
        The authentication configuration of the Amazon Web Services Glue connection.
        
        authenticationType (string) –
        
        The authentication type of a connection.
        
        oAuth2Properties (dict) –
        
        The oAuth2 properties of a connection.
        
        authorizationCodeProperties (dict) –
        
        The authorization code properties of the OAuth2 properties.
        
        authorizationCode (string) –
        
        The authorization code of a connection.
        
        redirectUri (string) –
        
        The redirect URI of a connection.
        
        oAuth2ClientApplication (dict) –
        
        The OAuth2 client application of the OAuth2 properties.
        
        aWSManagedClientApplicationReference (string) –
        
        The Amazon Web Services managed client application reference in the OAuth2Client application.
        
        userManagedClientApplicationClientId (string) –
        
        The user managed client application client ID in the OAuth2Client application.
        
        oAuth2Credentials (dict) –
        
        The OAuth2 credentials of the OAuth2 properties.
        
        accessToken (string) –
        
        The access token of a connection.
        
        jwtToken (string) –
        
        The jwt token of the connection.
        
        refreshToken (string) –
        
        The refresh token of the connection.
        
        userManagedClientApplicationClientSecret (string) –
        
        The user managed client application client secret of the connection.
        
        oAuth2GrantType (string) –
        
        The OAuth2 grant type of the OAuth2 properties.
        
        tokenUrl (string) –
        
        The OAuth2 token URL of the OAuth2 properties.
        
        tokenUrlParametersMap (dict) –
        
        The OAuth2 token URL parameter map of the OAuth2 properties.
        
        (string) –
        
        (string) –
        
        secretArn (string) –
        
        The secret ARN of a connection.
      - compatibleComputeEnvironments (list) –
        
        The compatible compute environments of the Amazon Web Services Glue connection.
        
        (string) –
      - connectionProperties (dict) –
        
        The properties of the Amazon Web Services Glue connection.
        
        (string) –
        
        (string) –
      - connectionSchemaVersion (integer) –
        
        The connection schema version of the Amazon Web Services Glue connection.
      - connectionType (string) –
        
        The type of the Amazon Web Services Glue connection.
      - creationTime (datetime) –
        
        The creation time of the Amazon Web Services Glue connection.
      - description (string) –
        
        The description of the Amazon Web Services Glue connection.
      - lastConnectionValidationTime (datetime) –
        
        The last validation time of the Amazon Web Services Glue connection.
      - lastUpdatedBy (string) –
        
        The user who last updated the Amazon Web Services Glue connection.
      - lastUpdatedTime (datetime) –
        
        The timestamp at which the Amazon Web Services Glue connection was last updated.
      - matchCriteria (list) –
        
        The match criteria of the Amazon Web Services Glue connection.
        
        (string) –
      - name (string) –
        
        The name of the Amazon Web Services Glue connection.
      - physicalConnectionRequirements (dict) –
        
        The physical connection requirements of the Amazon Web Services Glue connection.
        
        availabilityZone (string) –
        
        The availability zone of the physical connection requirements of a connection.
        
        securityGroupIdList (list) –
        
        The group ID list of the physical connection requirements of a connection.
        
        (string) –
        
        subnetId (string) –
        
        The subnet ID of the physical connection requirements of a connection.
        
        subnetIdList (list) –
        
        The subnet ID list of the physical connection requirements of a connection.
        
        (string) –
      - pythonProperties (dict) –
        
        The Python properties of the Amazon Web Services Glue connection.
        
        (string) –
        
        (string) –
      - sparkProperties (dict) –
        
        The Spark properties of the Amazon Web Services Glue connection.
        
        (string) –
        
        (string) –
      - status (string) –
        
        The status of the Amazon Web Services Glue connection.
      - statusReason (string) –
        
        The status reason of the Amazon Web Services Glue connection.
    - glueConnectionName (string) –
      
      The Amazon Web Services Glue connection name.
    - host (string) –
      
      The host in the physical endpoints of a connection.
    - port (integer) –
      
      The port in the physical endpoints of a connection.
    - protocol (string) –
      
      The protocol in the physical endpoints of a connection.
    - stage (string) –
      
      The stage in the physical endpoints of a connection.
- projectId (string) –
  
  The ID of the project where the connection is created.
- props (dict) –
  
  The connection props.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: athenaProperties, glueProperties, hyperPodProperties, iamProperties, redshiftProperties, sparkEmrProperties, sparkGlueProperties. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - athenaProperties (dict) –
    
    The Amazon Athena properties of a connection.
    - workgroupName (string) –
      
      The Amazon Athena workgroup name of a connection.
  - glueProperties (dict) –
    
    The Amazon Web Services Glue properties of a connection.
    - errorMessage (string) –
      
      The error message generated if the action is not completed successfully.
    - status (string) –
      
      The status of a connection.
  - hyperPodProperties (dict) –
    
    The hyper pod properties of a connection.
    - clusterArn (string) –
      
      The cluster ARN of the hyper pod properties.
    - clusterName (string) –
      
      The cluster name the hyper pod properties.
    - orchestrator (string) –
      
      The orchestrator of the hyper pod properties.
  - iamProperties (dict) –
    
    The IAM properties of a connection.
    - environmentId (string) –
      
      The environment ID of the connection.
    - glueLineageSyncEnabled (boolean) –
      
      Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.
  - redshiftProperties (dict) –
    
    The Amazon Redshift properties of a connection.
    - credentials (dict) –
      
      The Amazon Redshift credentials.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: secretArn, usernamePassword. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - secretArn (string) –
        
        The secret ARN of the Amazon Redshift credentials of a connection.
      - usernamePassword (dict) –
        
        The username and password of the Amazon Redshift credentials of a connection.
        
        password (string) –
        
        The password of a connection.
        
        username (string) –
        
        The username of a connection.
    - databaseName (string) –
      
      The Amazon Redshift database name.
    - isProvisionedSecret (boolean) –
      
      Specifies whether Amaon Redshift properties has a provisioned secret.
    - jdbcIamUrl (string) –
      
      The jdbcIam URL of the Amazon Redshift properties.
    - jdbcUrl (string) –
      
      The jdbcURL of the Amazon Redshift properties.
    - lineageSync (dict) –
      
      The lineage syn of the Amazon Redshift properties.
      - enabled (boolean) –
        
        Specifies whether the Amaon Redshift lineage sync configuration is enabled.
      - lineageJobId (string) –
        
        The lineage job ID of the Amaon Redshift lineage sync configuration.
      - schedule (dict) –
        
        The schedule of teh Amaon Redshift lineage sync configuration.
        
        schedule (string) –
        
        The lineage sync schedule.
    - redshiftTempDir (string) –
      
      The redshiftTempDir of the Amazon Redshift properties.
    - status (string) –
      
      The status in the Amazon Redshift properties.
    - storage (dict) –
      
      The storage in the Amazon Redshift properties.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: clusterName, workgroupName. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - clusterName (string) –
        
        The cluster name in the Amazon Redshift storage properties.
      - workgroupName (string) –
        
        The workgroup name in the Amazon Redshift storage properties.
  - sparkEmrProperties (dict) –
    
    The Spark EMR properties of a connection.
    - computeArn (string) –
      
      The compute ARN of the Spark EMR.
    - credentials (dict) –
      
      The credentials of the Spark EMR.
      - password (string) –
        
        The password of a connection.
      - username (string) –
        
        The username of a connection.
    - credentialsExpiration (datetime) –
      
      The credential expiration of the Spark EMR.
    - governanceType (string) –
      
      The governance type of the Spark EMR.
    - instanceProfileArn (string) –
      
      The instance profile ARN of the Spark EMR.
    - javaVirtualEnv (string) –
      
      The Java virtual env of the Spark EMR.
    - livyEndpoint (string) –
      
      The livy endpoint of the Spark EMR.
    - logUri (string) –
      
      The log URI of the Spark EMR.
    - pythonVirtualEnv (string) –
      
      The Python virtual env of the Spark EMR.
    - runtimeRole (string) –
      
      The runtime role of the Spark EMR.
    - trustedCertificatesS3Uri (string) –
      
      The trusted certificate S3 URL of the Spark EMR.
  - sparkGlueProperties (dict) –
    
    The Spark Amazon Web Services Glue properties of a connection.
    - additionalArgs (dict) –
      
      The additional args in the Spark Amazon Web Services Glue properties.
      - connection (string) –
        
        The connection in the Spark Amazon Web Services Glue args.
    - glueConnectionName (string) –
      
      The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties.
    - glueVersion (string) –
      
      The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.
    - idleTimeout (integer) –
      
      The idle timeout in the Spark Amazon Web Services Glue properties.
    - javaVirtualEnv (string) –
      
      The Java virtual env in the Spark Amazon Web Services Glue properties.
    - numberOfWorkers (integer) –
      
      The number of workers in the Spark Amazon Web Services Glue properties.
    - pythonVirtualEnv (string) –
      
      The Python virtual env in the Spark Amazon Web Services Glue properties.
    - workerType (string) –
      
      The worker type in the Spark Amazon Web Services Glue properties.
- type (string) –
  
  The connection type.

create_connection#

Request Syntax

Note

Note

Note

Response Syntax

Response Structure

Note

Note

Note

Exceptions