RedshiftSettings
Provides information that defines an Amazon Redshift endpoint.
Types
Properties
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).
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames
to true
. The default is false
.
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
.
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
The name of the Amazon Redshift data warehouse (service) that you are working with.
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.
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
.
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
.
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
.
The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
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.
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.
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).
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
.
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars
, substituting the specified characters instead. The default is "?"
.
A list of characters that you want to replace. Use with ReplaceChars
.
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.
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret
that contains the Amazon Redshift endpoint connection details.
The name of the Amazon Redshift cluster you are using.
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.
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.
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.
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
.
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
.
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).