Struct aws_sdk_glue::types::builders::ConnectionInputBuilder

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

A builder for ConnectionInput.

Implementations

impl ConnectionInputBuilder

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

The name of the connection. Connection will not function as expected without a name.

This field is required.

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

The name of the connection. Connection will not function as expected without a name.

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

The name of the connection. Connection will not function as expected without a name.

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

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

This field is required.

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

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.

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

pub fn get_connection_type(&self) -> &Option<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.

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

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.

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

These key-value pairs define parameters for the connection.

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

These key-value pairs define parameters for the connection.

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

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

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

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

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

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

pub fn build(self) -> Result<ConnectionInput, BuildError>

Consumes the builder and constructs a ConnectionInput. This method will fail if any of the following fields are not set:

• name
• connection_type
• connection_properties

Trait Implementations

impl Clone for ConnectionInputBuilder

fn clone(&self) -> ConnectionInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionInputBuilder

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

Formats the value using the given formatter.

impl Default for ConnectionInputBuilder

fn default() -> ConnectionInputBuilder

Returns the “default value” for a type.

impl PartialEq for ConnectionInputBuilder

fn eq(&self, other: &ConnectionInputBuilder) -> 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 ConnectionInputBuilder