Struct aws_sdk_glue::types::builders::ConnectionBuilder

#[non_exhaustive]
pub struct ConnectionBuilder { /* private fields */ }

A builder for Connection.

Implementations

impl ConnectionBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of the connection definition.

pub fn set_name(self, input: Option<String>) -> Self

The name of the connection definition.

pub fn get_name(&self) -> &Option<String>

The name of the connection definition.

pub fn description(self, input: impl Into<String>) -> Self

The description of the connection.

pub fn set_description(self, input: Option<String>) -> Self

The description of the connection.

pub fn get_description(&self) -> &Option<String>

The description of the connection.

pub fn connection_type(self, input: ConnectionType) -> Self

The type of the connection. Currently, SFTP is not supported.

pub fn set_connection_type(self, input: Option<ConnectionType>) -> Self

The type of the connection. Currently, SFTP is not supported.

pub fn get_connection_type(&self) -> &Option<ConnectionType>

The type of the connection. Currently, SFTP is not supported.

pub fn match_criteria(self, input: impl Into<String>) -> Self

Appends an item to match_criteria.

To override the contents of this collection use set_match_criteria.

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

pub fn set_match_criteria(self, input: Option<Vec<String>>) -> Self

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

pub fn get_match_criteria(&self) -> &Option<Vec<String>>

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

pub fn connection_properties( self, k: ConnectionPropertyKey, v: impl Into<String>, ) -> Self

Adds a key-value pair to connection_properties.

To override the contents of this collection use set_connection_properties.

These key-value pairs define parameters for the connection:

• HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.

• PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.

• USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".

• PASSWORD - A password, if one is used, for the user name.

• ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

• JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.

• JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

• JDBC_ENGINE - The name of the JDBC engine to use.

• JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

• CONFIG_FILES - (Reserved for future use.)

• INSTANCE_ID - The instance ID to use.

• JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

• JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.

• CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

• SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.

• CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

• CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

• SECRET_ID - The secret ID used for the secret manager of credentials.

• CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.

• CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.

• CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.

• KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

• KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".

• KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

• KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".

• KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

• KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).

• KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

• ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).

• ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM", or "PLAIN". These are the supported SASL Mechanisms.

• KAFKA_SASL_PLAIN_USERNAME - A plaintext username used to authenticate with the "PLAIN" mechanism.

• KAFKA_SASL_PLAIN_PASSWORD - A plaintext password used to authenticate with the "PLAIN" mechanism.

• ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.

• KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.

• ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.

• KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.

• KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.

• KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.

• KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.

pub fn set_connection_properties( self, input: Option<HashMap<ConnectionPropertyKey, String>>, ) -> Self

These key-value pairs define parameters for the connection:

• HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.

• PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.

• USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".

• PASSWORD - A password, if one is used, for the user name.

• ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

• JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.

• JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

• JDBC_ENGINE - The name of the JDBC engine to use.

• JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

• CONFIG_FILES - (Reserved for future use.)

• INSTANCE_ID - The instance ID to use.

• JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

• JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.

• CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

• SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.

• CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

• CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

• SECRET_ID - The secret ID used for the secret manager of credentials.

• CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.

• CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.

• CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.

• KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

• KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".

• KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

• KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".

• KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

• KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).

• KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

• ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).

• ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM", or "PLAIN". These are the supported SASL Mechanisms.

• KAFKA_SASL_PLAIN_USERNAME - A plaintext username used to authenticate with the "PLAIN" mechanism.

• KAFKA_SASL_PLAIN_PASSWORD - A plaintext password used to authenticate with the "PLAIN" mechanism.

• ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.

• KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.

• ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.

• KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.

• KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.

• KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.

• KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.

pub fn get_connection_properties( &self, ) -> &Option<HashMap<ConnectionPropertyKey, String>>

These key-value pairs define parameters for the connection:

• HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.

• PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.

• USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".

• PASSWORD - A password, if one is used, for the user name.

• ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

• JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.

• JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

• JDBC_ENGINE - The name of the JDBC engine to use.

• JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

• CONFIG_FILES - (Reserved for future use.)

• INSTANCE_ID - The instance ID to use.

• JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

• JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.

• CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

• SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.

• CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

• CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

• SECRET_ID - The secret ID used for the secret manager of credentials.

• CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.

• CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.

• CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.

• KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

• KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".

• KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

• KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".

• KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

• KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).

• KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

• ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).

• ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", "AWS_MSK_IAM", or "PLAIN". These are the supported SASL Mechanisms.

• KAFKA_SASL_PLAIN_USERNAME - A plaintext username used to authenticate with the "PLAIN" mechanism.

• KAFKA_SASL_PLAIN_PASSWORD - A plaintext password used to authenticate with the "PLAIN" mechanism.

• ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.

• KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.

• ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).

• KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.

• KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.

• KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.

• KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.

• KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.

pub fn physical_connection_requirements( self, input: PhysicalConnectionRequirements, ) -> Self

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

pub fn set_physical_connection_requirements( self, input: Option<PhysicalConnectionRequirements>, ) -> Self

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

pub fn get_physical_connection_requirements( &self, ) -> &Option<PhysicalConnectionRequirements>

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

pub fn creation_time(self, input: DateTime) -> Self

The timestamp of the time that this connection definition was created.

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

The timestamp of the time that this connection definition was created.

pub fn get_creation_time(&self) -> &Option<DateTime>

The timestamp of the time that this connection definition was created.

pub fn last_updated_time(self, input: DateTime) -> Self

The timestamp of the last time the connection definition was updated.

pub fn set_last_updated_time(self, input: Option<DateTime>) -> Self

The timestamp of the last time the connection definition was updated.

pub fn get_last_updated_time(&self) -> &Option<DateTime>

The timestamp of the last time the connection definition was updated.

pub fn last_updated_by(self, input: impl Into<String>) -> Self

The user, group, or role that last updated this connection definition.

pub fn set_last_updated_by(self, input: Option<String>) -> Self

The user, group, or role that last updated this connection definition.

pub fn get_last_updated_by(&self) -> &Option<String>

The user, group, or role that last updated this connection definition.

pub fn status(self, input: ConnectionStatus) -> Self

The status of the connection. Can be one of: READY, IN_PROGRESS, or FAILED.

pub fn set_status(self, input: Option<ConnectionStatus>) -> Self

The status of the connection. Can be one of: READY, IN_PROGRESS, or FAILED.

pub fn get_status(&self) -> &Option<ConnectionStatus>

The status of the connection. Can be one of: READY, IN_PROGRESS, or FAILED.

pub fn status_reason(self, input: impl Into<String>) -> Self

The reason for the connection status.

pub fn set_status_reason(self, input: Option<String>) -> Self

The reason for the connection status.

pub fn get_status_reason(&self) -> &Option<String>

The reason for the connection status.

pub fn last_connection_validation_time(self, input: DateTime) -> Self

A timestamp of the time this connection was last validated.

pub fn set_last_connection_validation_time( self, input: Option<DateTime>, ) -> Self

A timestamp of the time this connection was last validated.

pub fn get_last_connection_validation_time(&self) -> &Option<DateTime>

A timestamp of the time this connection was last validated.

pub fn authentication_configuration( self, input: AuthenticationConfiguration, ) -> Self

The authentication properties of the connection.

pub fn set_authentication_configuration( self, input: Option<AuthenticationConfiguration>, ) -> Self

The authentication properties of the connection.

pub fn get_authentication_configuration( &self, ) -> &Option<AuthenticationConfiguration>

The authentication properties of the connection.

pub fn build(self) -> Connection

Consumes the builder and constructs a Connection.

Trait Implementations

impl Clone for ConnectionBuilder

fn clone(&self) -> ConnectionBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConnectionBuilder

fn default() -> ConnectionBuilder

Returns the “default value” for a type.

impl PartialEq for ConnectionBuilder

fn eq(&self, other: &ConnectionBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConnectionBuilder