Class ConnectionInput

java.lang.Object
software.amazon.awssdk.services.glue.model.ConnectionInput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ConnectionInput.Builder,ConnectionInput>
@Generated("software.amazon.awssdk:codegen") public final class ConnectionInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConnectionInput.Builder,ConnectionInput>

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

See Also:

  • Method Details

    • name

      public final String name()

      The name of the connection.

      Returns:
      The name of the connection.

    • description

      public final String description()

      The description of the connection.

      Returns:
      The description of the connection.

    • connectionType

      public final ConnectionType connectionType()

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

      • 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.

      • SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

        • Requires the AuthenticationConfiguration member to be configured.

      • 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 Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by 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 Glue.

      SFTP is not supported.

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

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

      If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

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

      • 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.

      • SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

        • Requires the AuthenticationConfiguration member to be configured.

      • 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 Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by 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 Glue.

      SFTP is not supported.

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

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

      See Also:

    • connectionTypeAsString

      public final String connectionTypeAsString()

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

      • 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.

      • SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

        • Requires the AuthenticationConfiguration member to be configured.

      • 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 Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by 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 Glue.

      SFTP is not supported.

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

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

      If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

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

      • 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.

      • SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

        • Requires the AuthenticationConfiguration member to be configured.

      • 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 Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by 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 Glue.

      SFTP is not supported.

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

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

      See Also:

    • hasMatchCriteria

      public final boolean hasMatchCriteria()
      For responses, this returns true if the service returned a value for the MatchCriteria property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • matchCriteria

      public final List<String> matchCriteria()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMatchCriteria() method.

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

    • connectionProperties

      public final Map<ConnectionPropertyKey,String> connectionProperties()

      These key-value pairs define parameters for the connection.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionProperties() method.

      Returns:
      These key-value pairs define parameters for the connection.

    • hasConnectionProperties

      public final boolean hasConnectionProperties()
      For responses, this returns true if the service returned a value for the ConnectionProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • connectionPropertiesAsStrings

      public final Map<String,String> connectionPropertiesAsStrings()

      These key-value pairs define parameters for the connection.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionProperties() method.

      Returns:
      These key-value pairs define parameters for the connection.

    • hasAthenaProperties

      public final boolean hasAthenaProperties()
      For responses, this returns true if the service returned a value for the AthenaProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • athenaProperties

      public final Map<String,String> athenaProperties()

      This field is not currently used.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAthenaProperties() method.

      Returns:
      This field is not currently used.

    • physicalConnectionRequirements

      public final PhysicalConnectionRequirements physicalConnectionRequirements()

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

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

    • authenticationConfiguration

      public final AuthenticationConfigurationInput authenticationConfiguration()

      The authentication properties of the connection. Used for a Salesforce connection.

      Returns:
      The authentication properties of the connection. Used for a Salesforce connection.

    • validateCredentials

      public final Boolean validateCredentials()

      A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.

      Returns:
      A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.

    • toBuilder

      public ConnectionInput.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConnectionInput.Builder,ConnectionInput>
      Returns:
      a builder for type T

    • builder

      public static ConnectionInput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ConnectionInput.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.