S3EndpointState class

Input properties used for looking up and filtering S3Endpoint resources.

Constructors

S3EndpointState({Input<bool?>? addColumnName, Input<bool?>? addTrailingPaddingCharacter, Input<String?>? bucketFolder, 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, Input<String?>? endpointArn, Input<String?>? endpointId, Input<String?>? endpointType, Input<String?>? engineDisplayName, Input<String?>? expectedBucketOwner, Input<String?>? externalId, 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, Input<String?>? serviceAccessRoleArn, Input<String?>? sslMode, Input<String?>? status, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? timestampColumnName, Input<bool?>? useCsvNoSupValue, Input<bool?>? useTaskStartTimeForFullLoadTimestamp})
Creates a new S3EndpointState. addColumnName Whether to add column name information to the .csv output file. Default is false. addTrailingPaddingCharacter Whether to add padding. Default is false. (Ignored for source endpoints.) bucketFolder S3 object prefix. bucketName S3 bucket name. cannedAclForObjects 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. cdcInsertsAndUpdates Whether to write insert and update operations to .csv or .parquet output files. Default is false. cdcInsertsOnly Whether to write insert operations to .csv or .parquet output files. Default is false. cdcMaxBatchInterval Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. (AWS default is 60.) cdcMinFileSize Minimum file size condition as defined in kilobytes to output a file to Amazon S3. (AWS default is 32000 KB.) cdcPath Folder path of CDC files. If cdcPath 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. Required for CDC. certificateArn ARN for the certificate. compressionType Set to compress target files. Valid values are GZIP and NONE. Default is NONE. (Ignored for source endpoints.) csvDelimiter Delimiter used to separate columns in the source files. Default is ,. csvNoSupValue Only applies if output files for a CDC load are written in .csv format. If useCsvNoSupValue is set to true, 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 of useCsvNoSupValue. (Ignored for source endpoints.) csvNullValue String to as null when writing to the target. (AWS default is NULL.) csvRowDelimiter Delimiter used to separate rows in the source files. Default is newline (i.e., \n). dataFormat Output format for the files that AWS DMS uses to create S3 objects. Valid values are csv and parquet. (Ignored for source endpoints -- only csv is valid.) dataPageSize Size of one data page in bytes. (AWS default is 1 MiB, i.e., 1048576.) datePartitionDelimiter Date separating delimiter to use during folder partitioning. Valid values are SLASH, UNDERSCORE, DASH, and NONE. (AWS default is SLASH.) (Ignored for source endpoints.) datePartitionEnabled Partition S3 bucket folders based on transaction commit dates. Default is false. (Ignored for source endpoints.) datePartitionSequence Date format to use during folder partitioning. Use this parameter when datePartitionEnabled is set to true. Valid values are YYYYMMDD, YYYYMMDDHH, YYYYMM, MMYYYYDD, and DDMMYYYY. (AWS default is YYYYMMDD.) (Ignored for source endpoints.) datePartitionTimezone 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 when datePartitionEnabled is true. (Ignored for source endpoints.) detachTargetOnLobLookupFailureParquet Undocumented argument for use as directed by AWS Support. dictPageSizeLimit Maximum size in bytes of an encoded dictionary page of a column. (AWS default is 1 MiB, i.e., 1048576.) enableStatistics Whether to enable statistics for Parquet pages and row groups. Default is true. encodingType Type of encoding to use. Value values are rle-dictionary, plain, and plain-dictionary. (AWS default is rle-dictionary.) encryptionMode Server-side encryption mode that you want to encrypt your .csv or .parquet object files copied to S3. Valid values are SSE_S3 and SSE_KMS. (AWS default is SSE_S3.) (Ignored for source endpoints -- only SSE_S3 is valid.) endpointArn ARN for the endpoint. endpointId 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. endpointType Type of endpoint. Valid values are source, target. engineDisplayName Expanded name for the engine name. expectedBucketOwner Bucket owner to prevent sniping. Value is an AWS account ID. externalId Can be used for cross-account validation. Use it in another account with aws.dms.S3Endpoint to create the endpoint cross-account. externalTableDefinition JSON document that describes how AWS DMS should interpret the data. Required for source endpoints. glueCatalogGeneration 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. ignoreHeaderRows When this value is set to 1, DMS ignores the first row header in a .csv file. (AWS default is 0.) includeOpForFullLoad 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. kmsKeyArn 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. maxFileSize 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. (AWS default is 1 GB, i.e., 1048576.) parquetTimestampInMillisecond Specifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default is false. (Ignored for source endpoints.) parquetVersion Version of the .parquet file format. Valid values are parquet-1-0 and parquet-2-0. (AWS default is parquet-1-0.) (Ignored for source endpoints.) preserveTransactions Whether DMS saves the transaction order for a CDC load on the S3 target specified by cdcPath. Default is false. (Ignored for source endpoints.) region Region where this resource will be managed. Defaults to the Region set in the provider configuration. rfc4180 For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default is true. rowGroupLength Number of rows in a row group. (AWS default is 10000.) serverSideEncryptionKmsKeyId When encryptionMode is SSE_KMS, ARN for the AWS KMS key. (Ignored for source endpoints -- only SSE_S3 encryptionMode is valid.) serviceAccessRoleArn ARN of the IAM role with permissions to the S3 Bucket. sslMode SSL mode to use for the connection. Valid values are none, require, verify-ca, verify-full. (AWS default is none.) status Status of the endpoint. tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. timestampColumnName Column to add with timestamp information to the endpoint data for an Amazon S3 target. useCsvNoSupValue Whether to use csvNoSupValue for columns not included in the supplemental log. (Ignored for source endpoints.) useTaskStartTimeForFullLoadTimestamp 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.
const
S3EndpointState.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, and bucket-owner-full-control. Default is none.
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 cdcPath 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. Required for CDC.
final
certificateArn → Input<String?>?
ARN for the certificate.
final
compressionType → Input<String?>?
Set to compress target files. Valid values are GZIP and NONE. Default is NONE. (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 useCsvNoSupValue is set to true, 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 of useCsvNoSupValue. (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 csv and parquet. (Ignored for source endpoints -- only csv is 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, and NONE. (AWS default is SLASH.) (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 datePartitionEnabled is set to true. Valid values are YYYYMMDD, YYYYMMDDHH, YYYYMM, MMYYYYDD, and DDMMYYYY. (AWS default is YYYYMMDD.) (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 when datePartitionEnabled is true. (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, and plain-dictionary. (AWS default is rle-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_S3 and SSE_KMS. (AWS default is SSE_S3.) (Ignored for source endpoints -- only SSE_S3 is valid.)
final
endpointArn → Input<String?>?
ARN for the endpoint.
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
engineDisplayName → Input<String?>?
Expanded name for the engine name.
final
expectedBucketOwner → Input<String?>?
Bucket owner to prevent sniping. Value is an AWS account ID.
final
externalId → Input<String?>?
Can be used for cross-account validation. Use it in another account with aws.dms.S3Endpoint to create the endpoint cross-account.
final
externalTableDefinition → Input<String?>?
JSON document that describes how AWS DMS should interpret the data. Required for source endpoints.
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 is 0.)
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 1 to 1048576. (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-0 and parquet-2-0. (AWS default is parquet-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 is false. (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 encryptionMode is SSE_KMS, ARN for the AWS KMS key. (Ignored for source endpoints -- only SSE_S3 encryptionMode is 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 is none.)
final
status → Input<String?>?
Status of the endpoint.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
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 csvNoSupValue for 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 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.
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