Package software.amazon.awscdk.services.datazone

Class CfnConnection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.datazone.CfnConnection

All Implemented Interfaces:

IInspectable, IConnectionRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:10.835Z")
@Stability(Stable)
public class CfnConnection
extends CfnResource
implements IInspectable, IConnectionRef

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datazone.*;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .domainIdentifier("domainIdentifier")
         .name("name")
         // the properties below are optional
         .awsLocation(AwsLocationProperty.builder()
                 .accessRole("accessRole")
                 .awsAccountId("awsAccountId")
                 .awsRegion("awsRegion")
                 .iamConnectionId("iamConnectionId")
                 .build())
         .description("description")
         .enableTrustedIdentityPropagation(false)
         .environmentIdentifier("environmentIdentifier")
         .projectIdentifier("projectIdentifier")
         .props(ConnectionPropertiesInputProperty.builder()
                 .amazonQProperties(AmazonQPropertiesInputProperty.builder()
                         .authMode("authMode")
                         .isEnabled(false)
                         .profileArn("profileArn")
                         .build())
                 .athenaProperties(AthenaPropertiesInputProperty.builder()
                         .workgroupName("workgroupName")
                         .build())
                 .glueProperties(GluePropertiesInputProperty.builder()
                         .glueConnectionInput(GlueConnectionInputProperty.builder()
                                 .athenaProperties(Map.of(
                                         "athenaPropertiesKey", "athenaProperties"))
                                 .authenticationConfiguration(AuthenticationConfigurationInputProperty.builder()
                                         .authenticationType("authenticationType")
                                         .basicAuthenticationCredentials(BasicAuthenticationCredentialsProperty.builder()
                                                 .password("password")
                                                 .userName("userName")
                                                 .build())
                                         .customAuthenticationCredentials(Map.of(
                                                 "customAuthenticationCredentialsKey", "customAuthenticationCredentials"))
                                         .kmsKeyArn("kmsKeyArn")
                                         .oAuth2Properties(OAuth2PropertiesProperty.builder()
                                                 .authorizationCodeProperties(AuthorizationCodePropertiesProperty.builder()
                                                         .authorizationCode("authorizationCode")
                                                         .redirectUri("redirectUri")
                                                         .build())
                                                 .oAuth2ClientApplication(OAuth2ClientApplicationProperty.builder()
                                                         .awsManagedClientApplicationReference("awsManagedClientApplicationReference")
                                                         .userManagedClientApplicationClientId("userManagedClientApplicationClientId")
                                                         .build())
                                                 .oAuth2Credentials(GlueOAuth2CredentialsProperty.builder()
                                                         .accessToken("accessToken")
                                                         .jwtToken("jwtToken")
                                                         .refreshToken("refreshToken")
                                                         .userManagedClientApplicationClientSecret("userManagedClientApplicationClientSecret")
                                                         .build())
                                                 .oAuth2GrantType("oAuth2GrantType")
                                                 .tokenUrl("tokenUrl")
                                                 .tokenUrlParametersMap(Map.of(
                                                         "tokenUrlParametersMapKey", "tokenUrlParametersMap"))
                                                 .build())
                                         .secretArn("secretArn")
                                         .build())
                                 .connectionProperties(Map.of(
                                         "connectionPropertiesKey", "connectionProperties"))
                                 .connectionType("connectionType")
                                 .description("description")
                                 .matchCriteria("matchCriteria")
                                 .name("name")
                                 .physicalConnectionRequirements(PhysicalConnectionRequirementsProperty.builder()
                                         .availabilityZone("availabilityZone")
                                         .securityGroupIdList(List.of("securityGroupIdList"))
                                         .subnetId("subnetId")
                                         .subnetIdList(List.of("subnetIdList"))
                                         .build())
                                 .pythonProperties(Map.of(
                                         "pythonPropertiesKey", "pythonProperties"))
                                 .sparkProperties(Map.of(
                                         "sparkPropertiesKey", "sparkProperties"))
                                 .validateCredentials(false)
                                 .validateForComputeEnvironments(List.of("validateForComputeEnvironments"))
                                 .build())
                         .build())
                 .hyperPodProperties(HyperPodPropertiesInputProperty.builder()
                         .clusterName("clusterName")
                         .build())
                 .iamProperties(IamPropertiesInputProperty.builder()
                         .glueLineageSyncEnabled(false)
                         .build())
                 .redshiftProperties(RedshiftPropertiesInputProperty.builder()
                         .credentials(RedshiftCredentialsProperty.builder()
                                 .secretArn("secretArn")
                                 .usernamePassword(UsernamePasswordProperty.builder()
                                         .password("password")
                                         .username("username")
                                         .build())
                                 .build())
                         .databaseName("databaseName")
                         .host("host")
                         .lineageSync(RedshiftLineageSyncConfigurationInputProperty.builder()
                                 .enabled(false)
                                 .schedule(LineageSyncScheduleProperty.builder()
                                         .schedule("schedule")
                                         .build())
                                 .build())
                         .port(123)
                         .storage(RedshiftStoragePropertiesProperty.builder()
                                 .clusterName("clusterName")
                                 .workgroupName("workgroupName")
                                 .build())
                         .build())
                 .s3Properties(S3PropertiesInputProperty.builder()
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .s3AccessGrantLocationId("s3AccessGrantLocationId")
                         .build())
                 .sparkEmrProperties(SparkEmrPropertiesInputProperty.builder()
                         .computeArn("computeArn")
                         .instanceProfileArn("instanceProfileArn")
                         .javaVirtualEnv("javaVirtualEnv")
                         .logUri("logUri")
                         .managedEndpointArn("managedEndpointArn")
                         .pythonVirtualEnv("pythonVirtualEnv")
                         .runtimeRole("runtimeRole")
                         .trustedCertificatesS3Uri("trustedCertificatesS3Uri")
                         .build())
                 .sparkGlueProperties(SparkGluePropertiesInputProperty.builder()
                         .additionalArgs(SparkGlueArgsProperty.builder()
                                 .connection("connection")
                                 .build())
                         .glueConnectionName("glueConnectionName")
                         .glueVersion("glueVersion")
                         .idleTimeout(123)
                         .javaVirtualEnv("javaVirtualEnv")
                         .numberOfWorkers(123)
                         .pythonVirtualEnv("pythonVirtualEnv")
                         .workerType("workerType")
                         .build())
                 .build())
         .scope("scope")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnConnection.AmazonQPropertiesInputProperty	Amazon Q properties of the connection.
static interface	CfnConnection.AthenaPropertiesInputProperty	The Amazon Athena properties of a connection.
static interface	CfnConnection.AuthenticationConfigurationInputProperty	The authentication configuration of a connection.
static interface	CfnConnection.AuthorizationCodePropertiesProperty	The authorization code properties of a connection.
static interface	CfnConnection.AwsLocationProperty	The location of a project.
static interface	CfnConnection.BasicAuthenticationCredentialsProperty	The basic authentication credentials of a connection.
static final class	CfnConnection.Builder	A fluent builder for CfnConnection.
static interface	CfnConnection.ConnectionPropertiesInputProperty	The properties of a connection.
static interface	CfnConnection.GlueConnectionInputProperty	The AWS Glue connecton input.
static interface	CfnConnection.GlueOAuth2CredentialsProperty	The GlueOAuth2 credentials of a connection.
static interface	CfnConnection.GluePropertiesInputProperty	The AWS Glue properties of a connection.
static interface	CfnConnection.HyperPodPropertiesInputProperty	The hyper pod properties of a AWS Glue properties patch.
static interface	CfnConnection.IamPropertiesInputProperty	The IAM properties of a connection.
static interface	CfnConnection.LineageSyncScheduleProperty	The lineage sync schedule.
static interface	CfnConnection.OAuth2ClientApplicationProperty	The OAuth2Client application.
static interface	CfnConnection.OAuth2PropertiesProperty	The OAuth2 properties.
static interface	CfnConnection.PhysicalConnectionRequirementsProperty	Physical connection requirements of a connection.
static interface	CfnConnection.RedshiftCredentialsProperty	Amazon Redshift credentials of a connection.
static interface	CfnConnection.RedshiftLineageSyncConfigurationInputProperty	The Amaon Redshift lineage sync configuration.
static interface	CfnConnection.RedshiftPropertiesInputProperty	The Amazon Redshift properties.
static interface	CfnConnection.RedshiftStoragePropertiesProperty	The Amazon Redshift storage properties.
static interface	CfnConnection.S3PropertiesInputProperty	S3 Properties Input.
static interface	CfnConnection.SparkEmrPropertiesInputProperty	The Spark EMR properties.
static interface	CfnConnection.SparkGlueArgsProperty	The Spark AWS Glue args.
static interface	CfnConnection.SparkGluePropertiesInputProperty	The Spark AWS Glue properties.
static interface	CfnConnection.UsernamePasswordProperty	The username and password of a connection.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.datazone.IConnectionRef

IConnectionRef.Jsii$Default, IConnectionRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)
	CfnConnection(software.constructs.Construct scope, String id, CfnConnectionProps props)	Create a new AWS::DataZone::Connection.

Method Summary

Modifier and Type	Method	Description
String	getAttrConnectionId()	The ID of the connection.
String	getAttrDomainId()	The domain ID of the connection.
String	getAttrDomainUnitId()	The domain unit ID of the connection.
String	getAttrEnvironmentId()	The ID of the environment.
String	getAttrEnvironmentUserRole()	The environment user role.
String	getAttrProjectId()	The ID of the project.
String	getAttrType()	The type of the connection.
Object	getAwsLocation()	The location where the connection is created.
protected Map<String,Object>	getCfnProperties()
ConnectionReference	getConnectionRef()	A reference to a Connection resource.
String	getDescription()	Connection description.
String	getDomainIdentifier()	The ID of the domain where the connection is created.
Object	getEnableTrustedIdentityPropagation()	Specifies whether the trusted identity propagation is enabled.
String	getEnvironmentIdentifier()	The ID of the environment where the connection is created.
String	getName()	The name of the connection.
String	getProjectIdentifier()	The identifier of the project in which the connection should be created.
Object	getProps()	Connection props.
String	getScope()	The scope of the connection.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnConnection(Object x)	Checks whether the given object is a CfnConnection.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsLocation(IResolvable value)	The location where the connection is created.
void	setAwsLocation(CfnConnection.AwsLocationProperty value)	The location where the connection is created.
void	setDescription(String value)	Connection description.
void	setDomainIdentifier(String value)	The ID of the domain where the connection is created.
void	setEnableTrustedIdentityPropagation(Boolean value)	Specifies whether the trusted identity propagation is enabled.
void	setEnableTrustedIdentityPropagation(IResolvable value)	Specifies whether the trusted identity propagation is enabled.
void	setEnvironmentIdentifier(String value)	The ID of the environment where the connection is created.
void	setName(String value)	The name of the connection.
void	setProjectIdentifier(String value)	The identifier of the project in which the connection should be created.
void	setProps(IResolvable value)	Connection props.
void	setProps(CfnConnection.ConnectionPropertiesInputProperty value)	Connection props.
void	setScope(String value)	The scope of the connection.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnConnection

protected CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)

CfnConnection

protected CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConnection

@Stability(Stable)
public CfnConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnConnectionProps props)

Create a new AWS::DataZone::Connection.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnConnection

@Stability(Stable)
@NotNull
public static Boolean isCfnConnection(@NotNull
 Object x)

Checks whether the given object is a CfnConnection.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConnectionId

@Stability(Stable)
@NotNull
public String getAttrConnectionId()

The ID of the connection.

getAttrDomainId

@Stability(Stable)
@NotNull
public String getAttrDomainId()

The domain ID of the connection.

getAttrDomainUnitId

@Stability(Stable)
@NotNull
public String getAttrDomainUnitId()

The domain unit ID of the connection.

getAttrEnvironmentId

@Stability(Stable)
@NotNull
public String getAttrEnvironmentId()

The ID of the environment.

getAttrEnvironmentUserRole

@Stability(Stable)
@NotNull
public String getAttrEnvironmentUserRole()

The environment user role.

getAttrProjectId

@Stability(Stable)
@NotNull
public String getAttrProjectId()

The ID of the project.

getAttrType

@Stability(Stable)
@NotNull
public String getAttrType()

The type of the connection.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectionRef

@Stability(Stable)
@NotNull
public ConnectionReference getConnectionRef()

A reference to a Connection resource.

Specified by:

getConnectionRef in interface IConnectionRef

getDomainIdentifier

@Stability(Stable)
@NotNull
public String getDomainIdentifier()

The ID of the domain where the connection is created.

setDomainIdentifier

@Stability(Stable)
public void setDomainIdentifier(@NotNull
 String value)

The ID of the domain where the connection is created.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the connection.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the connection.

getAwsLocation

@Stability(Stable)
@Nullable
public Object getAwsLocation()

The location where the connection is created.

Returns union: either IResolvable or CfnConnection.AwsLocationProperty

setAwsLocation

@Stability(Stable)
public void setAwsLocation(@Nullable
 IResolvable value)

The location where the connection is created.

setAwsLocation

@Stability(Stable)
public void setAwsLocation(@Nullable
 CfnConnection.AwsLocationProperty value)

The location where the connection is created.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

Connection description.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

Connection description.

getEnableTrustedIdentityPropagation

@Stability(Stable)
@Nullable
public Object getEnableTrustedIdentityPropagation()

Specifies whether the trusted identity propagation is enabled.

Returns union: either Boolean or IResolvable

setEnableTrustedIdentityPropagation

@Stability(Stable)
public void setEnableTrustedIdentityPropagation(@Nullable
 Boolean value)

Specifies whether the trusted identity propagation is enabled.

setEnableTrustedIdentityPropagation

@Stability(Stable)
public void setEnableTrustedIdentityPropagation(@Nullable
 IResolvable value)

Specifies whether the trusted identity propagation is enabled.

getEnvironmentIdentifier

@Stability(Stable)
@Nullable
public String getEnvironmentIdentifier()

The ID of the environment where the connection is created.

setEnvironmentIdentifier

@Stability(Stable)
public void setEnvironmentIdentifier(@Nullable
 String value)

The ID of the environment where the connection is created.

getProjectIdentifier

@Stability(Stable)
@Nullable
public String getProjectIdentifier()

The identifier of the project in which the connection should be created.

setProjectIdentifier

@Stability(Stable)
public void setProjectIdentifier(@Nullable
 String value)

The identifier of the project in which the connection should be created.

getProps

@Stability(Stable)
@Nullable
public Object getProps()

Connection props.

Returns union: either IResolvable or CfnConnection.ConnectionPropertiesInputProperty

setProps

@Stability(Stable)
public void setProps(@Nullable
 IResolvable value)

Connection props.

setProps

@Stability(Stable)
public void setProps(@Nullable
 CfnConnection.ConnectionPropertiesInputProperty value)

Connection props.

getScope

@Stability(Stable)
@Nullable
public String getScope()

The scope of the connection.

setScope

@Stability(Stable)
public void setScope(@Nullable
 String value)

The scope of the connection.