@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RedshiftSettings extends Object implements Serializable, Cloneable, StructuredPojo
Provides information that defines an Amazon Redshift endpoint.
Constructor and Description |
---|
RedshiftSettings() |
Modifier and Type | Method and Description |
---|---|
RedshiftSettings |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAcceptAnyDate()
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.
|
String |
getAfterConnectScript()
Code to run after connecting.
|
String |
getBucketFolder()
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift
cluster.
|
String |
getBucketName()
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
|
Boolean |
getCaseSensitiveNames()
If Amazon Redshift is configured to support case sensitive schema names, set
CaseSensitiveNames to
true . |
Boolean |
getCompUpdate()
If you set
CompUpdate to true Amazon Redshift applies automatic compression if the
table is empty. |
Integer |
getConnectionTimeout()
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you
initially establish a connection.
|
String |
getDatabaseName()
The name of the Amazon Redshift data warehouse (service) that you are working with.
|
String |
getDateFormat()
The date format that you are using.
|
Boolean |
getEmptyAsNull()
A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL.
|
String |
getEncryptionMode()
The type of server-side encryption that you want to use for your data.
|
Boolean |
getExplicitIds()
This setting is only valid for a full-load migration task.
|
Integer |
getFileTransferUploadStreams()
The number of threads used to upload a single file.
|
Integer |
getLoadTimeout()
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.
|
Boolean |
getMapBooleanAsBoolean()
When true, lets Redshift migrate the boolean type as boolean.
|
Integer |
getMaxFileSize()
The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift.
|
String |
getPassword()
The password for the user named in the
username property. |
Integer |
getPort()
The port number for Amazon Redshift.
|
Boolean |
getRemoveQuotes()
A value that specifies to remove surrounding quotation marks from strings in the incoming data.
|
String |
getReplaceChars()
A value that specifies to replaces the invalid characters specified in
ReplaceInvalidChars ,
substituting the specified characters instead. |
String |
getReplaceInvalidChars()
A list of characters that you want to replace.
|
String |
getSecretsManagerAccessRoleArn()
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 . |
String |
getSecretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Amazon
Redshift endpoint connection details. |
String |
getServerName()
The name of the Amazon Redshift cluster you are using.
|
String |
getServerSideEncryptionKmsKeyId()
The KMS key ID.
|
String |
getServiceAccessRoleArn()
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
|
String |
getTimeFormat()
The time format that you want to use.
|
Boolean |
getTrimBlanks()
A value that specifies to remove the trailing white space characters from a VARCHAR string.
|
Boolean |
getTruncateColumns()
A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits
in the column.
|
String |
getUsername()
An Amazon Redshift user name for a registered user.
|
Integer |
getWriteBufferSize()
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.
|
int |
hashCode() |
Boolean |
isAcceptAnyDate()
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.
|
Boolean |
isCaseSensitiveNames()
If Amazon Redshift is configured to support case sensitive schema names, set
CaseSensitiveNames to
true . |
Boolean |
isCompUpdate()
If you set
CompUpdate to true Amazon Redshift applies automatic compression if the
table is empty. |
Boolean |
isEmptyAsNull()
A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL.
|
Boolean |
isExplicitIds()
This setting is only valid for a full-load migration task.
|
Boolean |
isMapBooleanAsBoolean()
When true, lets Redshift migrate the boolean type as boolean.
|
Boolean |
isRemoveQuotes()
A value that specifies to remove surrounding quotation marks from strings in the incoming data.
|
Boolean |
isTrimBlanks()
A value that specifies to remove the trailing white space characters from a VARCHAR string.
|
Boolean |
isTruncateColumns()
A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits
in the column.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAcceptAnyDate(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.
|
void |
setAfterConnectScript(String afterConnectScript)
Code to run after connecting.
|
void |
setBucketFolder(String bucketFolder)
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift
cluster.
|
void |
setBucketName(String bucketName)
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
|
void |
setCaseSensitiveNames(Boolean caseSensitiveNames)
If Amazon Redshift is configured to support case sensitive schema names, set
CaseSensitiveNames to
true . |
void |
setCompUpdate(Boolean compUpdate)
If you set
CompUpdate to true Amazon Redshift applies automatic compression if the
table is empty. |
void |
setConnectionTimeout(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.
|
void |
setDatabaseName(String databaseName)
The name of the Amazon Redshift data warehouse (service) that you are working with.
|
void |
setDateFormat(String dateFormat)
The date format that you are using.
|
void |
setEmptyAsNull(Boolean emptyAsNull)
A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL.
|
void |
setEncryptionMode(String encryptionMode)
The type of server-side encryption that you want to use for your data.
|
void |
setExplicitIds(Boolean explicitIds)
This setting is only valid for a full-load migration task.
|
void |
setFileTransferUploadStreams(Integer fileTransferUploadStreams)
The number of threads used to upload a single file.
|
void |
setLoadTimeout(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.
|
void |
setMapBooleanAsBoolean(Boolean mapBooleanAsBoolean)
When true, lets Redshift migrate the boolean type as boolean.
|
void |
setMaxFileSize(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.
|
void |
setPassword(String password)
The password for the user named in the
username property. |
void |
setPort(Integer port)
The port number for Amazon Redshift.
|
void |
setRemoveQuotes(Boolean removeQuotes)
A value that specifies to remove surrounding quotation marks from strings in the incoming data.
|
void |
setReplaceChars(String replaceChars)
A value that specifies to replaces the invalid characters specified in
ReplaceInvalidChars ,
substituting the specified characters instead. |
void |
setReplaceInvalidChars(String replaceInvalidChars)
A list of characters that you want to replace.
|
void |
setSecretsManagerAccessRoleArn(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 . |
void |
setSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Amazon
Redshift endpoint connection details. |
void |
setServerName(String serverName)
The name of the Amazon Redshift cluster you are using.
|
void |
setServerSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)
The KMS key ID.
|
void |
setServiceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
|
void |
setTimeFormat(String timeFormat)
The time format that you want to use.
|
void |
setTrimBlanks(Boolean trimBlanks)
A value that specifies to remove the trailing white space characters from a VARCHAR string.
|
void |
setTruncateColumns(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.
|
void |
setUsername(String username)
An Amazon Redshift user name for a registered user.
|
void |
setWriteBufferSize(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.
|
String |
toString()
Returns a string representation of this object.
|
RedshiftSettings |
withAcceptAnyDate(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 |
withAfterConnectScript(String afterConnectScript)
Code to run after connecting.
|
RedshiftSettings |
withBucketFolder(String bucketFolder)
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift
cluster.
|
RedshiftSettings |
withBucketName(String bucketName)
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
|
RedshiftSettings |
withCaseSensitiveNames(Boolean caseSensitiveNames)
If Amazon Redshift is configured to support case sensitive schema names, set
CaseSensitiveNames to
true . |
RedshiftSettings |
withCompUpdate(Boolean compUpdate)
If you set
CompUpdate to true Amazon Redshift applies automatic compression if the
table is empty. |
RedshiftSettings |
withConnectionTimeout(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 |
withDatabaseName(String databaseName)
The name of the Amazon Redshift data warehouse (service) that you are working with.
|
RedshiftSettings |
withDateFormat(String dateFormat)
The date format that you are using.
|
RedshiftSettings |
withEmptyAsNull(Boolean emptyAsNull)
A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL.
|
RedshiftSettings |
withEncryptionMode(EncryptionModeValue encryptionMode)
The type of server-side encryption that you want to use for your data.
|
RedshiftSettings |
withEncryptionMode(String encryptionMode)
The type of server-side encryption that you want to use for your data.
|
RedshiftSettings |
withExplicitIds(Boolean explicitIds)
This setting is only valid for a full-load migration task.
|
RedshiftSettings |
withFileTransferUploadStreams(Integer fileTransferUploadStreams)
The number of threads used to upload a single file.
|
RedshiftSettings |
withLoadTimeout(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 |
withMapBooleanAsBoolean(Boolean mapBooleanAsBoolean)
When true, lets Redshift migrate the boolean type as boolean.
|
RedshiftSettings |
withMaxFileSize(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 |
withPassword(String password)
The password for the user named in the
username property. |
RedshiftSettings |
withPort(Integer port)
The port number for Amazon Redshift.
|
RedshiftSettings |
withRemoveQuotes(Boolean removeQuotes)
A value that specifies to remove surrounding quotation marks from strings in the incoming data.
|
RedshiftSettings |
withReplaceChars(String replaceChars)
A value that specifies to replaces the invalid characters specified in
ReplaceInvalidChars ,
substituting the specified characters instead. |
RedshiftSettings |
withReplaceInvalidChars(String replaceInvalidChars)
A list of characters that you want to replace.
|
RedshiftSettings |
withSecretsManagerAccessRoleArn(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 |
withSecretsManagerSecretId(String secretsManagerSecretId)
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Amazon
Redshift endpoint connection details. |
RedshiftSettings |
withServerName(String serverName)
The name of the Amazon Redshift cluster you are using.
|
RedshiftSettings |
withServerSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)
The KMS key ID.
|
RedshiftSettings |
withServiceAccessRoleArn(String serviceAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
|
RedshiftSettings |
withTimeFormat(String timeFormat)
The time format that you want to use.
|
RedshiftSettings |
withTrimBlanks(Boolean trimBlanks)
A value that specifies to remove the trailing white space characters from a VARCHAR string.
|
RedshiftSettings |
withTruncateColumns(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 |
withUsername(String username)
An Amazon Redshift user name for a registered user.
|
RedshiftSettings |
withWriteBufferSize(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.
|
public void setAcceptAnyDate(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.
public Boolean getAcceptAnyDate()
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.
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.
public RedshiftSettings withAcceptAnyDate(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.
public Boolean isAcceptAnyDate()
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.
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.
public void setAfterConnectScript(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.public String getAfterConnectScript()
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
public RedshiftSettings withAfterConnectScript(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.public void setBucketFolder(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.
public String getBucketFolder()
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.
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.
public RedshiftSettings withBucketFolder(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.
public void setBucketName(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.public String getBucketName()
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
public RedshiftSettings withBucketName(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.public void setCaseSensitiveNames(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
.public Boolean getCaseSensitiveNames()
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames
to
true
. The default is false
.
CaseSensitiveNames
to true
. The default is false
.public RedshiftSettings withCaseSensitiveNames(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
.public Boolean isCaseSensitiveNames()
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames
to
true
. The default is false
.
CaseSensitiveNames
to true
. The default is false
.public void setCompUpdate(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
.public Boolean getCompUpdate()
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
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
.public RedshiftSettings withCompUpdate(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
.public Boolean isCompUpdate()
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
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
.public void setConnectionTimeout(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.public Integer getConnectionTimeout()
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
public RedshiftSettings withConnectionTimeout(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.public void setDatabaseName(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.public String getDatabaseName()
The name of the Amazon Redshift data warehouse (service) that you are working with.
public RedshiftSettings withDatabaseName(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.public void setDateFormat(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
.
public String getDateFormat()
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
.
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
.
public RedshiftSettings withDateFormat(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
.
public void setEmptyAsNull(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
.public Boolean getEmptyAsNull()
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
.
true
sets empty CHAR and VARCHAR fields to null. The default is false
.public RedshiftSettings withEmptyAsNull(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
.public Boolean isEmptyAsNull()
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
.
true
sets empty CHAR and VARCHAR fields to null. The default is false
.public void setEncryptionMode(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
public String getEncryptionMode()
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"
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
public RedshiftSettings withEncryptionMode(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
public RedshiftSettings withEncryptionMode(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
public void setExplicitIds(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
.public Boolean getExplicitIds()
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
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
.public RedshiftSettings withExplicitIds(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
.public Boolean isExplicitIds()
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
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
.public void setFileTransferUploadStreams(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.
public Integer getFileTransferUploadStreams()
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.
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.
public RedshiftSettings withFileTransferUploadStreams(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.
public void setLoadTimeout(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.public Integer getLoadTimeout()
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.
public RedshiftSettings withLoadTimeout(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.public void setMaxFileSize(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).public Integer getMaxFileSize()
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).
public RedshiftSettings withMaxFileSize(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).public void setPassword(String password)
The password for the user named in the username
property.
password
- The password for the user named in the username
property.public String getPassword()
The password for the user named in the username
property.
username
property.public RedshiftSettings withPassword(String password)
The password for the user named in the username
property.
password
- The password for the user named in the username
property.public void setPort(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.public Integer getPort()
The port number for Amazon Redshift. The default value is 5439.
public RedshiftSettings withPort(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.public void setRemoveQuotes(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
.public Boolean getRemoveQuotes()
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
.
true
to
remove quotation marks. The default is false
.public RedshiftSettings withRemoveQuotes(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
.public Boolean isRemoveQuotes()
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
.
true
to
remove quotation marks. The default is false
.public void setReplaceInvalidChars(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
.public String getReplaceInvalidChars()
A list of characters that you want to replace. Use with ReplaceChars
.
ReplaceChars
.public RedshiftSettings withReplaceInvalidChars(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
.public void setReplaceChars(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 "?"
.public String getReplaceChars()
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars
,
substituting the specified characters instead. The default is "?"
.
ReplaceInvalidChars
,
substituting the specified characters instead. The default is "?"
.public RedshiftSettings withReplaceChars(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 "?"
.public void setServerName(String serverName)
The name of the Amazon Redshift cluster you are using.
serverName
- The name of the Amazon Redshift cluster you are using.public String getServerName()
The name of the Amazon Redshift cluster you are using.
public RedshiftSettings withServerName(String serverName)
The name of the Amazon Redshift cluster you are using.
serverName
- The name of the Amazon Redshift cluster you are using.public void setServiceAccessRoleArn(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.public String getServiceAccessRoleArn()
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.
iam:PassRole
action.public RedshiftSettings withServiceAccessRoleArn(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.public void setServerSideEncryptionKmsKeyId(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.public String getServerSideEncryptionKmsKeyId()
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.
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.public RedshiftSettings withServerSideEncryptionKmsKeyId(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.public void setTimeFormat(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
.
public String getTimeFormat()
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
.
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
.
public RedshiftSettings withTimeFormat(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
.
public void setTrimBlanks(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
.public Boolean getTrimBlanks()
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
.
true
to remove unneeded
white space. The default is false
.public RedshiftSettings withTrimBlanks(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
.public Boolean isTrimBlanks()
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
.
true
to remove unneeded
white space. The default is false
.public void setTruncateColumns(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
.public Boolean getTruncateColumns()
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
.
true
to truncate data. The default is
false
.public RedshiftSettings withTruncateColumns(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
.public Boolean isTruncateColumns()
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
.
true
to truncate data. The default is
false
.public void setUsername(String username)
An Amazon Redshift user name for a registered user.
username
- An Amazon Redshift user name for a registered user.public String getUsername()
An Amazon Redshift user name for a registered user.
public RedshiftSettings withUsername(String username)
An Amazon Redshift user name for a registered user.
username
- An Amazon Redshift user name for a registered user.public void setWriteBufferSize(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).public Integer getWriteBufferSize()
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).
public RedshiftSettings withWriteBufferSize(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).public void setSecretsManagerAccessRoleArn(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.
public String getSecretsManagerAccessRoleArn()
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.
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.
public RedshiftSettings withSecretsManagerAccessRoleArn(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.
public void setSecretsManagerSecretId(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.public String getSecretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Amazon
Redshift endpoint connection details.
SecretsManagerSecret
that contains the
Amazon Redshift endpoint connection details.public RedshiftSettings withSecretsManagerSecretId(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.public void setMapBooleanAsBoolean(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.public Boolean getMapBooleanAsBoolean()
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.
varchar(1)
. You must set this setting on both the source and target endpoints for it to take
effect.public RedshiftSettings withMapBooleanAsBoolean(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.public Boolean isMapBooleanAsBoolean()
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.
varchar(1)
. You must set this setting on both the source and target endpoints for it to take
effect.public String toString()
toString
in class Object
Object.toString()
public RedshiftSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.