Package software.amazon.awscdk.services.glue

Class CfnConnection.ConnectionInputProperty.Builder

java.lang.Object
software.amazon.awscdk.services.glue.CfnConnection.ConnectionInputProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnConnection.ConnectionInputProperty>
Enclosing interface:
CfnConnection.ConnectionInputProperty
@Stability(Stable) public static final class CfnConnection.ConnectionInputProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnConnection.ConnectionInputProperty>
A builder for CfnConnection.ConnectionInputProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • connectionType

      @Stability(Stable) public CfnConnection.ConnectionInputProperty.Builder connectionType(String connectionType)
      Sets the value of CfnConnection.ConnectionInputProperty.getConnectionType()
      Parameters:
      connectionType - The type of the connection. Currently, these types are supported:. This parameter is required.
      • 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 .
      • 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 .

      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 .

      Returns:
      this

    • connectionProperties

      @Stability(Stable) public CfnConnection.ConnectionInputProperty.Builder connectionProperties(Object connectionProperties)
      Sets the value of CfnConnection.ConnectionInputProperty.getConnectionProperties()
      Parameters:
      connectionProperties - These key-value pairs define parameters for the connection.
      Returns:
      this

    • description

      @Stability(Stable) public CfnConnection.ConnectionInputProperty.Builder description(String description)
      Sets the value of CfnConnection.ConnectionInputProperty.getDescription()
      Parameters:
      description - The description of the connection.
      Returns:
      this

    • matchCriteria

      @Stability(Stable) public CfnConnection.ConnectionInputProperty.Builder matchCriteria(List<String> matchCriteria)
      Sets the value of CfnConnection.ConnectionInputProperty.getMatchCriteria()
      Parameters:
      matchCriteria - A list of criteria that can be used in selecting this connection.
      Returns:
      this

    • name

      @Stability(Stable) public CfnConnection.ConnectionInputProperty.Builder name(String name)
      Sets the value of CfnConnection.ConnectionInputProperty.getName()
      Parameters:
      name - The name of the connection. Connection will not function as expected without a name.
      Returns:
      this

    • physicalConnectionRequirements

      @Stability(Stable) public CfnConnection.ConnectionInputProperty.Builder physicalConnectionRequirements(IResolvable physicalConnectionRequirements)
      Sets the value of CfnConnection.ConnectionInputProperty.getPhysicalConnectionRequirements()
      Parameters:
      physicalConnectionRequirements - A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.
      Returns:
      this

    • physicalConnectionRequirements

      @Stability(Stable) public CfnConnection.ConnectionInputProperty.Builder physicalConnectionRequirements(CfnConnection.PhysicalConnectionRequirementsProperty physicalConnectionRequirements)
      Sets the value of CfnConnection.ConnectionInputProperty.getPhysicalConnectionRequirements()
      Parameters:
      physicalConnectionRequirements - A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.
      Returns:
      this

    • build

      @Stability(Stable) public CfnConnection.ConnectionInputProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnConnection.ConnectionInputProperty>
      Returns:
      a new instance of CfnConnection.ConnectionInputProperty
      Throws:
      NullPointerException - if any required attribute was not provided