public static interface RedshiftSettings.Builder extends SdkPojo, CopyableBuilder<RedshiftSettings.Builder,RedshiftSettings>
| Modifier and Type | Method and Description |
|---|---|
RedshiftSettings.Builder |
acceptAnyDate(Boolean acceptAnyDate)
A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be
loaded without generating an error.
|
RedshiftSettings.Builder |
afterConnectScript(String afterConnectScript)
Code to run after connecting.
|
RedshiftSettings.Builder |
bucketFolder(String bucketFolder)
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target
Redshift cluster.
|
RedshiftSettings.Builder |
bucketName(String bucketName)
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
|
RedshiftSettings.Builder |
caseSensitiveNames(Boolean caseSensitiveNames)
If Amazon Redshift is configured to support case sensitive schema names, set
CaseSensitiveNames
to true. |
RedshiftSettings.Builder |
compUpdate(Boolean compUpdate)
If you set
CompUpdate to true Amazon Redshift applies automatic compression if the
table is empty. |
RedshiftSettings.Builder |
connectionTimeout(Integer connectionTimeout)
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you
initially establish a connection.
|
RedshiftSettings.Builder |
databaseName(String databaseName)
The name of the Amazon Redshift data warehouse (service) that you are working with.
|
RedshiftSettings.Builder |
dateFormat(String dateFormat)
The date format that you are using.
|
RedshiftSettings.Builder |
emptyAsNull(Boolean emptyAsNull)
A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL.
|
RedshiftSettings.Builder |
encryptionMode(EncryptionModeValue encryptionMode)
The type of server-side encryption that you want to use for your data.
|
RedshiftSettings.Builder |
encryptionMode(String encryptionMode)
The type of server-side encryption that you want to use for your data.
|
RedshiftSettings.Builder |
explicitIds(Boolean explicitIds)
This setting is only valid for a full-load migration task.
|
RedshiftSettings.Builder |
fileTransferUploadStreams(Integer fileTransferUploadStreams)
The number of threads used to upload a single file.
|
RedshiftSettings.Builder |
loadTimeout(Integer loadTimeout)
The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift
cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
|
RedshiftSettings.Builder |
mapBooleanAsBoolean(Boolean mapBooleanAsBoolean)
When true, lets Redshift migrate the boolean type as boolean.
|
RedshiftSettings.Builder |
maxFileSize(Integer maxFileSize)
The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon
Redshift.
|
RedshiftSettings.Builder |
password(String password)
The password for the user named in the
username property. |
RedshiftSettings.Builder |
port(Integer port)
The port number for Amazon Redshift.
|
RedshiftSettings.Builder |
removeQuotes(Boolean removeQuotes)
A value that specifies to remove surrounding quotation marks from strings in the incoming data.
|
RedshiftSettings.Builder |
replaceChars(String replaceChars)
A value that specifies to replaces the invalid characters specified in
ReplaceInvalidChars,
substituting the specified characters instead. |
RedshiftSettings.Builder |
replaceInvalidChars(String replaceInvalidChars)
A list of characters that you want to replace.
|
RedshiftSettings.Builder |
secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
required permissions to access the value in
SecretsManagerSecret. |
RedshiftSettings.Builder |
secretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Amazon
Redshift endpoint connection details. |
RedshiftSettings.Builder |
serverName(String serverName)
The name of the Amazon Redshift cluster you are using.
|
RedshiftSettings.Builder |
serverSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)
The KMS key ID.
|
RedshiftSettings.Builder |
serviceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
|
RedshiftSettings.Builder |
timeFormat(String timeFormat)
The time format that you want to use.
|
RedshiftSettings.Builder |
trimBlanks(Boolean trimBlanks)
A value that specifies to remove the trailing white space characters from a VARCHAR string.
|
RedshiftSettings.Builder |
truncateColumns(Boolean truncateColumns)
A value that specifies to truncate data in columns to the appropriate number of characters, so that the data
fits in the column.
|
RedshiftSettings.Builder |
username(String username)
An Amazon Redshift user name for a registered user.
|
RedshiftSettings.Builder |
writeBufferSize(Integer writeBufferSize)
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the
DMS replication instance.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildRedshiftSettings.Builder acceptAnyDate(Boolean acceptAnyDate)
A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be
loaded without generating an error. You can choose true or false (the default).
This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
acceptAnyDate - A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00,
to be loaded without generating an error. You can choose true or false (the
default).
This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
RedshiftSettings.Builder afterConnectScript(String afterConnectScript)
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
afterConnectScript - Code to run after connecting. This parameter should contain the code itself, not the name of a file
containing the code.RedshiftSettings.Builder bucketFolder(String bucketFolder)
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
For full load mode, DMS converts source records into .csv files and loads them to the
BucketFolder/TableID path. DMS uses the Redshift COPY command to upload the .csv files to
the target table. The files are deleted once the COPY operation has finished. For more
information, see COPY in the
Amazon Redshift Database Developer Guide.
For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
bucketFolder - An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the
target Redshift cluster.
For full load mode, DMS converts source records into .csv files and loads them to the
BucketFolder/TableID path. DMS uses the Redshift COPY command to upload the .csv
files to the target table. The files are deleted once the COPY operation has finished.
For more information, see COPY in the Amazon Redshift
Database Developer Guide.
For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
RedshiftSettings.Builder bucketName(String bucketName)
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
bucketName - The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.RedshiftSettings.Builder caseSensitiveNames(Boolean caseSensitiveNames)
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames
to true. The default is false.
caseSensitiveNames - If Amazon Redshift is configured to support case sensitive schema names, set
CaseSensitiveNames to true. The default is false.RedshiftSettings.Builder compUpdate(Boolean compUpdate)
If you set CompUpdate to true Amazon Redshift applies automatic compression if the
table is empty. This applies even if the table columns already have encodings other than RAW. If
you set CompUpdate to false, automatic compression is disabled and existing column
encodings aren't changed. The default is true.
compUpdate - If you set CompUpdate to true Amazon Redshift applies automatic compression
if the table is empty. This applies even if the table columns already have encodings other than
RAW. If you set CompUpdate to false, automatic compression is
disabled and existing column encodings aren't changed. The default is true.RedshiftSettings.Builder connectionTimeout(Integer connectionTimeout)
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
connectionTimeout - A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when
you initially establish a connection.RedshiftSettings.Builder databaseName(String databaseName)
The name of the Amazon Redshift data warehouse (service) that you are working with.
databaseName - The name of the Amazon Redshift data warehouse (service) that you are working with.RedshiftSettings.Builder dateFormat(String dateFormat)
The date format that you are using. Valid values are auto (case-sensitive), your date format
string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of
'YYYY-MM-DD'. Using auto recognizes most strings, even some that aren't supported when you use a
date format string.
If your date and time values use formats different from each other, set this to auto.
dateFormat - The date format that you are using. Valid values are auto (case-sensitive), your date
format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a
format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that aren't
supported when you use a date format string.
If your date and time values use formats different from each other, set this to auto.
RedshiftSettings.Builder emptyAsNull(Boolean emptyAsNull)
A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of
true sets empty CHAR and VARCHAR fields to null. The default is false.
emptyAsNull - A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of
true sets empty CHAR and VARCHAR fields to null. The default is false.RedshiftSettings.Builder encryptionMode(String encryptionMode)
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
SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of the
EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change
the existing value from SSE_S3 to SSE_KMS.
To use SSE_S3, create an Identity and Access Management (IAM) role with a policy that allows
"arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
encryptionMode - 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
SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of the
EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t
change the existing value from SSE_S3 to SSE_KMS.
To use SSE_S3, create an Identity and Access Management (IAM) role with a policy that
allows "arn:aws:s3:::*" to use the following actions:
"s3:PutObject", "s3:ListBucket"
EncryptionModeValue,
EncryptionModeValueRedshiftSettings.Builder encryptionMode(EncryptionModeValue encryptionMode)
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
SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of the
EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change
the existing value from SSE_S3 to SSE_KMS.
To use SSE_S3, create an Identity and Access Management (IAM) role with a policy that allows
"arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
encryptionMode - 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
SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of the
EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t
change the existing value from SSE_S3 to SSE_KMS.
To use SSE_S3, create an Identity and Access Management (IAM) role with a policy that
allows "arn:aws:s3:::*" to use the following actions:
"s3:PutObject", "s3:ListBucket"
EncryptionModeValue,
EncryptionModeValueRedshiftSettings.Builder explicitIds(Boolean explicitIds)
This setting is only valid for a full-load migration task. Set ExplicitIds to true
to have tables with IDENTITY columns override their auto-generated values with explicit values
loaded from the source data files used to populate the tables. The default is false.
explicitIds - This setting is only valid for a full-load migration task. Set ExplicitIds to
true to have tables with IDENTITY columns override their auto-generated
values with explicit values loaded from the source data files used to populate the tables. The default
is false.RedshiftSettings.Builder fileTransferUploadStreams(Integer fileTransferUploadStreams)
The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see Multipart upload overview.
FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10.
fileTransferUploadStreams - The number of threads used to upload a single file. This parameter accepts a value from 1 through 64.
It defaults to 10.
The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see Multipart upload overview.
FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10.
RedshiftSettings.Builder loadTimeout(Integer loadTimeout)
The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
loadTimeout - The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a
Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.RedshiftSettings.Builder maxFileSize(Integer maxFileSize)
The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB).
maxFileSize - The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to
Amazon Redshift. It defaults to 1048576KB (1 GB).RedshiftSettings.Builder password(String password)
The password for the user named in the username property.
password - The password for the user named in the username property.RedshiftSettings.Builder port(Integer port)
The port number for Amazon Redshift. The default value is 5439.
port - The port number for Amazon Redshift. The default value is 5439.RedshiftSettings.Builder removeQuotes(Boolean removeQuotes)
A value that specifies to remove surrounding quotation marks from strings in the incoming data. All
characters within the quotation marks, including delimiters, are retained. Choose true to remove
quotation marks. The default is false.
removeQuotes - A value that specifies to remove surrounding quotation marks from strings in the incoming data. All
characters within the quotation marks, including delimiters, are retained. Choose true to
remove quotation marks. The default is false.RedshiftSettings.Builder replaceInvalidChars(String replaceInvalidChars)
A list of characters that you want to replace. Use with ReplaceChars.
replaceInvalidChars - A list of characters that you want to replace. Use with ReplaceChars.RedshiftSettings.Builder replaceChars(String replaceChars)
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars,
substituting the specified characters instead. The default is "?".
replaceChars - A value that specifies to replaces the invalid characters specified in
ReplaceInvalidChars, substituting the specified characters instead. The default is
"?".RedshiftSettings.Builder serverName(String serverName)
The name of the Amazon Redshift cluster you are using.
serverName - The name of the Amazon Redshift cluster you are using.RedshiftSettings.Builder serviceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must
allow the iam:PassRole action.
serviceAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The
role must allow the iam:PassRole action.RedshiftSettings.Builder serverSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)
The KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key
ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the
key.
serverSideEncryptionKmsKeyId - The KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide
this key ID. The key that you use needs an attached policy that enables IAM user permissions and
allows use of the key.RedshiftSettings.Builder timeFormat(String timeFormat)
The time format that you want to use. Valid values are auto (case-sensitive),
'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to
10. Using auto recognizes most strings, even some that aren't supported when you use a time
format string.
If your date and time values use formats different from each other, set this parameter to auto.
timeFormat - The time format that you want to use. Valid values are auto (case-sensitive),
'timeformat_string', 'epochsecs', or 'epochmillisecs'. It
defaults to 10. Using auto recognizes most strings, even some that aren't supported when
you use a time format string.
If your date and time values use formats different from each other, set this parameter to
auto.
RedshiftSettings.Builder trimBlanks(Boolean trimBlanks)
A value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter
applies only to columns with a VARCHAR data type. Choose true to remove unneeded white space.
The default is false.
trimBlanks - A value that specifies to remove the trailing white space characters from a VARCHAR string. This
parameter applies only to columns with a VARCHAR data type. Choose true to remove
unneeded white space. The default is false.RedshiftSettings.Builder truncateColumns(Boolean truncateColumns)
A value that specifies to truncate data in columns to the appropriate number of characters, so that the data
fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a
size of 4 MB or less. Choose true to truncate data. The default is false.
truncateColumns - A value that specifies to truncate data in columns to the appropriate number of characters, so that
the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type,
and rows with a size of 4 MB or less. Choose true to truncate data. The default is
false.RedshiftSettings.Builder username(String username)
An Amazon Redshift user name for a registered user.
username - An Amazon Redshift user name for a registered user.RedshiftSettings.Builder writeBufferSize(Integer writeBufferSize)
The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).
writeBufferSize - The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk
at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).RedshiftSettings.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn)
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the
required permissions to access the value in SecretsManagerSecret. The role must allow the
iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services
Secrets Manager secret that allows access to the Amazon Redshift endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting
and SecretsManagerSecretId. Or you can specify clear-text values for UserName,
Password, ServerName, and Port. You can't specify both. For more
information on creating this SecretsManagerSecret and the
SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see
Using secrets to access Database Migration Service resources in the Database Migration Service User
Guide.
secretsManagerAccessRoleArn - The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and
grants the required permissions to access the value in SecretsManagerSecret. The role
must allow the iam:PassRole action. SecretsManagerSecret has the value of
the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this
setting and SecretsManagerSecretId. Or you can specify clear-text values for
UserName, Password, ServerName, and Port. You
can't specify both. For more information on creating this SecretsManagerSecret and the
SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access
it, see Using secrets to access Database Migration Service resources in the Database Migration Service
User Guide.
RedshiftSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon
Redshift endpoint connection details.
secretsManagerSecretId - The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the
Amazon Redshift endpoint connection details.RedshiftSettings.Builder mapBooleanAsBoolean(Boolean mapBooleanAsBoolean)
When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans as
varchar(1). You must set this setting on both the source and target endpoints for it to take
effect.
mapBooleanAsBoolean - When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans
as varchar(1). You must set this setting on both the source and target endpoints for it
to take effect.Copyright © 2023. All rights reserved.