Struct aws_sdk_databasemigration::types::builders::KafkaSettingsBuilder

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

A builder for KafkaSettings.

Implementations

impl KafkaSettingsBuilder

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

A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.

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

A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.

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

A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.

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

The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.

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

The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.

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

The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.

pub fn message_format(self, input: MessageFormatValue) -> Self

The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

pub fn set_message_format(self, input: Option<MessageFormatValue>) -> Self

The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

pub fn get_message_format(&self) -> &Option<MessageFormatValue>

The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

pub fn include_transaction_details(self, input: bool) -> Self

Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.

pub fn set_include_transaction_details(self, input: Option<bool>) -> Self

Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.

pub fn get_include_transaction_details(&self) -> &Option<bool>

Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.

pub fn include_partition_value(self, input: bool) -> Self

Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.

pub fn set_include_partition_value(self, input: Option<bool>) -> Self

Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.

pub fn get_include_partition_value(&self) -> &Option<bool>

Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.

pub fn partition_include_schema_table(self, input: bool) -> Self

Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false.

pub fn set_partition_include_schema_table(self, input: Option<bool>) -> Self

Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false.

pub fn get_partition_include_schema_table(&self) -> &Option<bool>

Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false.

pub fn include_table_alter_operations(self, input: bool) -> Self

Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.

pub fn set_include_table_alter_operations(self, input: Option<bool>) -> Self

Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.

pub fn get_include_table_alter_operations(&self) -> &Option<bool>

Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.

pub fn include_control_details(self, input: bool) -> Self

Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.

pub fn set_include_control_details(self, input: Option<bool>) -> Self

Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.

pub fn get_include_control_details(&self) -> &Option<bool>

Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.

pub fn message_max_bytes(self, input: i32) -> Self

The maximum size in bytes for records created on the endpoint The default is 1,000,000.

pub fn set_message_max_bytes(self, input: Option<i32>) -> Self

The maximum size in bytes for records created on the endpoint The default is 1,000,000.

pub fn get_message_max_bytes(&self) -> &Option<i32>

The maximum size in bytes for records created on the endpoint The default is 1,000,000.

pub fn include_null_and_empty(self, input: bool) -> Self

Include NULL and empty columns for records migrated to the endpoint. The default is false.

pub fn set_include_null_and_empty(self, input: Option<bool>) -> Self

Include NULL and empty columns for records migrated to the endpoint. The default is false.

pub fn get_include_null_and_empty(&self) -> &Option<bool>

Include NULL and empty columns for records migrated to the endpoint. The default is false.

pub fn security_protocol(self, input: KafkaSecurityProtocol) -> Self

Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.

pub fn set_security_protocol(self, input: Option<KafkaSecurityProtocol>) -> Self

Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.

pub fn get_security_protocol(&self) -> &Option<KafkaSecurityProtocol>

Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.

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

The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.

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

The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.

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

The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.

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

The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.

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

The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.

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

The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.

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

The password for the client private key used to securely connect to a Kafka target endpoint.

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

The password for the client private key used to securely connect to a Kafka target endpoint.

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

The password for the client private key used to securely connect to a Kafka target endpoint.

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

The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.

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

The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.

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

The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.

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

The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

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

The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

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

The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

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

The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

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

The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

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

The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

pub fn no_hex_prefix(self, input: bool) -> Self

Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

pub fn set_no_hex_prefix(self, input: Option<bool>) -> Self

Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

pub fn get_no_hex_prefix(&self) -> &Option<bool>

Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

pub fn sasl_mechanism(self, input: KafkaSaslMechanism) -> Self

For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.

pub fn set_sasl_mechanism(self, input: Option<KafkaSaslMechanism>) -> Self

For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.

pub fn get_sasl_mechanism(&self) -> &Option<KafkaSaslMechanism>

For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.

pub fn ssl_endpoint_identification_algorithm( self, input: KafkaSslEndpointIdentificationAlgorithm ) -> Self

Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.

pub fn set_ssl_endpoint_identification_algorithm( self, input: Option<KafkaSslEndpointIdentificationAlgorithm> ) -> Self

Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.

pub fn get_ssl_endpoint_identification_algorithm( &self ) -> &Option<KafkaSslEndpointIdentificationAlgorithm>

Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.

pub fn build(self) -> KafkaSettings

Consumes the builder and constructs a KafkaSettings.

Trait Implementations

impl Clone for KafkaSettingsBuilder

fn clone(&self) -> KafkaSettingsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KafkaSettingsBuilder

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

Formats the value using the given formatter.

impl Default for KafkaSettingsBuilder

fn default() -> KafkaSettingsBuilder

Returns the “default value” for a type.

impl PartialEq for KafkaSettingsBuilder

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