# Generated by default/object.tt package Paws::DMS::S3Settings; use Moose; has BucketFolder => (is => 'ro', isa => 'Str'); has BucketName => (is => 'ro', isa => 'Str'); has CdcInsertsAndUpdates => (is => 'ro', isa => 'Bool'); has CdcInsertsOnly => (is => 'ro', isa => 'Bool'); has CdcPath => (is => 'ro', isa => 'Str'); has CompressionType => (is => 'ro', isa => 'Str'); has CsvDelimiter => (is => 'ro', isa => 'Str'); has CsvNoSupValue => (is => 'ro', isa => 'Str'); has CsvRowDelimiter => (is => 'ro', isa => 'Str'); has DataFormat => (is => 'ro', isa => 'Str'); has DataPageSize => (is => 'ro', isa => 'Int'); has DatePartitionDelimiter => (is => 'ro', isa => 'Str'); has DatePartitionEnabled => (is => 'ro', isa => 'Bool'); has DatePartitionSequence => (is => 'ro', isa => 'Str'); has DictPageSizeLimit => (is => 'ro', isa => 'Int'); has EnableStatistics => (is => 'ro', isa => 'Bool'); has EncodingType => (is => 'ro', isa => 'Str'); has EncryptionMode => (is => 'ro', isa => 'Str'); has ExternalTableDefinition => (is => 'ro', isa => 'Str'); has IncludeOpForFullLoad => (is => 'ro', isa => 'Bool'); has ParquetTimestampInMillisecond => (is => 'ro', isa => 'Bool'); has ParquetVersion => (is => 'ro', isa => 'Str'); has PreserveTransactions => (is => 'ro', isa => 'Bool'); has RowGroupLength => (is => 'ro', isa => 'Int'); has ServerSideEncryptionKmsKeyId => (is => 'ro', isa => 'Str'); has ServiceAccessRoleArn => (is => 'ro', isa => 'Str'); has TimestampColumnName => (is => 'ro', isa => 'Str'); has UseCsvNoSupValue => (is => 'ro', isa => 'Bool'); 1; ### main pod documentation begin ### =head1 NAME Paws::DMS::S3Settings =head1 USAGE This class represents one of two things: =head3 Arguments in a call to a service Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object. As an example, if Att1 is expected to be a Paws::DMS::S3Settings object: $service_obj->Method(Att1 => { BucketFolder => $value, ..., UseCsvNoSupValue => $value }); =head3 Results returned from an API call Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::S3Settings object: $result = $service_obj->Method(...); $result->Att1->BucketFolder =head1 DESCRIPTION Settings for exporting data to Amazon S3. =head1 ATTRIBUTES =head2 BucketFolder => Str An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path C< I/I/I/>. If this parameter isn't specified, then the path used is C< I/I/>. =head2 BucketName => Str The name of the S3 bucket. =head2 CdcInsertsAndUpdates => Bool A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is C, but when C is set to C or C, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file. For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the C parameter. If C is set to C, the first field of every CDC record is set to either C or C to indicate INSERT and UPDATE operations at the source. But if C is set to C, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the I. AWS DMS supports the use of the C parameter in versions 3.3.1 and later. C and C can't both be set to C for the same endpoint. Set either C or C to C for the same endpoint, but not both. =head2 CdcInsertsOnly => Bool A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the C setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target. If C is set to C or C, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of C. If C is set to C, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If C is set to C, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the I. AWS DMS supports the interaction described preceding between the C and C parameters in versions 3.1.4 and later. C and C can't both be set to C for the same endpoint. Set either C or C to C for the same endpoint, but not both. =head2 CdcPath => Str Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If C is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set C (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to C, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by C (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and C (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName). For example, if you specify C as C, and you specify C as C but do not specify C, AWS DMS creates the CDC folder path following: C. If you specify the same C, and you specify C as C and C as C, AWS DMS creates the CDC folder path following: C. For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath). This setting is supported in AWS DMS versions 3.4.2 and later. =head2 CompressionType => Str An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats. =head2 CsvDelimiter => Str The delimiter used to separate columns in the .csv file for both source and target. The default is a comma. =head2 CsvNoSupValue => Str This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If C (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the C setting. This setting is supported in AWS DMS versions 3.4.1 and later. =head2 CsvRowDelimiter => Str The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (C<\n>). =head2 DataFormat => Str The format of the data that you want to use for output. You can choose one of the following: =over =item * C : This is a row-based file format with comma-separated values (.csv). =item * C : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response. =back =head2 DataPageSize => Int The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only. =head2 DatePartitionDelimiter => Str Specifies a date separating delimiter to use during folder partitioning. The default value is C. Use this parameter when C is set to C. =head2 DatePartitionEnabled => Bool When set to C, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is C. For more information about date-based folder partitoning, see Using date-based folder partitioning (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning). =head2 DatePartitionSequence => Str Identifies the sequence of the date format to use during folder partitioning. The default value is C. Use this parameter when C is set to C. =head2 DictPageSizeLimit => Int The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of C. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to C encoding. This size is used for .parquet file format only. =head2 EnableStatistics => Bool A value that enables statistics for Parquet pages and row groups. Choose C to enable statistics, C to disable. Statistics include C, C, C, and C values. This parameter defaults to C. This value is used for .parquet file format only. =head2 EncodingType => Str The type of encoding you are using: =over =item * C uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default. =item * C doesn't use encoding at all. Values are stored as they are. =item * C builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk. =back =head2 EncryptionMode => Str The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either C (the default) or C. For the C operation, you can change the existing value of the C parameter from C to C. But you canEt change the existing value from C to C. To use C, you need an AWS Identity and Access Management (IAM) role with permission to allow C<"arn:aws:s3:::dms-*"> to use the following actions: =over =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =back =head2 ExternalTableDefinition => Str Specifies how tables are defined in the S3 source files only. =head2 IncludeOpForFullLoad => Bool A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database. AWS DMS supports the C parameter in versions 3.1.4 and later. For full load, records can only be inserted. By default (the C setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If C is set to C or C, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load. This setting works together with the C and the C parameters for output to .csv files only. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the I. =head2 ParquetTimestampInMillisecond => Bool A value that specifies the precision of any C column values that are written to an Amazon S3 object file in .parquet format. AWS DMS supports the C parameter in versions 3.1.4 and later. When C is set to C or C, AWS DMS writes all C columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision. Currently, Amazon Athena and AWS Glue can handle only millisecond precision for C values. Set this parameter to C for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue. AWS DMS writes any C column values written to an S3 file in .csv format with microsecond precision. Setting C has no effect on the string format of the timestamp column value that is inserted by setting the C parameter. =head2 ParquetVersion => Str The version of the Apache Parquet format that you want to use: C (the default) or C. =head2 PreserveTransactions => Bool If set to C, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by C (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath). For more information, see Capturing data changes (CDC) including transaction order on the S3 target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath). This setting is supported in AWS DMS versions 3.4.2 and later. =head2 RowGroupLength => Int The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only. If you choose a value larger than the maximum, C is set to the max row group length in bytes (64 * 1024 * 1024). =head2 ServerSideEncryptionKmsKeyId => Str If you are using C for the C, provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key. Here is a CLI example: C --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=I,BucketFolder=I,BucketName=I,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=I> =head2 ServiceAccessRoleArn => Str The Amazon Resource Name (ARN) used by the service access IAM role. It is a required parameter that enables DMS to write and read objects from an S3 bucket. =head2 TimestampColumnName => Str A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target. AWS DMS supports the C parameter in versions 3.1.4 and later. DMS includes an additional C column in the .csv or .parquet object files of your migrated data when you set C to a nonblank value. For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database. The string format for this timestamp column value is C. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database. When the C parameter is set to C, DMS also includes a name for the timestamp column that you set with C. =head2 UseCsvNoSupValue => Bool This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to C for columns not included in the supplemental log, AWS DMS uses the value specified by C (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue). If not set or set to C, AWS DMS uses the null value for these columns. This setting is supported in AWS DMS versions 3.4.1 and later. =head1 SEE ALSO This class forms part of L, describing an object used in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut