import { Value } from '../../../cloudformation/Value';
/**
  Provides information that defines an Amazon S3 endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring"> Extra connection attributes when using Amazon S3 as a source for AWS DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring"> Extra connection attributes when using Amazon S3 as a target for AWS DMS</a> in the<em>AWS Database Migration Service User Guide</em>.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html">the AWS Docs</a>
*/
export interface S3SettingsProps {
    /** <code>TimestampColumnName</code>  <a name="cfn-dms-endpoint-s3settings-timestampcolumnname"></a>
  A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.<br />
  AWS DMS supports the <code>TimestampColumnName</code> parameter in versions 3.1.4 and later.
  AWS DMS includes an additional <code>STRING</code> column in the .csv or .parquet object files of your migrated data when you set <code>TimestampColumnName</code> to a nonblank value.<br />
  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.<br />
  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.<br />
  The string format for this timestamp column value is <code>yyyy-MM-dd HH:mm:ss.SSSSSS</code>. 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.<br />
  When the <code>AddColumnName</code> parameter is set to <code>true</code>, DMS also includes a name for the timestamp column that you set with <code>TimestampColumnName</code>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    timestampColumnName?: Value<string>;
    /** <code>EnableStatistics</code>  <a name="cfn-dms-endpoint-s3settings-enablestatistics"></a>
  A value that enables statistics for Parquet pages and row groups. Choose <code>true</code> to enable statistics, <code>false</code> to disable. Statistics include <code>NULL</code>, <code>DISTINCT</code>, <code>MAX</code>, and <code>MIN</code> values. This parameter defaults to <code>true</code>. This value is used for .parquet file format only.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    enableStatistics?: Value<boolean>;
    /** <code>DatePartitionSequence</code>  <a name="cfn-dms-endpoint-s3settings-datepartitionsequence"></a>
  Identifies the sequence of the date format to use during folder partitioning. The default value is <code>YYYYMMDD</code>. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>.<br />
  
  Required: No<br />
  
  Allowed values: <code>DDMMYYYY | MMYYYYDD | YYYYMM | YYYYMMDD | YYYYMMDDHH</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    datePartitionSequence?: Value<'DDMMYYYY' | 'MMYYYYDD' | 'YYYYMM' | 'YYYYMMDD' | 'YYYYMMDDHH'>;
    /** <code>IncludeOpForFullLoad</code>  <a name="cfn-dms-endpoint-s3settings-includeopforfullload"></a>
  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.<br />
  AWS DMS supports the <code>IncludeOpForFullLoad</code> parameter in versions 3.1.4 and later.
  For full load, records can only be inserted. By default (the <code>false</code> 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 <code>IncludeOpForFullLoad</code> is set to <code>true</code> or <code>y</code>, 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.<br />
  This setting works together with the <code>CdcInsertsOnly</code> and the <code>CdcInsertsAndUpdates</code> parameters for output to .csv files only. For more information about how these settings work together, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps"> Indicating Source DB Operations in Migrated S3 Data</a> in the
  AWS Database Migration Service User Guide:
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    includeOpForFullLoad?: Value<boolean>;
    /** <code>CsvNullValue</code>  <a name="cfn-dms-endpoint-s3settings-csvnullvalue"></a>
  An optional parameter that specifies how AWS DMS treats null values. While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string (”” or ‘’), AWS DMS treats the empty string as the null value instead of <code>NULL</code>.<br />
  The default value is <code>NULL</code>. Valid values include any valid string.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    csvNullValue?: Value<string>;
    /** <code>CdcInsertsAndUpdates</code>  <a name="cfn-dms-endpoint-s3settings-cdcinsertsandupdates"></a>
  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 <code>false</code>, but when <code>CdcInsertsAndUpdates</code> is set to <code>true</code> or <code>y</code>, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.<br />
  For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the <code>IncludeOpForFullLoad</code> parameter. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to either <code>I</code> or <code>U</code> to indicate INSERT and UPDATE operations at the source. But if <code>IncludeOpForFullLoad</code> is set to <code>false</code>, 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 <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps"> Indicating Source DB Operations in Migrated S3 Data</a> in the
  AWS Database Migration Service User Guide: br />
  AWS DMS supports the use of the <code>CdcInsertsAndUpdates</code> parameter in versions 3.3.1 and later.<br />
  <code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can’t both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    cdcInsertsAndUpdates?: Value<boolean>;
    /** <code>BucketName</code>  <a name="cfn-dms-endpoint-s3settings-bucketname"></a>
  The name of the S3 bucket.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    bucketName?: Value<string>;
    /** <code>ServerSideEncryptionKmsKeyId</code>  <a name="cfn-dms-endpoint-s3settings-serversideencryptionkmskeyid"></a>
  If you are using <code>SSE_KMS</code> for the <code>EncryptionMode</code>, provide the AWS KMS key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.<br />
  Here is a CLI example: <code>aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value </code><br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    serverSideEncryptionKmsKeyId?: Value<string>;
    /** <code>UseTaskStartTimeForFullLoadTimestamp</code>  <a name="cfn-dms-endpoint-s3settings-usetaskstarttimeforfullloadtimestamp"></a>
  When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when <code>useTaskStartTimeForFullLoadTimestamp</code> is set to <code>true</code>, 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.<br />
  When <code>useTaskStartTimeForFullLoadTimestamp</code> is set to <code>false</code>, the full load timestamp in the timestamp column increments with the time data arrives at the target.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    useTaskStartTimeForFullLoadTimestamp?: Value<boolean>;
    /** <p> */
    dataFormat?: Value<string>;
    /** <code>CsvDelimiter</code>  <a name="cfn-dms-endpoint-s3settings-csvdelimiter"></a>
  The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    csvDelimiter?: Value<string>;
    /** <code>IgnoreHeaderRows</code>  <a name="cfn-dms-endpoint-s3settings-ignoreheaderrows"></a>
  When this value is set to 1, AWS DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.<br />
  The default is 0.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    ignoreHeaderRows?: Value<number>;
    /** <code>CannedAclForObjects</code>  <a name="cfn-dms-endpoint-s3settings-cannedaclforobjects"></a>
  A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl"> Canned ACL</a> in the
  Amazon S3 Developer Guide: br />
  The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.<br />
  
  Required: No<br />
  
  Allowed values: <code>authenticated-read | aws-exec-read | bucket-owner-full-control | bucket-owner-read | none | private | public-read | public-read-write</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    cannedAclForObjects?: Value<'authenticated-read' | 'aws-exec-read' | 'bucket-owner-full-control' | 'bucket-owner-read' | 'none' | 'private' | 'public-read' | 'public-read-write'>;
    /** <code>Rfc4180</code>  <a name="cfn-dms-endpoint-s3settings-rfc4180"></a>
  For an S3 source, when this value is set to <code>true</code> or <code>y</code>, each leading double quotation mark has to be followed by an ending double quotation mark. This formatting complies with RFC 4180. When this value is set to <code>false</code> or <code>n</code>, string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can’t use a delimiter as part of the string, because it signals the end of the value.<br />
  For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to <code>true</code> or <code>y</code> using Amazon S3 as a target, if the data has quotation marks or newline characters in it, AWS DMS encloses the entire column with an additional pair of double quotation marks (”). Every quotation mark within the data is repeated twice.<br />
  The default value is <code>true</code>. Valid values include <code>true</code>, <code>false</code>, <code>y</code>, and <code>n</code>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    rfc4180?: Value<boolean>;
    /** <code>ServiceAccessRoleArn</code>  <a name="cfn-dms-endpoint-s3settings-serviceaccessrolearn"></a>
  A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action. It enables AWS DMS to read and write objects from an S3 bucket.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    serviceAccessRoleArn?: Value<string>;
    /** <code>ParquetTimestampInMillisecond</code>  <a name="cfn-dms-endpoint-s3settings-parquettimestampinmillisecond"></a>
  A value that specifies the precision of any <code>TIMESTAMP</code> column values that are written to an Amazon S3 object file in .parquet format.<br />
  AWS DMS supports the <code>ParquetTimestampInMillisecond</code> parameter in versions 3.1.4 and later.
  When <code>ParquetTimestampInMillisecond</code> is set to <code>true</code> or <code>y</code>, AWS DMS writes all <code>TIMESTAMP</code> columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.<br />
  Currently, Amazon Athena and AWS Glue can handle only millisecond precision for <code>TIMESTAMP</code> values. Set this parameter to <code>true</code> for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.<br />
  AWS DMS writes any <code>TIMESTAMP</code> column values written to an S3 file in .csv format with microsecond precision.<br />
  Setting <code>ParquetTimestampInMillisecond</code> has no effect on the string format of the timestamp column value that is inserted by setting the <code>TimestampColumnName</code> parameter.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    parquetTimestampInMillisecond?: Value<boolean>;
    /** <code>PreserveTransactions</code>  <a name="cfn-dms-endpoint-s3settings-preservetransactions"></a>
  If this setting is set to <code>true</code>, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath">https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath</a>. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath"> Capturing data changes (CDC) including transaction order on the S3 target</a>.<br />
  This setting is supported in AWS DMS versions 3.4.2 and later.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    preserveTransactions?: Value<boolean>;
    /** <code>BucketFolder</code>  <a name="cfn-dms-endpoint-s3settings-bucketfolder"></a>
  An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <code>bucketFolder/schema_name/table_name/</code>. If this parameter isn’t specified, the path used is <code>schema_name/table_name/</code>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    bucketFolder?: Value<string>;
    /** <code>DatePartitionDelimiter</code>  <a name="cfn-dms-endpoint-s3settings-datepartitiondelimiter"></a>
  Specifies a date separating delimiter to use during folder partitioning. The default value is <code>SLASH</code>. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>.<br />
  
  Required: No<br />
  
  Allowed values: <code>DASH | NONE | SLASH | UNDERSCORE</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    datePartitionDelimiter?: Value<'DASH' | 'NONE' | 'SLASH' | 'UNDERSCORE'>;
    /** <p> */
    encodingType?: Value<string>;
    /** <code>ParquetVersion</code>  <a name="cfn-dms-endpoint-s3settings-parquetversion"></a>
  The version of the Apache Parquet format that you want to use: <code>parquet_1_0</code> (the default) or <code>parquet_2_0</code>.<br />
  
  Required: No<br />
  
  Allowed values: <code>parquet-1-0 | parquet-2-0</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    parquetVersion?: Value<'parquet-1-0' | 'parquet-2-0'>;
    /** <code>AddColumnName</code>  <a name="cfn-dms-endpoint-s3settings-addcolumnname"></a>
  An optional parameter that, when set to <code>true</code> or <code>y</code>, you can use to add column name information to the .csv output file.<br />
  The default value is <code>false</code>. Valid values are <code>true</code>, <code>false</code>, <code>y</code>, and <code>n</code>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    addColumnName?: Value<boolean>;
    /** <code>CdcMinFileSize</code>  <a name="cfn-dms-endpoint-s3settings-cdcminfilesize"></a>
  Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.<br />
  When <code>CdcMinFileSize</code> and <code>CdcMaxBatchInterval</code> are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.<br />
  The default value is 32 MB.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    cdcMinFileSize?: Value<number>;
    /** <code>ExternalTableDefinition</code>  <a name="cfn-dms-endpoint-s3settings-externaltabledefinition"></a>
  The external table definition.<br />
  Conditional: If <code>S3</code> is used as a source then <code>ExternalTableDefinition</code> is required.<br />
  
  Required: Conditional<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    externalTableDefinition?: Value<string>;
    /** <code>UseCsvNoSupValue</code>  <a name="cfn-dms-endpoint-s3settings-usecsvnosupvalue"></a>
  This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to <code>true</code> for columns not included in the supplemental log, AWS DMS uses the value specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue">https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue</a>. If this setting isn’t set or is set to <code>false</code>, AWS DMS uses the null value for these columns.<br />
  This setting is supported in AWS DMS versions 3.4.1 and later.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    useCsvNoSupValue?: Value<boolean>;
    /** <code>MaxFileSize</code>  <a name="cfn-dms-endpoint-s3settings-maxfilesize"></a>
  A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.<br />
  The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    maxFileSize?: Value<number>;
    /** <code>CsvNoSupValue</code>  <a name="cfn-dms-endpoint-s3settings-csvnosupvalue"></a>
  This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue">https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue</a> 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 <code>UseCsvNoSupValue</code> setting.<br />
  This setting is supported in AWS DMS versions 3.4.1 and later.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    csvNoSupValue?: Value<string>;
    /** <code>CdcPath</code>  <a name="cfn-dms-endpoint-s3settings-cdcpath"></a>
  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 <code>CdcPath</code> 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 <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions">https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions</a> to <code>true</code>, 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 <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder">https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder</a> and <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName">https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName</a>.<br />
  For example, if you specify <code>CdcPath</code> as <code>MyChangedData</code>, and you specify <code>BucketName</code> as <code>MyTargetBucket</code> but do not specify <code>BucketFolder</code>, AWS DMS creates the CDC folder path following: <code>MyTargetBucket/MyChangedData</code>.<br />
  If you specify the same <code>CdcPath</code>, and you specify <code>BucketName</code> as <code>MyTargetBucket</code> and <code>BucketFolder</code> as <code>MyTargetData</code>, AWS DMS creates the CDC folder path following: <code>MyTargetBucket/MyTargetData/MyChangedData</code>.<br />
  For more information on CDC including transaction order on an S3 target, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath"> Capturing data changes (CDC) including transaction order on the S3 target</a>.<br />
  This setting is supported in AWS DMS versions 3.4.2 and later.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    cdcPath?: Value<string>;
    /** <code>CsvRowDelimiter</code>  <a name="cfn-dms-endpoint-s3settings-csvrowdelimiter"></a>
  The delimiter used to separate rows in the .csv file for both source and target.<br />
  The default is a carriage return (<code>\n</code>).<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    csvRowDelimiter?: Value<string>;
    /** <code>RowGroupLength</code>  <a name="cfn-dms-endpoint-s3settings-rowgrouplength"></a>
  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.<br />
  If you choose a value larger than the maximum, <code>RowGroupLength</code> is set to the max row group length in bytes (64 * 1024 * 1024).<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    rowGroupLength?: Value<number>;
    /** <code>CdcMaxBatchInterval</code>  <a name="cfn-dms-endpoint-s3settings-cdcmaxbatchinterval"></a>
  Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.<br />
  When <code>CdcMaxBatchInterval</code> and <code>CdcMinFileSize</code> are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template.<br />
  The default value is 60 seconds.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    cdcMaxBatchInterval?: Value<number>;
    /** <code>DataPageSize</code>  <a name="cfn-dms-endpoint-s3settings-datapagesize"></a>
  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.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    dataPageSize?: Value<number>;
    /** <code>DictPageSizeLimit</code>  <a name="cfn-dms-endpoint-s3settings-dictpagesizelimit"></a>
  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 <code>PLAIN</code>. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to <code>PLAIN</code> encoding. This size is used for .parquet file format only.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    dictPageSizeLimit?: Value<number>;
    /** <code>DatePartitionEnabled</code>  <a name="cfn-dms-endpoint-s3settings-datepartitionenabled"></a>
  When set to <code>true</code>, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is <code>false</code>. For more information about date-based folder partitioning, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning"> Using date-based folder partitioning</a>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    datePartitionEnabled?: Value<boolean>;
    /** <code>CompressionType</code>  <a name="cfn-dms-endpoint-s3settings-compressiontype"></a>
  An optional parameter. When set to GZIP it enables the service to compress the target files. To allow the service to write the target files uncompressed, either set this parameter to NONE (the default) or don’t specify the parameter at all. This parameter applies to both .csv and .parquet file formats.<br />
  
  Required: No<br />
  
  Allowed values: <code>gzip | none</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    compressionType?: Value<'gzip' | 'none'>;
    /** <code>DatePartitionTimezone</code>  <a name="cfn-dms-endpoint-s3settings-datepartitiontimezone"></a>
  When creating an S3 target endpoint, set <code>DatePartitionTimezone</code> to convert the current UTC time into a specified time zone. The conversion occurs when a date partition folder is created and a change data capture (CDC) file name is generated. The time zone format is Area/Location. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>, as shown in the following example.<br />
  <code>s3-settings='{&quot;DatePartitionEnabled&quot;: true, &quot;DatePartitionSequence&quot;: &quot;YYYYMMDDHH&quot;, &quot;DatePartitionDelimiter&quot;: &quot;SLASH&quot;, &quot;DatePartitionTimezone&quot;:&quot;Asia/Seoul&quot;, &quot;BucketName&quot;: &quot;dms-nattarat-test&quot;}'</code><br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    datePartitionTimezone?: Value<string>;
    /** <code>CdcInsertsOnly</code>  <a name="cfn-dms-endpoint-s3settings-cdcinsertsonly"></a>
  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 <code>false</code> 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.<br />
  If <code>CdcInsertsOnly</code> is set to <code>true</code> or <code>y</code>, 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 <code>IncludeOpForFullLoad</code>. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If <code>IncludeOpForFullLoad</code> is set to <code>false</code>, 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 <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps"> Indicating Source DB Operations in Migrated S3 Data</a> in the
  AWS Database Migration Service User Guide: br />
  AWS DMS supports the interaction described preceding between the <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> parameters in versions 3.1.4 and later.<br />
  <code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can’t both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    cdcInsertsOnly?: Value<boolean>;
    /** <p> */
    encryptionMode?: Value<string>;
}
