#[non_exhaustive]pub struct KafkaSettings {Show 21 fields
pub broker: Option<String>,
pub topic: Option<String>,
pub message_format: Option<MessageFormatValue>,
pub include_transaction_details: Option<bool>,
pub include_partition_value: Option<bool>,
pub partition_include_schema_table: Option<bool>,
pub include_table_alter_operations: Option<bool>,
pub include_control_details: Option<bool>,
pub message_max_bytes: Option<i32>,
pub include_null_and_empty: Option<bool>,
pub security_protocol: Option<KafkaSecurityProtocol>,
pub ssl_client_certificate_arn: Option<String>,
pub ssl_client_key_arn: Option<String>,
pub ssl_client_key_password: Option<String>,
pub ssl_ca_certificate_arn: Option<String>,
pub sasl_username: Option<String>,
pub sasl_password: Option<String>,
pub no_hex_prefix: Option<bool>,
pub sasl_mechanism: Option<KafkaSaslMechanism>,
pub ssl_endpoint_identification_algorithm: Option<KafkaSslEndpointIdentificationAlgorithm>,
pub use_large_integer_value: Option<bool>,
}Expand description
Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.broker: 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.
topic: 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.
message_format: 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).
include_transaction_details: 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.
include_partition_value: Option<bool>Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
partition_include_schema_table: 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.
include_table_alter_operations: 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.
include_control_details: 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.
message_max_bytes: Option<i32>The maximum size in bytes for records created on the endpoint The default is 1,000,000.
include_null_and_empty: Option<bool>Include NULL and empty columns for records migrated to the endpoint. The default is false.
security_protocol: 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.
ssl_client_certificate_arn: Option<String>The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
ssl_client_key_arn: Option<String>The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
ssl_client_key_password: Option<String>The password for the client private key used to securely connect to a Kafka target endpoint.
ssl_ca_certificate_arn: 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.
sasl_username: 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.
sasl_password: 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.
no_hex_prefix: 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.
sasl_mechanism: 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.
ssl_endpoint_identification_algorithm: Option<KafkaSslEndpointIdentificationAlgorithm>Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
use_large_integer_value: Option<bool>Specifies using the large integer value with Kafka.
Implementations§
Source§impl KafkaSettings
impl KafkaSettings
Sourcepub fn broker(&self) -> Option<&str>
pub fn broker(&self) -> Option<&str>
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.
Sourcepub fn topic(&self) -> Option<&str>
pub fn topic(&self) -> Option<&str>
The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.
Sourcepub fn message_format(&self) -> Option<&MessageFormatValue>
pub fn 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).
Sourcepub fn include_transaction_details(&self) -> Option<bool>
pub fn 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.
Sourcepub fn include_partition_value(&self) -> Option<bool>
pub fn 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.
Sourcepub fn partition_include_schema_table(&self) -> Option<bool>
pub fn 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.
Sourcepub fn include_table_alter_operations(&self) -> Option<bool>
pub fn 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.
Sourcepub fn include_control_details(&self) -> Option<bool>
pub fn 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.
Sourcepub fn message_max_bytes(&self) -> Option<i32>
pub fn message_max_bytes(&self) -> Option<i32>
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
Sourcepub fn include_null_and_empty(&self) -> Option<bool>
pub fn include_null_and_empty(&self) -> Option<bool>
Include NULL and empty columns for records migrated to the endpoint. The default is false.
Sourcepub fn security_protocol(&self) -> Option<&KafkaSecurityProtocol>
pub fn 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.
Sourcepub fn ssl_client_certificate_arn(&self) -> Option<&str>
pub fn ssl_client_certificate_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
Sourcepub fn ssl_client_key_arn(&self) -> Option<&str>
pub fn ssl_client_key_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
Sourcepub fn ssl_client_key_password(&self) -> Option<&str>
pub fn ssl_client_key_password(&self) -> Option<&str>
The password for the client private key used to securely connect to a Kafka target endpoint.
Sourcepub fn ssl_ca_certificate_arn(&self) -> Option<&str>
pub fn ssl_ca_certificate_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
Sourcepub fn sasl_username(&self) -> Option<&str>
pub fn sasl_username(&self) -> Option<&str>
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.
Sourcepub fn sasl_password(&self) -> Option<&str>
pub fn sasl_password(&self) -> Option<&str>
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.
Sourcepub fn no_hex_prefix(&self) -> Option<bool>
pub fn 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.
Sourcepub fn sasl_mechanism(&self) -> Option<&KafkaSaslMechanism>
pub fn 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.
Sourcepub fn ssl_endpoint_identification_algorithm(
&self,
) -> Option<&KafkaSslEndpointIdentificationAlgorithm>
pub fn 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.
Sourcepub fn use_large_integer_value(&self) -> Option<bool>
pub fn use_large_integer_value(&self) -> Option<bool>
Specifies using the large integer value with Kafka.
Source§impl KafkaSettings
impl KafkaSettings
Sourcepub fn builder() -> KafkaSettingsBuilder
pub fn builder() -> KafkaSettingsBuilder
Creates a new builder-style object to manufacture KafkaSettings.
Trait Implementations§
Source§impl Clone for KafkaSettings
impl Clone for KafkaSettings
Source§fn clone(&self) -> KafkaSettings
fn clone(&self) -> KafkaSettings
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for KafkaSettings
impl Debug for KafkaSettings
Source§impl PartialEq for KafkaSettings
impl PartialEq for KafkaSettings
impl StructuralPartialEq for KafkaSettings
Auto Trait Implementations§
impl Freeze for KafkaSettings
impl RefUnwindSafe for KafkaSettings
impl Send for KafkaSettings
impl Sync for KafkaSettings
impl Unpin for KafkaSettings
impl UnwindSafe for KafkaSettings
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>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());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>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());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>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());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>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());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>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());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>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());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);