Class: Aws::DatabaseMigrationService::Types::KinesisSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass KinesisSettings data as a hash:

{
  stream_arn: "String",
  message_format: "json", # accepts json, json-unformatted
  service_access_role_arn: "String",
  include_transaction_details: false,
  include_partition_value: false,
  partition_include_schema_table: false,
  include_table_alter_operations: false,
  include_control_details: false,
  include_null_and_empty: false,
  no_hex_prefix: false,
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#include_control_detailsBoolean

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

Returns:

  • (Boolean)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#include_null_and_emptyBoolean

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

Returns:

  • (Boolean)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#include_partition_valueBoolean

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

Returns:

  • (Boolean)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#include_table_alter_operationsBoolean

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.

Returns:

  • (Boolean)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#include_transaction_detailsBoolean

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.

Returns:

  • (Boolean)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#message_formatString

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

Returns:

  • (String)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#no_hex_prefixBoolean

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.

Returns:

  • (Boolean)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#partition_include_schema_tableBoolean

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.

Returns:

  • (Boolean)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_role_arnString

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.

Returns:

  • (String)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arnString

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

Returns:

  • (String)


4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4443

class KinesisSettings < Struct.new(
  :stream_arn,
  :message_format,
  :service_access_role_arn,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :include_null_and_empty,
  :no_hex_prefix)
  SENSITIVE = []
  include Aws::Structure
end