#[non_exhaustive]pub struct ConnectionBuilder { /* private fields */ }
Expand description
A builder for Connection
.
Implementations§
Source§impl ConnectionBuilder
impl ConnectionBuilder
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the connection.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the connection.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the connection.
Sourcepub fn connection_type(self, input: ConnectionType) -> Self
pub fn connection_type(self, input: ConnectionType) -> Self
The type of the connection. Currently, SFTP is not supported.
Sourcepub fn set_connection_type(self, input: Option<ConnectionType>) -> Self
pub fn set_connection_type(self, input: Option<ConnectionType>) -> Self
The type of the connection. Currently, SFTP is not supported.
Sourcepub fn get_connection_type(&self) -> &Option<ConnectionType>
pub fn get_connection_type(&self) -> &Option<ConnectionType>
The type of the connection. Currently, SFTP is not supported.
Sourcepub fn match_criteria(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_match_criteria(self, input: Option<Vec<String>>) -> Self
pub fn set_match_criteria(self, input: Option<Vec<String>>) -> Self
A list of criteria that can be used in selecting this connection.
Sourcepub fn get_match_criteria(&self) -> &Option<Vec<String>>
pub fn get_match_criteria(&self) -> &Option<Vec<String>>
A list of criteria that can be used in selecting this connection.
Sourcepub fn connection_properties(
self,
k: ConnectionPropertyKey,
v: impl Into<String>,
) -> Self
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 when using the version 1 Connection schema:
-
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 forUSER_NAME
is "USERNAME
". -
PASSWORD
- A password, if one is used, for the user name. -
ENCRYPTED_PASSWORD
- When you enable connection password protection by settingConnectionPasswordEncryption
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 isfalse
. 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 totrue
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 theSSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as thehostNameInCertificate
. -
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 Kerberoskeytab
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 Kerberoskrb5.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 withsasl.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. -
ROLE_ARN
- The role to be used for running queries. -
REGION
- The Amazon Web Services Region where queries will be run. -
WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run. -
CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run. -
DATABASE
- The Amazon Redshift database that you are connecting to.
Sourcepub fn set_connection_properties(
self,
input: Option<HashMap<ConnectionPropertyKey, String>>,
) -> Self
pub fn set_connection_properties( self, input: Option<HashMap<ConnectionPropertyKey, String>>, ) -> Self
These key-value pairs define parameters for the connection when using the version 1 Connection schema:
-
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 forUSER_NAME
is "USERNAME
". -
PASSWORD
- A password, if one is used, for the user name. -
ENCRYPTED_PASSWORD
- When you enable connection password protection by settingConnectionPasswordEncryption
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 isfalse
. 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 totrue
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 theSSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as thehostNameInCertificate
. -
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 Kerberoskeytab
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 Kerberoskrb5.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 withsasl.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. -
ROLE_ARN
- The role to be used for running queries. -
REGION
- The Amazon Web Services Region where queries will be run. -
WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run. -
CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run. -
DATABASE
- The Amazon Redshift database that you are connecting to.
Sourcepub fn get_connection_properties(
&self,
) -> &Option<HashMap<ConnectionPropertyKey, String>>
pub fn get_connection_properties( &self, ) -> &Option<HashMap<ConnectionPropertyKey, String>>
These key-value pairs define parameters for the connection when using the version 1 Connection schema:
-
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 forUSER_NAME
is "USERNAME
". -
PASSWORD
- A password, if one is used, for the user name. -
ENCRYPTED_PASSWORD
- When you enable connection password protection by settingConnectionPasswordEncryption
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 isfalse
. 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 totrue
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 theSSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as thehostNameInCertificate
. -
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 Kerberoskeytab
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 Kerberoskrb5.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 withsasl.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. -
ROLE_ARN
- The role to be used for running queries. -
REGION
- The Amazon Web Services Region where queries will be run. -
WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run. -
CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run. -
DATABASE
- The Amazon Redshift database that you are connecting to.
Sourcepub fn spark_properties(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn spark_properties( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to spark_properties
.
To override the contents of this collection use set_spark_properties
.
Connection properties specific to the Spark compute environment.
Sourcepub fn set_spark_properties(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_spark_properties( self, input: Option<HashMap<String, String>>, ) -> Self
Connection properties specific to the Spark compute environment.
Sourcepub fn get_spark_properties(&self) -> &Option<HashMap<String, String>>
pub fn get_spark_properties(&self) -> &Option<HashMap<String, String>>
Connection properties specific to the Spark compute environment.
Sourcepub fn athena_properties(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn athena_properties( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to athena_properties
.
To override the contents of this collection use set_athena_properties
.
Connection properties specific to the Athena compute environment.
Sourcepub fn set_athena_properties(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_athena_properties( self, input: Option<HashMap<String, String>>, ) -> Self
Connection properties specific to the Athena compute environment.
Sourcepub fn get_athena_properties(&self) -> &Option<HashMap<String, String>>
pub fn get_athena_properties(&self) -> &Option<HashMap<String, String>>
Connection properties specific to the Athena compute environment.
Sourcepub fn python_properties(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn python_properties( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to python_properties
.
To override the contents of this collection use set_python_properties
.
Connection properties specific to the Python compute environment.
Sourcepub fn set_python_properties(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_python_properties( self, input: Option<HashMap<String, String>>, ) -> Self
Connection properties specific to the Python compute environment.
Sourcepub fn get_python_properties(&self) -> &Option<HashMap<String, String>>
pub fn get_python_properties(&self) -> &Option<HashMap<String, String>>
Connection properties specific to the Python compute environment.
Sourcepub fn physical_connection_requirements(
self,
input: PhysicalConnectionRequirements,
) -> Self
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.
Sourcepub fn set_physical_connection_requirements(
self,
input: Option<PhysicalConnectionRequirements>,
) -> Self
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.
Sourcepub fn get_physical_connection_requirements(
&self,
) -> &Option<PhysicalConnectionRequirements>
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.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
The timestamp of the time that this connection definition was created.
Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
The timestamp of the time that this connection definition was created.
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
The timestamp of the time that this connection definition was created.
Sourcepub fn last_updated_time(self, input: DateTime) -> Self
pub fn last_updated_time(self, input: DateTime) -> Self
The timestamp of the last time the connection definition was updated.
Sourcepub fn set_last_updated_time(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_time(self, input: Option<DateTime>) -> Self
The timestamp of the last time the connection definition was updated.
Sourcepub fn get_last_updated_time(&self) -> &Option<DateTime>
pub fn get_last_updated_time(&self) -> &Option<DateTime>
The timestamp of the last time the connection definition was updated.
Sourcepub fn last_updated_by(self, input: impl Into<String>) -> Self
pub fn last_updated_by(self, input: impl Into<String>) -> Self
The user, group, or role that last updated this connection definition.
Sourcepub fn set_last_updated_by(self, input: Option<String>) -> Self
pub fn set_last_updated_by(self, input: Option<String>) -> Self
The user, group, or role that last updated this connection definition.
Sourcepub fn get_last_updated_by(&self) -> &Option<String>
pub fn get_last_updated_by(&self) -> &Option<String>
The user, group, or role that last updated this connection definition.
Sourcepub fn status(self, input: ConnectionStatus) -> Self
pub fn status(self, input: ConnectionStatus) -> Self
The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
Sourcepub fn set_status(self, input: Option<ConnectionStatus>) -> Self
pub fn set_status(self, input: Option<ConnectionStatus>) -> Self
The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
Sourcepub fn get_status(&self) -> &Option<ConnectionStatus>
pub fn get_status(&self) -> &Option<ConnectionStatus>
The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
Sourcepub fn status_reason(self, input: impl Into<String>) -> Self
pub fn status_reason(self, input: impl Into<String>) -> Self
The reason for the connection status.
Sourcepub fn set_status_reason(self, input: Option<String>) -> Self
pub fn set_status_reason(self, input: Option<String>) -> Self
The reason for the connection status.
Sourcepub fn get_status_reason(&self) -> &Option<String>
pub fn get_status_reason(&self) -> &Option<String>
The reason for the connection status.
Sourcepub fn last_connection_validation_time(self, input: DateTime) -> Self
pub fn last_connection_validation_time(self, input: DateTime) -> Self
A timestamp of the time this connection was last validated.
Sourcepub fn set_last_connection_validation_time(
self,
input: Option<DateTime>,
) -> Self
pub fn set_last_connection_validation_time( self, input: Option<DateTime>, ) -> Self
A timestamp of the time this connection was last validated.
Sourcepub fn get_last_connection_validation_time(&self) -> &Option<DateTime>
pub fn get_last_connection_validation_time(&self) -> &Option<DateTime>
A timestamp of the time this connection was last validated.
Sourcepub fn authentication_configuration(
self,
input: AuthenticationConfiguration,
) -> Self
pub fn authentication_configuration( self, input: AuthenticationConfiguration, ) -> Self
The authentication properties of the connection.
Sourcepub fn set_authentication_configuration(
self,
input: Option<AuthenticationConfiguration>,
) -> Self
pub fn set_authentication_configuration( self, input: Option<AuthenticationConfiguration>, ) -> Self
The authentication properties of the connection.
Sourcepub fn get_authentication_configuration(
&self,
) -> &Option<AuthenticationConfiguration>
pub fn get_authentication_configuration( &self, ) -> &Option<AuthenticationConfiguration>
The authentication properties of the connection.
Sourcepub fn connection_schema_version(self, input: i32) -> Self
pub fn connection_schema_version(self, input: i32) -> Self
The version of the connection schema for this connection. Version 2 supports properties for specific compute environments.
Sourcepub fn set_connection_schema_version(self, input: Option<i32>) -> Self
pub fn set_connection_schema_version(self, input: Option<i32>) -> Self
The version of the connection schema for this connection. Version 2 supports properties for specific compute environments.
Sourcepub fn get_connection_schema_version(&self) -> &Option<i32>
pub fn get_connection_schema_version(&self) -> &Option<i32>
The version of the connection schema for this connection. Version 2 supports properties for specific compute environments.
Sourcepub fn compatible_compute_environments(self, input: ComputeEnvironment) -> Self
pub fn compatible_compute_environments(self, input: ComputeEnvironment) -> Self
Appends an item to compatible_compute_environments
.
To override the contents of this collection use set_compatible_compute_environments
.
A list of compute environments compatible with the connection.
Sourcepub fn set_compatible_compute_environments(
self,
input: Option<Vec<ComputeEnvironment>>,
) -> Self
pub fn set_compatible_compute_environments( self, input: Option<Vec<ComputeEnvironment>>, ) -> Self
A list of compute environments compatible with the connection.
Sourcepub fn get_compatible_compute_environments(
&self,
) -> &Option<Vec<ComputeEnvironment>>
pub fn get_compatible_compute_environments( &self, ) -> &Option<Vec<ComputeEnvironment>>
A list of compute environments compatible with the connection.
Sourcepub fn build(self) -> Connection
pub fn build(self) -> Connection
Consumes the builder and constructs a Connection
.
Trait Implementations§
Source§impl Clone for ConnectionBuilder
impl Clone for ConnectionBuilder
Source§fn clone(&self) -> ConnectionBuilder
fn clone(&self) -> ConnectionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ConnectionBuilder
impl Debug for ConnectionBuilder
Source§impl Default for ConnectionBuilder
impl Default for ConnectionBuilder
Source§fn default() -> ConnectionBuilder
fn default() -> ConnectionBuilder
Source§impl PartialEq for ConnectionBuilder
impl PartialEq for ConnectionBuilder
impl StructuralPartialEq for ConnectionBuilder
Auto Trait Implementations§
impl Freeze for ConnectionBuilder
impl RefUnwindSafe for ConnectionBuilder
impl Send for ConnectionBuilder
impl Sync for ConnectionBuilder
impl Unpin for ConnectionBuilder
impl UnwindSafe for ConnectionBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);