Struct aws_sdk_databasemigration::types::builders::KinesisSettingsBuilder

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

A builder for KinesisSettings.

Implementations

impl KinesisSettingsBuilder

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

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

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

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

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

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

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 service_access_role_arn(self, input: impl Into<String>) -> Self

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 set_service_access_role_arn(self, input: Option<String>) -> Self

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 get_service_access_role_arn(&self) -> &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.

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

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

pub fn build(self) -> KinesisSettings

Consumes the builder and constructs a KinesisSettings.

Trait Implementations

impl Clone for KinesisSettingsBuilder

fn clone(&self) -> KinesisSettingsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KinesisSettingsBuilder

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

Formats the value using the given formatter.

impl Default for KinesisSettingsBuilder

fn default() -> KinesisSettingsBuilder

Returns the “default value” for a type.

impl PartialEq for KinesisSettingsBuilder

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