aws-cdk-lib.aws_glue.CfnConnection.ConnectionInputProperty

ConnectionInputProperty Struct

A structure that is used to specify a connection to create or update.

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';

declare const athenaProperties: any;
declare const connectionProperties: any;
declare const customAuthenticationCredentials: any;
declare const pythonProperties: any;
declare const sparkProperties: any;
declare const tokenUrlParametersMap: any;
const connectionInputProperty: glue.CfnConnection.ConnectionInputProperty = {
  connectionType: 'connectionType',

  // the properties below are optional
  athenaProperties: athenaProperties,
  authenticationConfiguration: {
    authenticationType: 'authenticationType',

    // the properties below are optional
    basicAuthenticationCredentials: {
      password: 'password',
      username: 'username',
    },
    customAuthenticationCredentials: customAuthenticationCredentials,
    kmsKeyArn: 'kmsKeyArn',
    oAuth2Properties: {
      authorizationCodeProperties: {
        authorizationCode: 'authorizationCode',
        redirectUri: 'redirectUri',
      },
      oAuth2ClientApplication: {
        awsManagedClientApplicationReference: 'awsManagedClientApplicationReference',
        userManagedClientApplicationClientId: 'userManagedClientApplicationClientId',
      },
      oAuth2Credentials: {
        accessToken: 'accessToken',
        jwtToken: 'jwtToken',
        refreshToken: 'refreshToken',
        userManagedClientApplicationClientSecret: 'userManagedClientApplicationClientSecret',
      },
      oAuth2GrantType: 'oAuth2GrantType',
      tokenUrl: 'tokenUrl',
      tokenUrlParametersMap: tokenUrlParametersMap,
    },
    secretArn: 'secretArn',
  },
  connectionProperties: connectionProperties,
  description: 'description',
  matchCriteria: ['matchCriteria'],
  name: 'name',
  physicalConnectionRequirements: {
    availabilityZone: 'availabilityZone',
    securityGroupIdList: ['securityGroupIdList'],
    subnetId: 'subnetId',
  },
  pythonProperties: pythonProperties,
  sparkProperties: sparkProperties,
  validateCredentials: false,
  validateForComputeEnvironments: ['validateForComputeEnvironments'],
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue

# athena_properties: Any
# connection_properties: Any
# custom_authentication_credentials: Any
# python_properties: Any
# spark_properties: Any
# token_url_parameters_map: Any

connection_input_property = glue.CfnConnection.ConnectionInputProperty(
    connection_type="connectionType",

    # the properties below are optional
    athena_properties=athena_properties,
    authentication_configuration=glue.CfnConnection.AuthenticationConfigurationProperty(
        authentication_type="authenticationType",

        # the properties below are optional
        basic_authentication_credentials=glue.CfnConnection.BasicAuthenticationCredentialsProperty(
            password="password",
            username="username"
        ),
        custom_authentication_credentials=custom_authentication_credentials,
        kms_key_arn="kmsKeyArn",
        o_auth2_properties=glue.CfnConnection.OAuth2PropertiesProperty(
            authorization_code_properties=glue.CfnConnection.AuthorizationCodePropertiesProperty(
                authorization_code="authorizationCode",
                redirect_uri="redirectUri"
            ),
            o_auth2_client_application=glue.CfnConnection.OAuth2ClientApplicationProperty(
                aws_managed_client_application_reference="awsManagedClientApplicationReference",
                user_managed_client_application_client_id="userManagedClientApplicationClientId"
            ),
            o_auth2_credentials=glue.CfnConnection.OAuth2CredentialsProperty(
                access_token="accessToken",
                jwt_token="jwtToken",
                refresh_token="refreshToken",
                user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
            ),
            o_auth2_grant_type="oAuth2GrantType",
            token_url="tokenUrl",
            token_url_parameters_map=token_url_parameters_map
        ),
        secret_arn="secretArn"
    ),
    connection_properties=connection_properties,
    description="description",
    match_criteria=["matchCriteria"],
    name="name",
    physical_connection_requirements=glue.CfnConnection.PhysicalConnectionRequirementsProperty(
        availability_zone="availabilityZone",
        security_group_id_list=["securityGroupIdList"],
        subnet_id="subnetId"
    ),
    python_properties=python_properties,
    spark_properties=spark_properties,
    validate_credentials=False,
    validate_for_compute_environments=["validateForComputeEnvironments"]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.glue.*;

Object athenaProperties;
Object connectionProperties;
Object customAuthenticationCredentials;
Object pythonProperties;
Object sparkProperties;
Object tokenUrlParametersMap;

ConnectionInputProperty connectionInputProperty = ConnectionInputProperty.builder()
        .connectionType("connectionType")

        // the properties below are optional
        .athenaProperties(athenaProperties)
        .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                .authenticationType("authenticationType")

                // the properties below are optional
                .basicAuthenticationCredentials(BasicAuthenticationCredentialsProperty.builder()
                        .password("password")
                        .username("username")
                        .build())
                .customAuthenticationCredentials(customAuthenticationCredentials)
                .kmsKeyArn("kmsKeyArn")
                .oAuth2Properties(OAuth2PropertiesProperty.builder()
                        .authorizationCodeProperties(AuthorizationCodePropertiesProperty.builder()
                                .authorizationCode("authorizationCode")
                                .redirectUri("redirectUri")
                                .build())
                        .oAuth2ClientApplication(OAuth2ClientApplicationProperty.builder()
                                .awsManagedClientApplicationReference("awsManagedClientApplicationReference")
                                .userManagedClientApplicationClientId("userManagedClientApplicationClientId")
                                .build())
                        .oAuth2Credentials(OAuth2CredentialsProperty.builder()
                                .accessToken("accessToken")
                                .jwtToken("jwtToken")
                                .refreshToken("refreshToken")
                                .userManagedClientApplicationClientSecret("userManagedClientApplicationClientSecret")
                                .build())
                        .oAuth2GrantType("oAuth2GrantType")
                        .tokenUrl("tokenUrl")
                        .tokenUrlParametersMap(tokenUrlParametersMap)
                        .build())
                .secretArn("secretArn")
                .build())
        .connectionProperties(connectionProperties)
        .description("description")
        .matchCriteria(List.of("matchCriteria"))
        .name("name")
        .physicalConnectionRequirements(PhysicalConnectionRequirementsProperty.builder()
                .availabilityZone("availabilityZone")
                .securityGroupIdList(List.of("securityGroupIdList"))
                .subnetId("subnetId")
                .build())
        .pythonProperties(pythonProperties)
        .sparkProperties(sparkProperties)
        .validateCredentials(false)
        .validateForComputeEnvironments(List.of("validateForComputeEnvironments"))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Glue;

var athenaProperties;
var connectionProperties;
var customAuthenticationCredentials;
var pythonProperties;
var sparkProperties;
var tokenUrlParametersMap;

var connectionInputProperty = new ConnectionInputProperty {
    ConnectionType = "connectionType",

    // the properties below are optional
    AthenaProperties = athenaProperties,
    AuthenticationConfiguration = new AuthenticationConfigurationProperty {
        AuthenticationType = "authenticationType",

        // the properties below are optional
        BasicAuthenticationCredentials = new BasicAuthenticationCredentialsProperty {
            Password = "password",
            Username = "username"
        },
        CustomAuthenticationCredentials = customAuthenticationCredentials,
        KmsKeyArn = "kmsKeyArn",
        OAuth2Properties = new OAuth2PropertiesProperty {
            AuthorizationCodeProperties = new AuthorizationCodePropertiesProperty {
                AuthorizationCode = "authorizationCode",
                RedirectUri = "redirectUri"
            },
            OAuth2ClientApplication = new OAuth2ClientApplicationProperty {
                AwsManagedClientApplicationReference = "awsManagedClientApplicationReference",
                UserManagedClientApplicationClientId = "userManagedClientApplicationClientId"
            },
            OAuth2Credentials = new OAuth2CredentialsProperty {
                AccessToken = "accessToken",
                JwtToken = "jwtToken",
                RefreshToken = "refreshToken",
                UserManagedClientApplicationClientSecret = "userManagedClientApplicationClientSecret"
            },
            OAuth2GrantType = "oAuth2GrantType",
            TokenUrl = "tokenUrl",
            TokenUrlParametersMap = tokenUrlParametersMap
        },
        SecretArn = "secretArn"
    },
    ConnectionProperties = connectionProperties,
    Description = "description",
    MatchCriteria = new [] { "matchCriteria" },
    Name = "name",
    PhysicalConnectionRequirements = new PhysicalConnectionRequirementsProperty {
        AvailabilityZone = "availabilityZone",
        SecurityGroupIdList = new [] { "securityGroupIdList" },
        SubnetId = "subnetId"
    },
    PythonProperties = pythonProperties,
    SparkProperties = sparkProperties,
    ValidateCredentials = false,
    ValidateForComputeEnvironments = new [] { "validateForComputeEnvironments" }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var athenaProperties interface{}
var connectionProperties interface{}
var customAuthenticationCredentials interface{}
var pythonProperties interface{}
var sparkProperties interface{}
var tokenUrlParametersMap interface{}

connectionInputProperty := &ConnectionInputProperty{
	ConnectionType: jsii.String("connectionType"),

	// the properties below are optional
	AthenaProperties: athenaProperties,
	AuthenticationConfiguration: &AuthenticationConfigurationProperty{
		AuthenticationType: jsii.String("authenticationType"),

		// the properties below are optional
		BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
			Password: jsii.String("password"),
			Username: jsii.String("username"),
		},
		CustomAuthenticationCredentials: customAuthenticationCredentials,
		KmsKeyArn: jsii.String("kmsKeyArn"),
		OAuth2Properties: &OAuth2PropertiesProperty{
			AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
				AuthorizationCode: jsii.String("authorizationCode"),
				RedirectUri: jsii.String("redirectUri"),
			},
			OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
				AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
				UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
			},
			OAuth2Credentials: &OAuth2CredentialsProperty{
				AccessToken: jsii.String("accessToken"),
				JwtToken: jsii.String("jwtToken"),
				RefreshToken: jsii.String("refreshToken"),
				UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
			},
			OAuth2GrantType: jsii.String("oAuth2GrantType"),
			TokenUrl: jsii.String("tokenUrl"),
			TokenUrlParametersMap: tokenUrlParametersMap,
		},
		SecretArn: jsii.String("secretArn"),
	},
	ConnectionProperties: connectionProperties,
	Description: jsii.String("description"),
	MatchCriteria: []*string{
		jsii.String("matchCriteria"),
	},
	Name: jsii.String("name"),
	PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{
		AvailabilityZone: jsii.String("availabilityZone"),
		SecurityGroupIdList: []*string{
			jsii.String("securityGroupIdList"),
		},
		SubnetId: jsii.String("subnetId"),
	},
	PythonProperties: pythonProperties,
	SparkProperties: sparkProperties,
	ValidateCredentials: jsii.Boolean(false),
	ValidateForComputeEnvironments: []*string{
		jsii.String("validateForComputeEnvironments"),
	},
}

Properties

athenaProperties?optionalanyathena_properties?optionalAnyathenaProperties?optionalObjectAthenaProperties?optionalobjectAthenaProperties?optionalinterface{}#

Connection properties specific to the Athena compute environment.

authenticationConfiguration?optionalIResolvable | CfnConnection.AuthenticationConfigurationPropertyauthentication_configuration?optionaltyping.Union[IResolvable, AuthenticationConfigurationProperty]authenticationConfiguration?optionalIResolvableAuthenticationConfiguration?optionalIResolvableAuthenticationConfiguration?optionalinterface{}#

The authentication properties of the connection.

connectionProperties?optionalanyconnection_properties?optionalAnyconnectionProperties?optionalObjectConnectionProperties?optionalobjectConnectionProperties?optionalinterface{}#

These key-value pairs define parameters for the connection.

connectionTypestringconnection_typestrconnectionTypeStringConnectionTypestringConnectionType*stringrequired#

The type of the connection. Currently, these types are supported:.

notes

• JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

JDBC Connections use the following ConnectionParameters.

• Required: All of ( HOST , PORT , JDBC_ENGINE ) or JDBC_CONNECTION_URL .
• Required: All of ( USERNAME , PASSWORD ) or SECRET_ID .
• Optional: JDBC_ENFORCE_SSL , CUSTOM_JDBC_CERT , CUSTOM_JDBC_CERT_STRING , SKIP_CUSTOM_JDBC_CERT_VALIDATION . These parameters are used to configure SSL with JDBC.
• KAFKA - Designates a connection to an Apache Kafka streaming platform.

KAFKA Connections use the following ConnectionParameters.

• Required: KAFKA_BOOTSTRAP_SERVERS .
• Optional: KAFKA_SSL_ENABLED , KAFKA_CUSTOM_CERT , KAFKA_SKIP_CUSTOM_CERT_VALIDATION . These parameters are used to configure SSL with KAFKA .
• Optional: KAFKA_CLIENT_KEYSTORE , KAFKA_CLIENT_KEYSTORE_PASSWORD , KAFKA_CLIENT_KEY_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD . These parameters are used to configure TLS client configuration with SSL in KAFKA .
• Optional: KAFKA_SASL_MECHANISM . Can be specified as SCRAM-SHA-512 , GSSAPI , or AWS_MSK_IAM .
• Optional: KAFKA_SASL_SCRAM_USERNAME , KAFKA_SASL_SCRAM_PASSWORD , ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD . These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA .
• Optional: KAFKA_SASL_GSSAPI_KEYTAB , KAFKA_SASL_GSSAPI_KRB5_CONF , KAFKA_SASL_GSSAPI_SERVICE , KAFKA_SASL_GSSAPI_PRINCIPAL . These parameters are used to configure SASL/GSSAPI authentication with KAFKA .
• MONGODB - Designates a connection to a MongoDB document database.

MONGODB Connections use the following ConnectionParameters.

• Required: CONNECTION_URL .
• Required: All of ( USERNAME , PASSWORD ) or SECRET_ID .
• VIEW_VALIDATION_REDSHIFT - Designates a connection used for view validation by Amazon Redshift.
• VIEW_VALIDATION_ATHENA - Designates a connection used for view validation by Amazon Athena.
• NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

• MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue .

MARKETPLACE Connections use the following ConnectionParameters.

• Required: CONNECTOR_TYPE , CONNECTOR_URL , CONNECTOR_CLASS_NAME , CONNECTION_URL .
• Required for JDBC CONNECTOR_TYPE connections: All of ( USERNAME , PASSWORD ) or SECRET_ID .
• CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue .

For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an AWS Glue connection in the AWS Glue User Guide.

SFTP is not supported.

For more information about how optional ConnectionProperties are used to configure features in AWS Glue , consult AWS Glue connection properties .

For more information about how optional ConnectionProperties are used to configure features in AWS Glue Studio, consult Using connectors and connections .

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

The description of the connection.

matchCriteria?optionalstring[]match_criteria?optionaltyping.List[str]matchCriteria?optionalList<String>MatchCriteria?optionalstring[]MatchCriteria?optional*[]*string#

A list of criteria that can be used in selecting this connection.

name?optionalstringname?optionalstrname?optionalStringName?optionalstringName?optional*string#

The name of the connection.

physicalConnectionRequirements?optionalIResolvable | CfnConnection.PhysicalConnectionRequirementsPropertyphysical_connection_requirements?optionaltyping.Union[IResolvable, PhysicalConnectionRequirementsProperty]physicalConnectionRequirements?optionalIResolvablePhysicalConnectionRequirements?optionalIResolvablePhysicalConnectionRequirements?optionalinterface{}#

The physical connection requirements, such as virtual private cloud (VPC) and `SecurityGroup` , that are needed to successfully make this connection.

pythonProperties?optionalanypython_properties?optionalAnypythonProperties?optionalObjectPythonProperties?optionalobjectPythonProperties?optionalinterface{}#

Connection properties specific to the Python compute environment.

sparkProperties?optionalanyspark_properties?optionalAnysparkProperties?optionalObjectSparkProperties?optionalobjectSparkProperties?optionalinterface{}#

Connection properties specific to the Spark compute environment.

validateCredentials?optionalboolean | IResolvablevalidate_credentials?optionaltyping.Union[bool, IResolvable]validateCredentials?optionalBooleanValidateCredentials?optionalboolValidateCredentials?optionalinterface{}#

A flag to validate the credentials during create connection.

Default is true.

validateForComputeEnvironments?optionalstring[]validate_for_compute_environments?optionaltyping.List[str]validateForComputeEnvironments?optionalList<String>ValidateForComputeEnvironments?optionalstring[]ValidateForComputeEnvironments?optional*[]*string#

The compute environments that the specified connection properties are validated against.