S3EndpointArgs class
The set of arguments for S3Endpoint. The set of arguments for S3Endpoint.
Constructors
-
S3EndpointArgs({Input<
bool?> ? addColumnName, Input<bool?> ? addTrailingPaddingCharacter, Input<String?> ? bucketFolder, required Input<String> bucketName, Input<String?> ? cannedAclForObjects, Input<bool?> ? cdcInsertsAndUpdates, Input<bool?> ? cdcInsertsOnly, Input<int?> ? cdcMaxBatchInterval, Input<int?> ? cdcMinFileSize, Input<String?> ? cdcPath, Input<String?> ? certificateArn, Input<String?> ? compressionType, Input<String?> ? csvDelimiter, Input<String?> ? csvNoSupValue, Input<String?> ? csvNullValue, Input<String?> ? csvRowDelimiter, Input<String?> ? dataFormat, Input<int?> ? dataPageSize, Input<String?> ? datePartitionDelimiter, Input<bool?> ? datePartitionEnabled, Input<String?> ? datePartitionSequence, Input<String?> ? datePartitionTimezone, Input<bool?> ? detachTargetOnLobLookupFailureParquet, Input<int?> ? dictPageSizeLimit, Input<bool?> ? enableStatistics, Input<String?> ? encodingType, Input<String?> ? encryptionMode, required Input<String> endpointId, required Input<String> endpointType, Input<String?> ? expectedBucketOwner, Input<String?> ? externalTableDefinition, Input<bool?> ? glueCatalogGeneration, Input<int?> ? ignoreHeaderRows, Input<bool?> ? includeOpForFullLoad, Input<String?> ? kmsKeyArn, Input<int?> ? maxFileSize, Input<bool?> ? parquetTimestampInMillisecond, Input<String?> ? parquetVersion, Input<bool?> ? preserveTransactions, Input<String?> ? region, Input<bool?> ? rfc4180, Input<int?> ? rowGroupLength, Input<String?> ? serverSideEncryptionKmsKeyId, required Input<String> serviceAccessRoleArn, Input<String?> ? sslMode, Input<Map< ? tags, Input<String, String> ?>String?> ? timestampColumnName, Input<bool?> ? useCsvNoSupValue, Input<bool?> ? useTaskStartTimeForFullLoadTimestamp}) -
Creates a new S3EndpointArgs.
addColumnNameWhether to add column name information to the .csv output file. Default isfalse.addTrailingPaddingCharacterWhether to add padding. Default isfalse. (Ignored for source endpoints.)bucketFolderS3 object prefix.bucketNameS3 bucket name.cannedAclForObjectsPredefined (canned) access control list for objects created in an S3 bucket. Valid values includenone,private,public-read,public-read-write,authenticated-read,aws-exec-read,bucket-owner-read, andbucket-owner-full-control. Default isnone.cdcInsertsAndUpdatesWhether to write insert and update operations to .csv or .parquet output files. Default isfalse.cdcInsertsOnlyWhether to write insert operations to .csv or .parquet output files. Default isfalse.cdcMaxBatchIntervalMaximum length of the interval, defined in seconds, after which to output a file to Amazon S3. (AWS default is60.)cdcMinFileSizeMinimum file size condition as defined in kilobytes to output a file to Amazon S3. (AWS default is 32000 KB.)cdcPathFolder path of CDC files. IfcdcPathis 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. Required for CDC.certificateArnARN for the certificate.compressionTypeSet to compress target files. Valid values areGZIPandNONE. Default isNONE. (Ignored for source endpoints.)csvDelimiterDelimiter used to separate columns in the source files. Default is,.csvNoSupValueOnly applies if output files for a CDC load are written in .csv format. IfuseCsvNoSupValueis set totrue, string to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless ofuseCsvNoSupValue. (Ignored for source endpoints.)csvNullValueString to as null when writing to the target. (AWS default isNULL.)csvRowDelimiterDelimiter used to separate rows in the source files. Default is newline (i.e.,\n).dataFormatOutput format for the files that AWS DMS uses to create S3 objects. Valid values arecsvandparquet. (Ignored for source endpoints -- onlycsvis valid.)dataPageSizeSize of one data page in bytes. (AWS default is 1 MiB, i.e.,1048576.)datePartitionDelimiterDate separating delimiter to use during folder partitioning. Valid values areSLASH,UNDERSCORE,DASH, andNONE. (AWS default isSLASH.) (Ignored for source endpoints.)datePartitionEnabledPartition S3 bucket folders based on transaction commit dates. Default isfalse. (Ignored for source endpoints.)datePartitionSequenceDate format to use during folder partitioning. Use this parameter whendatePartitionEnabledis set to true. Valid values areYYYYMMDD,YYYYMMDDHH,YYYYMM,MMYYYYDD, andDDMMYYYY. (AWS default isYYYYMMDD.) (Ignored for source endpoints.)datePartitionTimezoneConvert the current UTC time to a timezone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The timezone format is Area/Location (e.g.,Europe/Paris). Use this whendatePartitionEnabledistrue. (Ignored for source endpoints.)detachTargetOnLobLookupFailureParquetUndocumented argument for use as directed by AWS Support.dictPageSizeLimitMaximum size in bytes of an encoded dictionary page of a column. (AWS default is 1 MiB, i.e.,1048576.)enableStatisticsWhether to enable statistics for Parquet pages and row groups. Default istrue.encodingTypeType of encoding to use. Value values arerle-dictionary,plain, andplain-dictionary. (AWS default isrle-dictionary.)encryptionModeServer-side encryption mode that you want to encrypt your .csv or .parquet object files copied to S3. Valid values areSSE_S3andSSE_KMS. (AWS default isSSE_S3.) (Ignored for source endpoints -- onlySSE_S3is valid.)endpointIdDatabase endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens.endpointTypeType of endpoint. Valid values aresource,target.expectedBucketOwnerBucket owner to prevent sniping. Value is an AWS account ID.externalTableDefinitionJSON document that describes how AWS DMS should interpret the data. Required forsourceendpoints.glueCatalogGenerationWhether to integrate AWS Glue Data Catalog with an Amazon S3 target. See Using AWS Glue Data Catalog with an Amazon S3 target for AWS DMS for more information. Default isfalse.ignoreHeaderRowsWhen this value is set to1, DMS ignores the first row header in a .csv file. (AWS default is0.)includeOpForFullLoadWhether 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 isfalse.kmsKeyArnARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value forkmsKeyArn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.maxFileSizeMaximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. Valid values are from1to1048576. (AWS default is 1 GB, i.e.,1048576.)parquetTimestampInMillisecondSpecifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default isfalse. (Ignored for source endpoints.)parquetVersionVersion of the .parquet file format. Valid values areparquet-1-0andparquet-2-0. (AWS default isparquet-1-0.) (Ignored for source endpoints.)preserveTransactionsWhether DMS saves the transaction order for a CDC load on the S3 target specified bycdcPath. Default isfalse. (Ignored for source endpoints.)regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.rfc4180For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default istrue.rowGroupLengthNumber of rows in a row group. (AWS default is10000.)serverSideEncryptionKmsKeyIdWhenencryptionModeisSSE_KMS, ARN for the AWS KMS key. (Ignored for source endpoints -- onlySSE_S3encryptionModeis valid.)serviceAccessRoleArnARN of the IAM role with permissions to the S3 Bucket.sslModeSSL mode to use for the connection. Valid values arenone,require,verify-ca,verify-full. (AWS default isnone.)tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.timestampColumnNameColumn to add with timestamp information to the endpoint data for an Amazon S3 target.useCsvNoSupValueWhether to usecsvNoSupValuefor columns not included in the supplemental log. (Ignored for source endpoints.)useTaskStartTimeForFullLoadTimestampWhen set totrue, uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when set totrue, 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 isfalse.const -
S3EndpointArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
addColumnName
→ Input<
bool?> ? -
Whether to add column name information to the .csv output file. Default is
false.final -
addTrailingPaddingCharacter
→ Input<
bool?> ? -
Whether to add padding. Default is
false. (Ignored for source endpoints.)final -
bucketFolder
→ Input<
String?> ? -
S3 object prefix.
final
-
bucketName
→ Input<
String> -
S3 bucket name.
final
-
cannedAclForObjects
→ Input<
String?> ? -
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, andbucket-owner-full-control. Default isnone.final -
cdcInsertsAndUpdates
→ Input<
bool?> ? -
Whether to write insert and update operations to .csv or .parquet output files. Default is
false.final -
cdcInsertsOnly
→ Input<
bool?> ? -
Whether to write insert operations to .csv or .parquet output files. Default is
false.final -
cdcMaxBatchInterval
→ Input<
int?> ? -
Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. (AWS default is
60.)final -
cdcMinFileSize
→ Input<
int?> ? -
Minimum file size condition as defined in kilobytes to output a file to Amazon S3. (AWS default is 32000 KB.)
final
-
cdcPath
→ Input<
String?> ? -
Folder path of CDC files. If
cdcPathis 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. Required for CDC.final -
certificateArn
→ Input<
String?> ? -
ARN for the certificate.
final
-
compressionType
→ Input<
String?> ? -
Set to compress target files. Valid values are
GZIPandNONE. Default isNONE. (Ignored for source endpoints.)final -
csvDelimiter
→ Input<
String?> ? -
Delimiter used to separate columns in the source files. Default is
,.final -
csvNoSupValue
→ Input<
String?> ? -
Only applies if output files for a CDC load are written in .csv format. If
useCsvNoSupValueis set totrue, string to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless ofuseCsvNoSupValue. (Ignored for source endpoints.)final -
csvNullValue
→ Input<
String?> ? -
String to as null when writing to the target. (AWS default is
NULL.)final -
csvRowDelimiter
→ Input<
String?> ? -
Delimiter used to separate rows in the source files. Default is newline (i.e.,
\n).final -
dataFormat
→ Input<
String?> ? -
Output format for the files that AWS DMS uses to create S3 objects. Valid values are
csvandparquet. (Ignored for source endpoints -- onlycsvis valid.)final -
dataPageSize
→ Input<
int?> ? -
Size of one data page in bytes. (AWS default is 1 MiB, i.e.,
1048576.)final -
datePartitionDelimiter
→ Input<
String?> ? -
Date separating delimiter to use during folder partitioning. Valid values are
SLASH,UNDERSCORE,DASH, andNONE. (AWS default isSLASH.) (Ignored for source endpoints.)final -
datePartitionEnabled
→ Input<
bool?> ? -
Partition S3 bucket folders based on transaction commit dates. Default is
false. (Ignored for source endpoints.)final -
datePartitionSequence
→ Input<
String?> ? -
Date format to use during folder partitioning. Use this parameter when
datePartitionEnabledis set to true. Valid values areYYYYMMDD,YYYYMMDDHH,YYYYMM,MMYYYYDD, andDDMMYYYY. (AWS default isYYYYMMDD.) (Ignored for source endpoints.)final -
datePartitionTimezone
→ Input<
String?> ? -
Convert the current UTC time to a timezone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The timezone format is Area/Location (e.g.,
Europe/Paris). Use this whendatePartitionEnabledistrue. (Ignored for source endpoints.)final -
detachTargetOnLobLookupFailureParquet
→ Input<
bool?> ? -
Undocumented argument for use as directed by AWS Support.
final
-
dictPageSizeLimit
→ Input<
int?> ? -
Maximum size in bytes of an encoded dictionary page of a column. (AWS default is 1 MiB, i.e.,
1048576.)final -
enableStatistics
→ Input<
bool?> ? -
Whether to enable statistics for Parquet pages and row groups. Default is
true.final -
encodingType
→ Input<
String?> ? -
Type of encoding to use. Value values are
rle-dictionary,plain, andplain-dictionary. (AWS default isrle-dictionary.)final -
encryptionMode
→ Input<
String?> ? -
Server-side encryption mode that you want to encrypt your .csv or .parquet object files copied to S3. Valid values are
SSE_S3andSSE_KMS. (AWS default isSSE_S3.) (Ignored for source endpoints -- onlySSE_S3is valid.)final -
endpointId
→ Input<
String> -
Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens.
final
-
endpointType
→ Input<
String> -
Type of endpoint. Valid values are
source,target.final -
expectedBucketOwner
→ Input<
String?> ? -
Bucket owner to prevent sniping. Value is an AWS account ID.
final
-
externalTableDefinition
→ Input<
String?> ? -
JSON document that describes how AWS DMS should interpret the data. Required for
sourceendpoints.final -
glueCatalogGeneration
→ Input<
bool?> ? -
Whether to integrate AWS Glue Data Catalog with an Amazon S3 target. See Using AWS Glue Data Catalog with an Amazon S3 target for AWS DMS for more information. Default is
false.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
ignoreHeaderRows
→ Input<
int?> ? -
When this value is set to
1, DMS ignores the first row header in a .csv file. (AWS default is0.)final -
includeOpForFullLoad
→ Input<
bool?> ? -
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.final -
kmsKeyArn
→ Input<
String?> ? -
ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for
kmsKeyArn, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.final -
maxFileSize
→ Input<
int?> ? -
Maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. Valid values are from
1to1048576. (AWS default is 1 GB, i.e.,1048576.)final -
parquetTimestampInMillisecond
→ Input<
bool?> ? -
Specifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default is
false. (Ignored for source endpoints.)final -
parquetVersion
→ Input<
String?> ? -
Version of the .parquet file format. Valid values are
parquet-1-0andparquet-2-0. (AWS default isparquet-1-0.) (Ignored for source endpoints.)final -
preserveTransactions
→ Input<
bool?> ? -
Whether DMS saves the transaction order for a CDC load on the S3 target specified by
cdcPath. Default isfalse. (Ignored for source endpoints.)final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
rfc4180
→ Input<
bool?> ? -
For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default is
true.final -
rowGroupLength
→ Input<
int?> ? -
Number of rows in a row group. (AWS default is
10000.)final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serverSideEncryptionKmsKeyId
→ Input<
String?> ? -
When
encryptionModeisSSE_KMS, ARN for the AWS KMS key. (Ignored for source endpoints -- onlySSE_S3encryptionModeis valid.)final -
serviceAccessRoleArn
→ Input<
String> -
ARN of the IAM role with permissions to the S3 Bucket.
final
-
sslMode
→ Input<
String?> ? -
SSL mode to use for the connection. Valid values are
none,require,verify-ca,verify-full. (AWS default isnone.)final -
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
timestampColumnName
→ Input<
String?> ? -
Column to add with timestamp information to the endpoint data for an Amazon S3 target.
final
-
useCsvNoSupValue
→ Input<
bool?> ? -
Whether to use
csvNoSupValuefor columns not included in the supplemental log. (Ignored for source endpoints.)final -
useTaskStartTimeForFullLoadTimestamp
→ Input<
bool?> ? -
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 totrue, 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 isfalse.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited