Struct KinesisSettings

#[non_exhaustive]
pub struct KinesisSettings {
    pub stream_arn: Option<String>,
    pub message_format: Option<MessageFormatValue>,
    pub service_access_role_arn: Option<String>,
    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 include_null_and_empty: Option<bool>,
    pub no_hex_prefix: Option<bool>,
    pub use_large_integer_value: Option<bool>,
}

Provides information that describes an Amazon Kinesis Data Stream 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)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_arn: Option<String>

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

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

service_access_role_arn: Option<String>

The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.

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 Kinesis 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 Kinesis shards. 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 shard, 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 Kinesis message output. The default is false.

include_null_and_empty: Option<bool>

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

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 an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

use_large_integer_value: Option<bool>

Specifies using the large integer value with Kinesis.

Implementations

impl KinesisSettings

pub fn stream_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

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

pub fn service_access_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.

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.

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

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

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 Kinesis shards. 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 shard, which causes throttling. The default is false.

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.

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

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

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

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

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 an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

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

Specifies using the large integer value with Kinesis.

impl KinesisSettings

pub fn builder() -> KinesisSettingsBuilder

Creates a new builder-style object to manufacture KinesisSettings.

Trait Implementations

impl Clone for KinesisSettings

fn clone(&self) -> KinesisSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KinesisSettings

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

Formats the value using the given formatter.

impl PartialEq for KinesisSettings

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for KinesisSettings