EndpointS3SettingsArgs

data class EndpointS3SettingsArgs(val addColumnName: Output<Boolean>? = null, val bucketFolder: Output<String>? = null, val bucketName: Output<String>? = null, val cannedAclForObjects: Output<String>? = null, val cdcInsertsAndUpdates: Output<Boolean>? = null, val cdcInsertsOnly: Output<Boolean>? = null, val cdcMaxBatchInterval: Output<Int>? = null, val cdcMinFileSize: Output<Int>? = null, val cdcPath: Output<String>? = null, val compressionType: Output<String>? = null, val csvDelimiter: Output<String>? = null, val csvNoSupValue: Output<String>? = null, val csvNullValue: Output<String>? = null, val csvRowDelimiter: Output<String>? = null, val dataFormat: Output<String>? = null, val dataPageSize: Output<Int>? = null, val datePartitionDelimiter: Output<String>? = null, val datePartitionEnabled: Output<Boolean>? = null, val datePartitionSequence: Output<String>? = null, val dictPageSizeLimit: Output<Int>? = null, val enableStatistics: Output<Boolean>? = null, val encodingType: Output<String>? = null, val encryptionMode: Output<String>? = null, val externalTableDefinition: Output<String>? = null, val ignoreHeaderRows: Output<Int>? = null, val ignoreHeadersRow: Output<Int>? = null, val includeOpForFullLoad: Output<Boolean>? = null, val maxFileSize: Output<Int>? = null, val parquetTimestampInMillisecond: Output<Boolean>? = null, val parquetVersion: Output<String>? = null, val preserveTransactions: Output<Boolean>? = null, val rfc4180: Output<Boolean>? = null, val rowGroupLength: Output<Int>? = null, val serverSideEncryptionKmsKeyId: Output<String>? = null, val serviceAccessRoleArn: Output<String>? = null, val timestampColumnName: Output<String>? = null, val useCsvNoSupValue: Output<Boolean>? = null, val useTaskStartTimeForFullLoadTimestamp: Output<Boolean>? = null) : ConvertibleToJava<EndpointS3SettingsArgs>

Constructors

Link copied to clipboard
constructor(addColumnName: Output<Boolean>? = null, bucketFolder: Output<String>? = null, bucketName: Output<String>? = null, cannedAclForObjects: Output<String>? = null, cdcInsertsAndUpdates: Output<Boolean>? = null, cdcInsertsOnly: Output<Boolean>? = null, cdcMaxBatchInterval: Output<Int>? = null, cdcMinFileSize: Output<Int>? = null, cdcPath: Output<String>? = null, compressionType: Output<String>? = null, csvDelimiter: Output<String>? = null, csvNoSupValue: Output<String>? = null, csvNullValue: Output<String>? = null, csvRowDelimiter: Output<String>? = null, dataFormat: Output<String>? = null, dataPageSize: Output<Int>? = null, datePartitionDelimiter: Output<String>? = null, datePartitionEnabled: Output<Boolean>? = null, datePartitionSequence: Output<String>? = null, dictPageSizeLimit: Output<Int>? = null, enableStatistics: Output<Boolean>? = null, encodingType: Output<String>? = null, encryptionMode: Output<String>? = null, externalTableDefinition: Output<String>? = null, ignoreHeaderRows: Output<Int>? = null, ignoreHeadersRow: Output<Int>? = null, includeOpForFullLoad: Output<Boolean>? = null, maxFileSize: Output<Int>? = null, parquetTimestampInMillisecond: Output<Boolean>? = null, parquetVersion: Output<String>? = null, preserveTransactions: Output<Boolean>? = null, rfc4180: Output<Boolean>? = null, rowGroupLength: Output<Int>? = null, serverSideEncryptionKmsKeyId: Output<String>? = null, serviceAccessRoleArn: Output<String>? = null, timestampColumnName: Output<String>? = null, useCsvNoSupValue: Output<Boolean>? = null, useTaskStartTimeForFullLoadTimestamp: Output<Boolean>? = null)

Properties

Link copied to clipboard
val addColumnName: Output<Boolean>? = null

Whether to add column name information to the .csv output file. Default is false.

Link copied to clipboard
val bucketFolder: Output<String>? = null

Custom S3 Bucket Object prefix for intermediate storage.

Link copied to clipboard
val bucketName: Output<String>? = null

Custom S3 Bucket name for intermediate storage.

Link copied to clipboard
val cannedAclForObjects: Output<String>? = null

Predefined (canned) access control list for objects created in an S3 bucket. Valid values include none, private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, and bucket-owner-full-control. Default is none.

Link copied to clipboard
val cdcInsertsAndUpdates: Output<Boolean>? = null

Whether to write insert and update operations to .csv or .parquet output files. Default is false.

Link copied to clipboard
val cdcInsertsOnly: Output<Boolean>? = null

Whether to write insert operations to .csv or .parquet output files. Default is false.

Link copied to clipboard
val cdcMaxBatchInterval: Output<Int>? = null

Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. Default is 60.

Link copied to clipboard
val cdcMinFileSize: Output<Int>? = null

Minimum file size condition as defined in kilobytes to output a file to Amazon S3. Default is 32000. NOTE: Previously, this setting was measured in megabytes but now represents kilobytes. Update configurations accordingly.

Link copied to clipboard
val cdcPath: Output<String>? = null

Folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If cdc_path is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. Supported in AWS DMS versions 3.4.2 and later.

Link copied to clipboard
val compressionType: Output<String>? = null

Set to compress target files. Default is NONE. Valid values are GZIP and NONE.

Link copied to clipboard
val csvDelimiter: Output<String>? = null

Delimiter used to separate columns in the source files. Default is ,.

Link copied to clipboard
val csvNoSupValue: Output<String>? = null

String to use for all columns not included in the supplemental log.

Link copied to clipboard
val csvNullValue: Output<String>? = null

String to as null when writing to the target.

Link copied to clipboard
val csvRowDelimiter: Output<String>? = null

Delimiter used to separate rows in the source files. Default is \n.

Link copied to clipboard
val dataFormat: Output<String>? = null

Output format for the files that AWS DMS uses to create S3 objects. Valid values are csv and parquet. Default is csv.

Link copied to clipboard
val dataPageSize: Output<Int>? = null

Size of one data page in bytes. Default is 1048576 (1 MiB).

Link copied to clipboard
val datePartitionDelimiter: Output<String>? = null

Date separating delimiter to use during folder partitioning. Valid values are SLASH, UNDERSCORE, DASH, and NONE. Default is SLASH.

Link copied to clipboard
val datePartitionEnabled: Output<Boolean>? = null

Partition S3 bucket folders based on transaction commit dates. Default is false.

Link copied to clipboard
val datePartitionSequence: Output<String>? = null

Date format to use during folder partitioning. Use this parameter when date_partition_enabled is set to true. Valid values are YYYYMMDD, YYYYMMDDHH, YYYYMM, MMYYYYDD, and DDMMYYYY. Default is YYYYMMDD.

Link copied to clipboard
val dictPageSizeLimit: Output<Int>? = null

Maximum size in bytes of an encoded dictionary page of a column. Default is 1048576 (1 MiB).

Link copied to clipboard
val enableStatistics: Output<Boolean>? = null

Whether to enable statistics for Parquet pages and row groups. Default is true.

Link copied to clipboard
val encodingType: Output<String>? = null

Type of encoding to use. Value values are rle_dictionary, plain, and plain_dictionary. Default is rle_dictionary.

Link copied to clipboard
val encryptionMode: Output<String>? = null

The server-side encryption mode that you want to encrypt your intermediate .csv object files copied to S3. Defaults to SSE_S3. Valid values are SSE_S3 and SSE_KMS.

Link copied to clipboard
val externalTableDefinition: Output<String>? = null

JSON document that describes how AWS DMS should interpret the data.

Link copied to clipboard
val ignoreHeaderRows: Output<Int>? = null

When this value is set to 1, DMS ignores the first row header in a .csv file. Default is 0.

Link copied to clipboard
val ignoreHeadersRow: Output<Int>? = null

Deprecated. This setting has no effect. Will be removed in a future version.

Link copied to clipboard
val includeOpForFullLoad: Output<Boolean>? = null

Whether to enable a full load to write INSERT operations to the .csv output files only to indicate how the rows were added to the source database. Default is false.

Link copied to clipboard
val maxFileSize: Output<Int>? = null

Maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. Valid values are from 1 to 1048576. Default is 1048576 (1 GB).

Link copied to clipboard

Specifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default is false.

Link copied to clipboard
val parquetVersion: Output<String>? = null

Version of the .parquet file format. Default is parquet-1-0. Valid values are parquet-1-0 and parquet-2-0.

Link copied to clipboard
val preserveTransactions: Output<Boolean>? = null

Whether DMS saves the transaction order for a CDC load on the S3 target specified by cdc_path. Default is false.

Link copied to clipboard
val rfc4180: Output<Boolean>? = null

For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default is true.

Link copied to clipboard
val rowGroupLength: Output<Int>? = null

Number of rows in a row group. Default is 10000.

Link copied to clipboard

ARN or Id of KMS Key to use when encryption_mode is SSE_KMS.

Link copied to clipboard
val serviceAccessRoleArn: Output<String>? = null

ARN of the IAM Role with permissions to write to the OpenSearch cluster.

Link copied to clipboard
val timestampColumnName: Output<String>? = null

Column to add with timestamp information to the endpoint data for an Amazon S3 target.

Link copied to clipboard
val useCsvNoSupValue: Output<Boolean>? = null

Whether to use csv_no_sup_value for columns not included in the supplemental log.

Link copied to clipboard

When set to true, uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when set to true, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time. When set to false, the full load timestamp in the timestamp column increments with the time data arrives at the target. Default is false.

Functions

Link copied to clipboard
open override fun toJava(): EndpointS3SettingsArgs