1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datazone
  5. Connection

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.datazone.Connection

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

    Connections enables users to connect their DataZone resources (domains, projects, and environments) to external resources/services (data, compute, etc)

    Create Connection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def Connection(resource_name: str,
                   args: ConnectionArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain_identifier: Optional[str] = None,
                   environment_identifier: Optional[str] = None,
                   aws_location: Optional[ConnectionAwsLocationArgs] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   props: Optional[Union[ConnectionPropertiesInput0PropertiesArgs, ConnectionPropertiesInput1PropertiesArgs, ConnectionPropertiesInput2PropertiesArgs, ConnectionPropertiesInput3PropertiesArgs, ConnectionPropertiesInput4PropertiesArgs, ConnectionPropertiesInput5PropertiesArgs, ConnectionPropertiesInput6PropertiesArgs]] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
    public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
    
    type: aws-native:datazone:Connection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Connection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Connection resource accepts the following input properties:

    DomainIdentifier string
    The identifier of the domain in which the connection is created.
    EnvironmentIdentifier string
    The identifier of the environment in which the connection is created.
    AwsLocation Pulumi.AwsNative.DataZone.Inputs.ConnectionAwsLocation
    The location where the connection is created.
    Description string
    The description of the connection.
    Name string
    The name of the connection.
    Props Pulumi.AwsNative.DataZone.Inputs.ConnectionPropertiesInput0Properties | Pulumi.AwsNative.DataZone.Inputs.ConnectionPropertiesInput1Properties | Pulumi.AwsNative.DataZone.Inputs.ConnectionPropertiesInput2Properties | Pulumi.AwsNative.DataZone.Inputs.ConnectionPropertiesInput3Properties | Pulumi.AwsNative.DataZone.Inputs.ConnectionPropertiesInput4Properties | Pulumi.AwsNative.DataZone.Inputs.ConnectionPropertiesInput5Properties | Pulumi.AwsNative.DataZone.Inputs.ConnectionPropertiesInput6Properties
    Connection props.
    DomainIdentifier string
    The identifier of the domain in which the connection is created.
    EnvironmentIdentifier string
    The identifier of the environment in which the connection is created.
    AwsLocation ConnectionAwsLocationArgs
    The location where the connection is created.
    Description string
    The description of the connection.
    Name string
    The name of the connection.
    Props ConnectionPropertiesInput0PropertiesArgs | ConnectionPropertiesInput1PropertiesArgs | ConnectionPropertiesInput2PropertiesArgs | ConnectionPropertiesInput3PropertiesArgs | ConnectionPropertiesInput4PropertiesArgs | ConnectionPropertiesInput5PropertiesArgs | ConnectionPropertiesInput6PropertiesArgs
    Connection props.
    domainIdentifier String
    The identifier of the domain in which the connection is created.
    environmentIdentifier String
    The identifier of the environment in which the connection is created.
    awsLocation ConnectionAwsLocation
    The location where the connection is created.
    description String
    The description of the connection.
    name String
    The name of the connection.
    props ConnectionPropertiesInput0Properties | ConnectionPropertiesInput1Properties | ConnectionPropertiesInput2Properties | ConnectionPropertiesInput3Properties | ConnectionPropertiesInput4Properties | ConnectionPropertiesInput5Properties | ConnectionPropertiesInput6Properties
    Connection props.
    domainIdentifier string
    The identifier of the domain in which the connection is created.
    environmentIdentifier string
    The identifier of the environment in which the connection is created.
    awsLocation ConnectionAwsLocation
    The location where the connection is created.
    description string
    The description of the connection.
    name string
    The name of the connection.
    props ConnectionPropertiesInput0Properties | ConnectionPropertiesInput1Properties | ConnectionPropertiesInput2Properties | ConnectionPropertiesInput3Properties | ConnectionPropertiesInput4Properties | ConnectionPropertiesInput5Properties | ConnectionPropertiesInput6Properties
    Connection props.
    domain_identifier str
    The identifier of the domain in which the connection is created.
    environment_identifier str
    The identifier of the environment in which the connection is created.
    aws_location ConnectionAwsLocationArgs
    The location where the connection is created.
    description str
    The description of the connection.
    name str
    The name of the connection.
    props ConnectionPropertiesInput0PropertiesArgs | ConnectionPropertiesInput1PropertiesArgs | ConnectionPropertiesInput2PropertiesArgs | ConnectionPropertiesInput3PropertiesArgs | ConnectionPropertiesInput4PropertiesArgs | ConnectionPropertiesInput5PropertiesArgs | ConnectionPropertiesInput6PropertiesArgs
    Connection props.
    domainIdentifier String
    The identifier of the domain in which the connection is created.
    environmentIdentifier String
    The identifier of the environment in which the connection is created.
    awsLocation Property Map
    The location where the connection is created.
    description String
    The description of the connection.
    name String
    The name of the connection.
    props Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map
    Connection props.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

    ConnectionId string
    The ID of the connection.
    DomainId string
    The ID of the domain in which the connection is created.
    DomainUnitId string
    The ID of the domain unit in which the connection is created.
    EnvironmentId string
    The ID of the environment in which the connection is created.
    EnvironmentUserRole string
    The role of the user in the environment.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The ID of the project in which the connection is created.
    Type string
    The type of the connection.
    ConnectionId string
    The ID of the connection.
    DomainId string
    The ID of the domain in which the connection is created.
    DomainUnitId string
    The ID of the domain unit in which the connection is created.
    EnvironmentId string
    The ID of the environment in which the connection is created.
    EnvironmentUserRole string
    The role of the user in the environment.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The ID of the project in which the connection is created.
    Type string
    The type of the connection.
    connectionId String
    The ID of the connection.
    domainId String
    The ID of the domain in which the connection is created.
    domainUnitId String
    The ID of the domain unit in which the connection is created.
    environmentId String
    The ID of the environment in which the connection is created.
    environmentUserRole String
    The role of the user in the environment.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The ID of the project in which the connection is created.
    type String
    The type of the connection.
    connectionId string
    The ID of the connection.
    domainId string
    The ID of the domain in which the connection is created.
    domainUnitId string
    The ID of the domain unit in which the connection is created.
    environmentId string
    The ID of the environment in which the connection is created.
    environmentUserRole string
    The role of the user in the environment.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    The ID of the project in which the connection is created.
    type string
    The type of the connection.
    connection_id str
    The ID of the connection.
    domain_id str
    The ID of the domain in which the connection is created.
    domain_unit_id str
    The ID of the domain unit in which the connection is created.
    environment_id str
    The ID of the environment in which the connection is created.
    environment_user_role str
    The role of the user in the environment.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    The ID of the project in which the connection is created.
    type str
    The type of the connection.
    connectionId String
    The ID of the connection.
    domainId String
    The ID of the domain in which the connection is created.
    domainUnitId String
    The ID of the domain unit in which the connection is created.
    environmentId String
    The ID of the environment in which the connection is created.
    environmentUserRole String
    The role of the user in the environment.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The ID of the project in which the connection is created.
    type String
    The type of the connection.

    Supporting Types

    ConnectionAthenaPropertiesInput, ConnectionAthenaPropertiesInputArgs

    ConnectionAuthenticationConfigurationInput, ConnectionAuthenticationConfigurationInputArgs

    ConnectionAuthenticationType, ConnectionAuthenticationTypeArgs

    Basic
    BASIC
    Oauth2
    OAUTH2
    Custom
    CUSTOM
    ConnectionAuthenticationTypeBasic
    BASIC
    ConnectionAuthenticationTypeOauth2
    OAUTH2
    ConnectionAuthenticationTypeCustom
    CUSTOM
    Basic
    BASIC
    Oauth2
    OAUTH2
    Custom
    CUSTOM
    Basic
    BASIC
    Oauth2
    OAUTH2
    Custom
    CUSTOM
    BASIC
    BASIC
    OAUTH2
    OAUTH2
    CUSTOM
    CUSTOM
    "BASIC"
    BASIC
    "OAUTH2"
    OAUTH2
    "CUSTOM"
    CUSTOM

    ConnectionAuthorizationCodeProperties, ConnectionAuthorizationCodePropertiesArgs

    ConnectionAwsLocation, ConnectionAwsLocationArgs

    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.
    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.
    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.
    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.
    access_role str
    The access role of a connection.
    aws_account_id str
    The account ID of a connection.
    aws_region str
    The Region of a connection.
    iam_connection_id str
    The IAM connection ID 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.

    ConnectionBasicAuthenticationCredentials, ConnectionBasicAuthenticationCredentialsArgs

    Password string
    UserName string
    Password string
    UserName string
    password String
    userName String
    password string
    userName string
    password String
    userName String

    ConnectionGlueConnectionInput, ConnectionGlueConnectionInputArgs

    ConnectionGlueOAuth2Credentials, ConnectionGlueOAuth2CredentialsArgs

    ConnectionGluePropertiesInput, ConnectionGluePropertiesInputArgs

    ConnectionHyperPodPropertiesInput, ConnectionHyperPodPropertiesInputArgs

    ConnectionIamPropertiesInput, ConnectionIamPropertiesInputArgs

    ConnectionLineageSyncSchedule, ConnectionLineageSyncScheduleArgs

    Schedule string
    Schedule string
    schedule String
    schedule string
    schedule String

    ConnectionOAuth2ClientApplication, ConnectionOAuth2ClientApplicationArgs

    ConnectionOAuth2GrantType, ConnectionOAuth2GrantTypeArgs

    AuthorizationCode
    AUTHORIZATION_CODE
    ClientCredentials
    CLIENT_CREDENTIALS
    JwtBearer
    JWT_BEARER
    ConnectionOAuth2GrantTypeAuthorizationCode
    AUTHORIZATION_CODE
    ConnectionOAuth2GrantTypeClientCredentials
    CLIENT_CREDENTIALS
    ConnectionOAuth2GrantTypeJwtBearer
    JWT_BEARER
    AuthorizationCode
    AUTHORIZATION_CODE
    ClientCredentials
    CLIENT_CREDENTIALS
    JwtBearer
    JWT_BEARER
    AuthorizationCode
    AUTHORIZATION_CODE
    ClientCredentials
    CLIENT_CREDENTIALS
    JwtBearer
    JWT_BEARER
    AUTHORIZATION_CODE
    AUTHORIZATION_CODE
    CLIENT_CREDENTIALS
    CLIENT_CREDENTIALS
    JWT_BEARER
    JWT_BEARER
    "AUTHORIZATION_CODE"
    AUTHORIZATION_CODE
    "CLIENT_CREDENTIALS"
    CLIENT_CREDENTIALS
    "JWT_BEARER"
    JWT_BEARER

    ConnectionOAuth2Properties, ConnectionOAuth2PropertiesArgs

    ConnectionPhysicalConnectionRequirements, ConnectionPhysicalConnectionRequirementsArgs

    AvailabilityZone string
    SecurityGroupIdList List<string>
    SubnetId string
    SubnetIdList List<string>
    availabilityZone String
    securityGroupIdList List<String>
    subnetId String
    subnetIdList List<String>
    availabilityZone String
    securityGroupIdList List<String>
    subnetId String
    subnetIdList List<String>

    ConnectionPropertiesInput0Properties, ConnectionPropertiesInput0PropertiesArgs

    ConnectionPropertiesInput1Properties, ConnectionPropertiesInput1PropertiesArgs

    ConnectionPropertiesInput2Properties, ConnectionPropertiesInput2PropertiesArgs

    ConnectionPropertiesInput3Properties, ConnectionPropertiesInput3PropertiesArgs

    ConnectionPropertiesInput4Properties, ConnectionPropertiesInput4PropertiesArgs

    ConnectionPropertiesInput5Properties, ConnectionPropertiesInput5PropertiesArgs

    ConnectionPropertiesInput6Properties, ConnectionPropertiesInput6PropertiesArgs

    ConnectionRedshiftCredentials0Properties, ConnectionRedshiftCredentials0PropertiesArgs

    SecretArn string
    SecretArn string
    secretArn String
    secretArn string
    secretArn String

    ConnectionRedshiftCredentials1Properties, ConnectionRedshiftCredentials1PropertiesArgs

    ConnectionRedshiftLineageSyncConfigurationInput, ConnectionRedshiftLineageSyncConfigurationInputArgs

    ConnectionRedshiftPropertiesInput, ConnectionRedshiftPropertiesInputArgs

    ConnectionRedshiftStorageProperties0Properties, ConnectionRedshiftStorageProperties0PropertiesArgs

    ConnectionRedshiftStorageProperties1Properties, ConnectionRedshiftStorageProperties1PropertiesArgs

    ConnectionSparkEmrPropertiesInput, ConnectionSparkEmrPropertiesInputArgs

    ConnectionSparkGlueArgs, ConnectionSparkGlueArgsArgs

    Connection string
    Connection string
    connection String
    connection string
    connection String

    ConnectionSparkGluePropertiesInput, ConnectionSparkGluePropertiesInputArgs

    ConnectionUsernamePassword, ConnectionUsernamePasswordArgs

    Password string
    Username string
    Password string
    Username string
    password String
    username String
    password string
    username string
    password String
    username String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi