| Package | Description |
|---|---|
| software.amazon.awssdk.services.databasemigration.model |
| Modifier and Type | Method and Description |
|---|---|
S3Settings.Builder |
S3Settings.Builder.addColumnName(Boolean addColumnName)
An optional parameter that, when set to
true or y, you can use to add column name
information to the .csv output file. |
S3Settings.Builder |
S3Settings.Builder.addTrailingPaddingCharacter(Boolean addTrailingPaddingCharacter)
Use the S3 target endpoint setting
AddTrailingPaddingCharacter to add padding on string data. |
S3Settings.Builder |
S3Settings.Builder.bucketFolder(String bucketFolder)
An optional parameter to set a folder name in the S3 bucket.
|
S3Settings.Builder |
S3Settings.Builder.bucketName(String bucketName)
The name of the S3 bucket.
|
static S3Settings.Builder |
S3Settings.builder() |
S3Settings.Builder |
S3Settings.Builder.cannedAclForObjects(CannedAclForObjectsValue cannedAclForObjects)
A value that enables DMS to specify a predefined (canned) access control list for objects created in an
Amazon S3 bucket as .csv or .parquet files.
|
S3Settings.Builder |
S3Settings.Builder.cannedAclForObjects(String cannedAclForObjects)
A value that enables DMS to specify a predefined (canned) access control list for objects created in an
Amazon S3 bucket as .csv or .parquet files.
|
S3Settings.Builder |
S3Settings.Builder.cdcInsertsAndUpdates(Boolean cdcInsertsAndUpdates)
A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or
.parquet (columnar storage) output files.
|
S3Settings.Builder |
S3Settings.Builder.cdcInsertsOnly(Boolean cdcInsertsOnly)
A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar
storage (.parquet) output files.
|
S3Settings.Builder |
S3Settings.Builder.cdcMaxBatchInterval(Integer cdcMaxBatchInterval)
Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
|
S3Settings.Builder |
S3Settings.Builder.cdcMinFileSize(Integer cdcMinFileSize)
Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
|
S3Settings.Builder |
S3Settings.Builder.cdcPath(String cdcPath)
Specifies the folder path of CDC files.
|
S3Settings.Builder |
S3Settings.Builder.compressionType(CompressionTypeValue compressionType)
An optional parameter to use GZIP to compress the target files.
|
S3Settings.Builder |
S3Settings.Builder.compressionType(String compressionType)
An optional parameter to use GZIP to compress the target files.
|
S3Settings.Builder |
S3Settings.Builder.csvDelimiter(String csvDelimiter)
The delimiter used to separate columns in the .csv file for both source and target.
|
S3Settings.Builder |
S3Settings.Builder.csvNoSupValue(String csvNoSupValue)
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written
in .csv format.
|
S3Settings.Builder |
S3Settings.Builder.csvNullValue(String csvNullValue)
An optional parameter that specifies how DMS treats null values.
|
S3Settings.Builder |
S3Settings.Builder.csvRowDelimiter(String csvRowDelimiter)
The delimiter used to separate rows in the .csv file for both source and target.
|
S3Settings.Builder |
S3Settings.Builder.dataFormat(DataFormatValue dataFormat)
The format of the data that you want to use for output.
|
S3Settings.Builder |
S3Settings.Builder.dataFormat(String dataFormat)
The format of the data that you want to use for output.
|
S3Settings.Builder |
S3Settings.Builder.dataPageSize(Integer dataPageSize)
The size of one data page in bytes.
|
S3Settings.Builder |
S3Settings.Builder.datePartitionDelimiter(DatePartitionDelimiterValue datePartitionDelimiter)
Specifies a date separating delimiter to use during folder partitioning.
|
S3Settings.Builder |
S3Settings.Builder.datePartitionDelimiter(String datePartitionDelimiter)
Specifies a date separating delimiter to use during folder partitioning.
|
S3Settings.Builder |
S3Settings.Builder.datePartitionEnabled(Boolean datePartitionEnabled)
When set to
true, this parameter partitions S3 bucket folders based on transaction commit dates. |
S3Settings.Builder |
S3Settings.Builder.datePartitionSequence(DatePartitionSequenceValue datePartitionSequence)
Identifies the sequence of the date format to use during folder partitioning.
|
S3Settings.Builder |
S3Settings.Builder.datePartitionSequence(String datePartitionSequence)
Identifies the sequence of the date format to use during folder partitioning.
|
S3Settings.Builder |
S3Settings.Builder.datePartitionTimezone(String datePartitionTimezone)
When creating an S3 target endpoint, set
DatePartitionTimezone to convert the current UTC time
into a specified time zone. |
S3Settings.Builder |
S3Settings.Builder.dictPageSizeLimit(Integer dictPageSizeLimit)
The maximum size of an encoded dictionary page of a column.
|
S3Settings.Builder |
S3Settings.Builder.enableStatistics(Boolean enableStatistics)
A value that enables statistics for Parquet pages and row groups.
|
S3Settings.Builder |
S3Settings.Builder.encodingType(EncodingTypeValue encodingType)
The type of encoding you are using:
|
S3Settings.Builder |
S3Settings.Builder.encodingType(String encodingType)
The type of encoding you are using:
|
S3Settings.Builder |
S3Settings.Builder.encryptionMode(EncryptionModeValue encryptionMode)
The type of server-side encryption that you want to use for your data.
|
S3Settings.Builder |
S3Settings.Builder.encryptionMode(String encryptionMode)
The type of server-side encryption that you want to use for your data.
|
S3Settings.Builder |
S3Settings.Builder.expectedBucketOwner(String expectedBucketOwner)
To specify a bucket owner and prevent sniping, you can use the
ExpectedBucketOwner endpoint
setting. |
S3Settings.Builder |
S3Settings.Builder.externalTableDefinition(String externalTableDefinition)
Specifies how tables are defined in the S3 source files only.
|
S3Settings.Builder |
S3Settings.Builder.glueCatalogGeneration(Boolean glueCatalogGeneration)
When true, allows Glue to catalog your S3 bucket.
|
S3Settings.Builder |
S3Settings.Builder.ignoreHeaderRows(Integer ignoreHeaderRows)
When this value is set to 1, DMS ignores the first row header in a .csv file.
|
S3Settings.Builder |
S3Settings.Builder.includeOpForFullLoad(Boolean includeOpForFullLoad)
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) or .parquet
output files only to indicate how the rows were added to the source database.
|
S3Settings.Builder |
S3Settings.Builder.maxFileSize(Integer maxFileSize)
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.
|
S3Settings.Builder |
S3Settings.Builder.parquetTimestampInMillisecond(Boolean parquetTimestampInMillisecond)
A value that specifies the precision of any
TIMESTAMP column values that are written to an
Amazon S3 object file in .parquet format. |
S3Settings.Builder |
S3Settings.Builder.parquetVersion(ParquetVersionValue parquetVersion)
The version of the Apache Parquet format that you want to use:
parquet_1_0 (the default) or
parquet_2_0. |
S3Settings.Builder |
S3Settings.Builder.parquetVersion(String parquetVersion)
The version of the Apache Parquet format that you want to use:
parquet_1_0 (the default) or
parquet_2_0. |
S3Settings.Builder |
S3Settings.Builder.preserveTransactions(Boolean preserveTransactions)
If set to
true, DMS saves the transaction order for a change data capture (CDC) load on the
Amazon S3 target specified by
CdcPath . |
S3Settings.Builder |
S3Settings.Builder.rfc4180(Boolean rfc4180)
For an S3 source, when this value is set to
true or y, each leading double
quotation mark has to be followed by an ending double quotation mark. |
S3Settings.Builder |
S3Settings.Builder.rowGroupLength(Integer rowGroupLength)
The number of rows in a row group.
|
S3Settings.Builder |
S3Settings.Builder.serverSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)
If you are using
SSE_KMS for the EncryptionMode, provide the KMS key ID. |
S3Settings.Builder |
S3Settings.Builder.serviceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) used by the service to access the IAM role.
|
S3Settings.Builder |
S3Settings.Builder.timestampColumnName(String timestampColumnName)
A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an
Amazon S3 target.
|
S3Settings.Builder |
S3Settings.toBuilder() |
S3Settings.Builder |
S3Settings.Builder.useCsvNoSupValue(Boolean useCsvNoSupValue)
This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv
format.
|
S3Settings.Builder |
S3Settings.Builder.useTaskStartTimeForFullLoadTimestamp(Boolean useTaskStartTimeForFullLoadTimestamp)
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.
|
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends S3Settings.Builder> |
S3Settings.serializableBuilderClass() |
| Modifier and Type | Method and Description |
|---|---|
default CreateEndpointRequest.Builder |
CreateEndpointRequest.Builder.s3Settings(Consumer<S3Settings.Builder> s3Settings)
Settings in JSON format for the target Amazon S3 endpoint.
|
default ModifyEndpointRequest.Builder |
ModifyEndpointRequest.Builder.s3Settings(Consumer<S3Settings.Builder> s3Settings)
Settings in JSON format for the target Amazon S3 endpoint.
|
default Endpoint.Builder |
Endpoint.Builder.s3Settings(Consumer<S3Settings.Builder> s3Settings)
The settings for the S3 target endpoint.
|
Copyright © 2023. All rights reserved.