We recommend new projects start with resources from the AWS provider.
aws-native.datazone.Connection
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Domain
Identifier string - The identifier of the domain in which the connection is created.
- Environment
Identifier string - The identifier of the environment in which the connection is created.
- Aws
Location Pulumi.Aws Native. Data Zone. Inputs. Connection Aws Location - The location where the connection is created.
- Description string
- The description of the connection.
- Name string
- The name of the connection.
- Props
Pulumi.
Aws | Pulumi.Native. Data Zone. Inputs. Connection Properties Input0Properties Aws | Pulumi.Native. Data Zone. Inputs. Connection Properties Input1Properties Aws | Pulumi.Native. Data Zone. Inputs. Connection Properties Input2Properties Aws | Pulumi.Native. Data Zone. Inputs. Connection Properties Input3Properties Aws | Pulumi.Native. Data Zone. Inputs. Connection Properties Input4Properties Aws | Pulumi.Native. Data Zone. Inputs. Connection Properties Input5Properties Aws Native. Data Zone. Inputs. Connection Properties Input6Properties - Connection props.
- Domain
Identifier string - The identifier of the domain in which the connection is created.
- Environment
Identifier string - The identifier of the environment in which the connection is created.
- Aws
Location ConnectionAws Location Args - The location where the connection is created.
- Description string
- The description of the connection.
- Name string
- The name of the connection.
- Props
Connection
Properties | ConnectionInput0Properties Args Properties | ConnectionInput1Properties Args Properties | ConnectionInput2Properties Args Properties | ConnectionInput3Properties Args Properties | ConnectionInput4Properties Args Properties | ConnectionInput5Properties Args Properties Input6Properties Args - Connection props.
- domain
Identifier String - The identifier of the domain in which the connection is created.
- environment
Identifier String - The identifier of the environment in which the connection is created.
- aws
Location ConnectionAws Location - The location where the connection is created.
- description String
- The description of the connection.
- name String
- The name of the connection.
- props
Connection
Properties | ConnectionInput0Properties Properties | ConnectionInput1Properties Properties | ConnectionInput2Properties Properties | ConnectionInput3Properties Properties | ConnectionInput4Properties Properties | ConnectionInput5Properties Properties Input6Properties - Connection props.
- domain
Identifier string - The identifier of the domain in which the connection is created.
- environment
Identifier string - The identifier of the environment in which the connection is created.
- aws
Location ConnectionAws Location - The location where the connection is created.
- description string
- The description of the connection.
- name string
- The name of the connection.
- props
Connection
Properties | ConnectionInput0Properties Properties | ConnectionInput1Properties Properties | ConnectionInput2Properties Properties | ConnectionInput3Properties Properties | ConnectionInput4Properties Properties | ConnectionInput5Properties Properties Input6Properties - 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 ConnectionAws Location Args - The location where the connection is created.
- description str
- The description of the connection.
- name str
- The name of the connection.
- props
Connection
Properties | ConnectionInput0Properties Args Properties | ConnectionInput1Properties Args Properties | ConnectionInput2Properties Args Properties | ConnectionInput3Properties Args Properties | ConnectionInput4Properties Args Properties | ConnectionInput5Properties Args Properties Input6Properties Args - Connection props.
- domain
Identifier String - The identifier of the domain in which the connection is created.
- environment
Identifier String - The identifier of the environment in which the connection is created.
- aws
Location 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:
- Connection
Id string - The ID of the connection.
- Domain
Id string - The ID of the domain in which the connection is created.
- Domain
Unit stringId - 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
User stringRole - The role of the user in the environment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - The ID of the project in which the connection is created.
- Type string
- The type of the connection.
- Connection
Id string - The ID of the connection.
- Domain
Id string - The ID of the domain in which the connection is created.
- Domain
Unit stringId - 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
User stringRole - The role of the user in the environment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - The ID of the project in which the connection is created.
- Type string
- The type of the connection.
- connection
Id String - The ID of the connection.
- domain
Id String - The ID of the domain in which the connection is created.
- domain
Unit StringId - 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
User StringRole - The role of the user in the environment.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - The ID of the project in which the connection is created.
- type String
- The type of the connection.
- connection
Id string - The ID of the connection.
- domain
Id string - The ID of the domain in which the connection is created.
- domain
Unit stringId - 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
User stringRole - The role of the user in the environment.
- id string
- The provider-assigned unique ID for this managed resource.
- project
Id 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_ strid - 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_ strrole - 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.
- connection
Id String - The ID of the connection.
- domain
Id String - The ID of the domain in which the connection is created.
- domain
Unit StringId - 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
User StringRole - The role of the user in the environment.
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - The ID of the project in which the connection is created.
- type String
- The type of the connection.
Supporting Types
ConnectionAthenaPropertiesInput, ConnectionAthenaPropertiesInputArgs
- Workgroup
Name string
- Workgroup
Name string
- workgroup
Name String
- workgroup
Name string
- workgroup_
name str
- workgroup
Name String
ConnectionAuthenticationConfigurationInput, ConnectionAuthenticationConfigurationInputArgs
- Authentication
Type Pulumi.Aws Native. Data Zone. Connection Authentication Type - Basic
Authentication Pulumi.Credentials Aws Native. Data Zone. Inputs. Connection Basic Authentication Credentials - Custom
Authentication Dictionary<string, string>Credentials - Kms
Key stringArn - OAuth2Properties
Pulumi.
Aws Native. Data Zone. Inputs. Connection OAuth2Properties - Secret
Arn string
ConnectionAuthenticationType, ConnectionAuthenticationTypeArgs
- Basic
- BASIC
- Oauth2
- OAUTH2
- Custom
- CUSTOM
- Connection
Authentication Type Basic - BASIC
- Connection
Authentication Type Oauth2 - OAUTH2
- Connection
Authentication Type Custom - 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
- string
- Redirect
Uri string
- string
- Redirect
Uri string
- String
- redirect
Uri String
- string
- redirect
Uri string
- str
- redirect_
uri str
- String
- redirect
Uri String
ConnectionAwsLocation, ConnectionAwsLocationArgs
- Access
Role string - The access role of a connection.
- Aws
Account stringId - The account ID of a connection.
- Aws
Region string - The Region of a connection.
- Iam
Connection stringId - The IAM connection ID of a connection.
- Access
Role string - The access role of a connection.
- Aws
Account stringId - The account ID of a connection.
- Aws
Region string - The Region of a connection.
- Iam
Connection stringId - The IAM connection ID of a connection.
- access
Role String - The access role of a connection.
- aws
Account StringId - The account ID of a connection.
- aws
Region String - The Region of a connection.
- iam
Connection StringId - The IAM connection ID of a connection.
- access
Role string - The access role of a connection.
- aws
Account stringId - The account ID of a connection.
- aws
Region string - The Region of a connection.
- iam
Connection stringId - The IAM connection ID of a connection.
- access_
role str - The access role of a connection.
- aws_
account_ strid - The account ID of a connection.
- aws_
region str - The Region of a connection.
- iam_
connection_ strid - The IAM connection ID of a connection.
- access
Role String - The access role of a connection.
- aws
Account StringId - The account ID of a connection.
- aws
Region String - The Region of a connection.
- iam
Connection StringId - The IAM connection ID of a connection.
ConnectionBasicAuthenticationCredentials, ConnectionBasicAuthenticationCredentialsArgs
ConnectionGlueConnectionInput, ConnectionGlueConnectionInputArgs
- Athena
Properties Dictionary<string, string> - Authentication
Configuration Pulumi.Aws Native. Data Zone. Inputs. Connection Authentication Configuration Input - Connection
Properties Dictionary<string, string> - Connection
Type string - Description string
- Match
Criteria string - Name string
- Physical
Connection Pulumi.Requirements Aws Native. Data Zone. Inputs. Connection Physical Connection Requirements - Python
Properties Dictionary<string, string> - Spark
Properties Dictionary<string, string> - Validate
Credentials bool - Validate
For List<string>Compute Environments
- Athena
Properties map[string]string - Authentication
Configuration ConnectionAuthentication Configuration Input - Connection
Properties map[string]string - Connection
Type string - Description string
- Match
Criteria string - Name string
- Physical
Connection ConnectionRequirements Physical Connection Requirements - Python
Properties map[string]string - Spark
Properties map[string]string - Validate
Credentials bool - Validate
For []stringCompute Environments
- athena
Properties Map<String,String> - authentication
Configuration ConnectionAuthentication Configuration Input - connection
Properties Map<String,String> - connection
Type String - description String
- match
Criteria String - name String
- physical
Connection ConnectionRequirements Physical Connection Requirements - python
Properties Map<String,String> - spark
Properties Map<String,String> - validate
Credentials Boolean - validate
For List<String>Compute Environments
- athena
Properties {[key: string]: string} - authentication
Configuration ConnectionAuthentication Configuration Input - connection
Properties {[key: string]: string} - connection
Type string - description string
- match
Criteria string - name string
- physical
Connection ConnectionRequirements Physical Connection Requirements - python
Properties {[key: string]: string} - spark
Properties {[key: string]: string} - validate
Credentials boolean - validate
For string[]Compute Environments
- athena_
properties Mapping[str, str] - authentication_
configuration ConnectionAuthentication Configuration Input - connection_
properties Mapping[str, str] - connection_
type str - description str
- match_
criteria str - name str
- physical_
connection_ Connectionrequirements Physical Connection Requirements - python_
properties Mapping[str, str] - spark_
properties Mapping[str, str] - validate_
credentials bool - validate_
for_ Sequence[str]compute_ environments
- athena
Properties Map<String> - authentication
Configuration Property Map - connection
Properties Map<String> - connection
Type String - description String
- match
Criteria String - name String
- physical
Connection Property MapRequirements - python
Properties Map<String> - spark
Properties Map<String> - validate
Credentials Boolean - validate
For List<String>Compute Environments
ConnectionGlueOAuth2Credentials, ConnectionGlueOAuth2CredentialsArgs
- Access
Token string - Jwt
Token string - Refresh
Token string - User
Managed stringClient Application Client Secret
- Access
Token string - Jwt
Token string - Refresh
Token string - User
Managed stringClient Application Client Secret
- access
Token String - jwt
Token String - refresh
Token String - user
Managed StringClient Application Client Secret
- access
Token string - jwt
Token string - refresh
Token string - user
Managed stringClient Application Client Secret
- access
Token String - jwt
Token String - refresh
Token String - user
Managed StringClient Application Client Secret
ConnectionGluePropertiesInput, ConnectionGluePropertiesInputArgs
ConnectionHyperPodPropertiesInput, ConnectionHyperPodPropertiesInputArgs
- Cluster
Name string
- Cluster
Name string
- cluster
Name String
- cluster
Name string
- cluster_
name str
- cluster
Name String
ConnectionIamPropertiesInput, ConnectionIamPropertiesInputArgs
- glue
Lineage BooleanSync Enabled
- glue
Lineage booleanSync Enabled
- glue
Lineage BooleanSync Enabled
ConnectionLineageSyncSchedule, ConnectionLineageSyncScheduleArgs
- Schedule string
- Schedule string
- schedule String
- schedule string
- schedule str
- schedule String
ConnectionOAuth2ClientApplication, ConnectionOAuth2ClientApplicationArgs
ConnectionOAuth2GrantType, ConnectionOAuth2GrantTypeArgs
- Authorization
Code - AUTHORIZATION_CODE
- Client
Credentials - CLIENT_CREDENTIALS
- Jwt
Bearer - JWT_BEARER
- Connection
OAuth2Grant Type Authorization Code - AUTHORIZATION_CODE
- Connection
OAuth2Grant Type Client Credentials - CLIENT_CREDENTIALS
- Connection
OAuth2Grant Type Jwt Bearer - 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
- 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
- Pulumi.
Aws Native. Data Zone. Inputs. Connection Authorization Code Properties - OAuth2Client
Application Pulumi.Aws Native. Data Zone. Inputs. Connection OAuth2Client Application - OAuth2Credentials
Pulumi.
Aws Native. Data Zone. Inputs. Connection Glue OAuth2Credentials - OAuth2Grant
Type Pulumi.Aws Native. Data Zone. Connection OAuth2Grant Type - Token
Url string - Token
Url Dictionary<string, string>Parameters Map
ConnectionPhysicalConnectionRequirements, ConnectionPhysicalConnectionRequirementsArgs
- Availability
Zone string - Security
Group List<string>Id List - Subnet
Id string - Subnet
Id List<string>List
- Availability
Zone string - Security
Group []stringId List - Subnet
Id string - Subnet
Id []stringList
- availability
Zone String - security
Group List<String>Id List - subnet
Id String - subnet
Id List<String>List
- availability
Zone string - security
Group string[]Id List - subnet
Id string - subnet
Id string[]List
- availability_
zone str - security_
group_ Sequence[str]id_ list - subnet_
id str - subnet_
id_ Sequence[str]list
- availability
Zone String - security
Group List<String>Id List - subnet
Id String - subnet
Id List<String>List
ConnectionPropertiesInput0Properties, ConnectionPropertiesInput0PropertiesArgs
ConnectionPropertiesInput1Properties, ConnectionPropertiesInput1PropertiesArgs
ConnectionPropertiesInput2Properties, ConnectionPropertiesInput2PropertiesArgs
ConnectionPropertiesInput3Properties, ConnectionPropertiesInput3PropertiesArgs
ConnectionPropertiesInput4Properties, ConnectionPropertiesInput4PropertiesArgs
ConnectionPropertiesInput5Properties, ConnectionPropertiesInput5PropertiesArgs
ConnectionPropertiesInput6Properties, ConnectionPropertiesInput6PropertiesArgs
ConnectionRedshiftCredentials0Properties, ConnectionRedshiftCredentials0PropertiesArgs
- Secret
Arn string
- Secret
Arn string
- secret
Arn String
- secret
Arn string
- secret_
arn str
- secret
Arn String
ConnectionRedshiftCredentials1Properties, ConnectionRedshiftCredentials1PropertiesArgs
ConnectionRedshiftLineageSyncConfigurationInput, ConnectionRedshiftLineageSyncConfigurationInputArgs
- enabled Boolean
- schedule Property Map
ConnectionRedshiftPropertiesInput, ConnectionRedshiftPropertiesInputArgs
- Credentials
Pulumi.
Aws | Pulumi.Native. Data Zone. Inputs. Connection Redshift Credentials0Properties Aws Native. Data Zone. Inputs. Connection Redshift Credentials1Properties - Database
Name string - Host string
- Lineage
Sync Pulumi.Aws Native. Data Zone. Inputs. Connection Redshift Lineage Sync Configuration Input - Port double
- Storage
Pulumi.
Aws | Pulumi.Native. Data Zone. Inputs. Connection Redshift Storage Properties0Properties Aws Native. Data Zone. Inputs. Connection Redshift Storage Properties1Properties
- credentials Property Map | Property Map
- database
Name String - host String
- lineage
Sync Property Map - port Number
- storage Property Map | Property Map
ConnectionRedshiftStorageProperties0Properties, ConnectionRedshiftStorageProperties0PropertiesArgs
- Cluster
Name string
- Cluster
Name string
- cluster
Name String
- cluster
Name string
- cluster_
name str
- cluster
Name String
ConnectionRedshiftStorageProperties1Properties, ConnectionRedshiftStorageProperties1PropertiesArgs
- Workgroup
Name string
- Workgroup
Name string
- workgroup
Name String
- workgroup
Name string
- workgroup_
name str
- workgroup
Name String
ConnectionSparkEmrPropertiesInput, ConnectionSparkEmrPropertiesInputArgs
- Compute
Arn string - Instance
Profile stringArn - Java
Virtual stringEnv - Log
Uri string - Python
Virtual stringEnv - Runtime
Role string - Trusted
Certificates stringS3Uri
- Compute
Arn string - Instance
Profile stringArn - Java
Virtual stringEnv - Log
Uri string - Python
Virtual stringEnv - Runtime
Role string - Trusted
Certificates stringS3Uri
- compute
Arn String - instance
Profile StringArn - java
Virtual StringEnv - log
Uri String - python
Virtual StringEnv - runtime
Role String - trusted
Certificates StringS3Uri
- compute
Arn string - instance
Profile stringArn - java
Virtual stringEnv - log
Uri string - python
Virtual stringEnv - runtime
Role string - trusted
Certificates stringS3Uri
- compute_
arn str - instance_
profile_ strarn - java_
virtual_ strenv - log_
uri str - python_
virtual_ strenv - runtime_
role str - trusted_
certificates_ strs3_ uri
- compute
Arn String - instance
Profile StringArn - java
Virtual StringEnv - log
Uri String - python
Virtual StringEnv - runtime
Role String - trusted
Certificates StringS3Uri
ConnectionSparkGlueArgs, ConnectionSparkGlueArgsArgs
- Connection string
- Connection string
- connection String
- connection string
- connection str
- connection String
ConnectionSparkGluePropertiesInput, ConnectionSparkGluePropertiesInputArgs
- Additional
Args Pulumi.Aws Native. Data Zone. Inputs. Connection Spark Glue Args - Glue
Connection stringName - Glue
Version string - Idle
Timeout double - Java
Virtual stringEnv - Number
Of doubleWorkers - Python
Virtual stringEnv - Worker
Type string
- Additional
Args ConnectionSpark Glue Args - Glue
Connection stringName - Glue
Version string - Idle
Timeout float64 - Java
Virtual stringEnv - Number
Of float64Workers - Python
Virtual stringEnv - Worker
Type string
- additional
Args ConnectionSpark Glue Args - glue
Connection StringName - glue
Version String - idle
Timeout Double - java
Virtual StringEnv - number
Of DoubleWorkers - python
Virtual StringEnv - worker
Type String
- additional
Args ConnectionSpark Glue Args - glue
Connection stringName - glue
Version string - idle
Timeout number - java
Virtual stringEnv - number
Of numberWorkers - python
Virtual stringEnv - worker
Type string
- additional
Args Property Map - glue
Connection StringName - glue
Version String - idle
Timeout Number - java
Virtual StringEnv - number
Of NumberWorkers - python
Virtual StringEnv - worker
Type String
ConnectionUsernamePassword, ConnectionUsernamePasswordArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.