All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:10.864Z") @Stability(Stable) public interface CfnConnectionProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConnection.

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.*;
 CfnConnectionProps cfnConnectionProps = CfnConnectionProps.builder()
         .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:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnConnectionProps.Builder

A builder for CfnConnectionProps

static final class

CfnConnectionProps.Jsii$Proxy

An implementation for CfnConnectionProps
Method Summary

Modifier and Type

Method

Description

static CfnConnectionProps.Builder

builder()

default Object

getAwsLocation()

The location where the connection is created.

default String

getDescription()

Connection description.

String

getDomainIdentifier()

The ID of the domain where the connection is created.

default Object

getEnableTrustedIdentityPropagation()

Specifies whether the trusted identity propagation is enabled.

default String

getEnvironmentIdentifier()

The ID of the environment where the connection is created.

String

getName()

The name of the connection.

default String

getProjectIdentifier()

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

default Object

getProps()

Connection props.

default String

getScope()

The scope of the connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getDomainIdentifier
  
  @Stability(Stable) @NotNull String getDomainIdentifier()
  
  The ID of the domain where the connection is created.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-domainidentifier
- getName
  
  @Stability(Stable) @NotNull String getName()
  
  The name of the connection.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-name
- getAwsLocation
  
  @Stability(Stable) @Nullable default Object getAwsLocation()
  
  The location where the connection is created.
  Returns union: either IResolvable or CfnConnection.AwsLocationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-awslocation
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  Connection description.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-description
- getEnableTrustedIdentityPropagation
  
  @Stability(Stable) @Nullable default Object getEnableTrustedIdentityPropagation()
  
  Specifies whether the trusted identity propagation is enabled.
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-enabletrustedidentitypropagation
- getEnvironmentIdentifier
  
  @Stability(Stable) @Nullable default String getEnvironmentIdentifier()
  
  The ID of the environment where the connection is created.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-environmentidentifier
- getProjectIdentifier
  
  @Stability(Stable) @Nullable default String getProjectIdentifier()
  
  The identifier of the project in which the connection should be created.
  If
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-projectidentifier
- getProps
  
  @Stability(Stable) @Nullable default Object getProps()
  
  Connection props.
  Returns union: either IResolvable or CfnConnection.ConnectionPropertiesInputProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-props
- getScope
  
  @Stability(Stable) @Nullable default String getScope()
  
  The scope of the connection.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-scope
- builder
  
  @Stability(Stable) static CfnConnectionProps.Builder builder()
  
  Returns:
  
  a CfnConnectionProps.Builder of CfnConnectionProps

Interface CfnConnectionProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getDomainIdentifier

getName

getAwsLocation

getDescription

getEnableTrustedIdentityPropagation

getEnvironmentIdentifier

getProjectIdentifier

getProps

getScope

builder