Interface CfnConnection.ConnectionInputProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConnection.ConnectionInputProperty.Jsii$Proxy
- Enclosing class:
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.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(AuthenticationConfigurationInputProperty.builder()
.authenticationType("authenticationType")
// the properties below are optional
.basicAuthenticationCredentials(BasicAuthenticationCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.customAuthenticationCredentials(customAuthenticationCredentials)
.kmsKeyArn("kmsKeyArn")
.oAuth2Properties(OAuth2PropertiesInputProperty.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnConnection.ConnectionInputPropertystatic final classAn implementation forCfnConnection.ConnectionInputProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectConnection properties specific to the Athena compute environment.default ObjectThe authentication properties of the connection.default ObjectThese key-value pairs define parameters for the connection.The type of the connection.default StringThe description of the connection.A list of criteria that can be used in selecting this connection.default StringgetName()The name of the connection.default ObjectThe physical connection requirements, such as virtual private cloud (VPC) andSecurityGroup, that are needed to successfully make this connection.default ObjectConnection properties specific to the Python compute environment.default ObjectConnection properties specific to the Spark compute environment.default ObjectA flag to validate the credentials during create connection.The compute environments that the specified connection properties are validated against.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getConnectionType
The type of the connection. Currently, these types are supported:.JDBC- Designates a connection to a database through Java Database Connectivity (JDBC).
JDBCConnections use the following ConnectionParameters.- Required: All of (
HOST,PORT,JDBC_ENGINE) orJDBC_CONNECTION_URL. - Required: All of (
USERNAME,PASSWORD) orSECRET_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.
KAFKAConnections 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 withKAFKA. - 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 inKAFKA. - Optional:
KAFKA_SASL_MECHANISM. Can be specified asSCRAM-SHA-512,GSSAPI, orAWS_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 withKAFKA. - 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 withKAFKA. MONGODB- Designates a connection to a MongoDB document database.
MONGODBConnections use the following ConnectionParameters.- Required:
CONNECTION_URL. - Required: All of (
USERNAME,PASSWORD) orSECRET_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).
NETWORKConnections 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 .
MARKETPLACEConnections use the following ConnectionParameters.- Required:
CONNECTOR_TYPE,CONNECTOR_URL,CONNECTOR_CLASS_NAME,CONNECTION_URL. - Required for
JDBCCONNECTOR_TYPEconnections: All of (USERNAME,PASSWORD) orSECRET_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.
SFTPis 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 .
- See Also:
-
getAthenaProperties
Connection properties specific to the Athena compute environment.- See Also:
-
getAuthenticationConfiguration
The authentication properties of the connection.Returns union: either
IResolvableorCfnConnection.AuthenticationConfigurationInputProperty- See Also:
-
getConnectionProperties
These key-value pairs define parameters for the connection.- See Also:
-
getDescription
The description of the connection.- See Also:
-
getMatchCriteria
A list of criteria that can be used in selecting this connection.- See Also:
-
getName
The name of the connection.- See Also:
-
getPhysicalConnectionRequirements
The physical connection requirements, such as virtual private cloud (VPC) andSecurityGroup, that are needed to successfully make this connection.Returns union: either
IResolvableorCfnConnection.PhysicalConnectionRequirementsProperty- See Also:
-
getPythonProperties
Connection properties specific to the Python compute environment.- See Also:
-
getSparkProperties
Connection properties specific to the Spark compute environment.- See Also:
-
getValidateCredentials
A flag to validate the credentials during create connection.Default is true.
Returns union: either
BooleanorIResolvable- See Also:
-
getValidateForComputeEnvironments
The compute environments that the specified connection properties are validated against.- See Also:
-
builder
-