AWS Database Migration Service
API Reference (API Version 2016-01-01)

RedshiftSettings

Contents

AcceptAnyDate

Allows 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 (default).

This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

Type: Boolean

Required: No

AfterConnectScript

Code to run after connecting. This should be the code, not a filename.

Type: String

Required: No

BucketFolder

The location where the CSV files are stored before being uploaded to the S3 bucket.

Type: String

Required: No

BucketName

The name of the S3 bucket you want to use

Type: String

Required: No

ConnectionTimeout

Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

Type: Integer

Required: No

DatabaseName

The name of the Amazon Redshift data warehouse (service) you are working with.

Type: String

Required: No

DateFormat

The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

If your date and time values use formats different from each other, set this to auto.

Type: String

Required: No

EmptyAsNull

Specifies whether AWS 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.

Type: Boolean

Required: No

EncryptionMode

The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".

Type: String

Valid Values: sse-s3 | sse-kms

Required: No

FileTransferUploadStreams

Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

Type: Integer

Required: No

LoadTimeout

Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

Type: Integer

Required: No

MaxFileSize

Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

Type: Integer

Required: No

Password

The password for the user named in the username property.

Type: String

Required: No

Port

The port number for Amazon Redshift. The default value is 5439.

Type: Integer

Required: No

RemoveQuotes

Removes 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.

Type: Boolean

Required: No

ReplaceChars

Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".

Type: String

Required: No

ReplaceInvalidChars

A list of chars you want to replace. Use with ReplaceChars.

Type: String

Required: No

ServerName

The name of the Amazon Redshift cluster you are using.

Type: String

Required: No

ServerSideEncryptionKmsKeyId

If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

Type: String

Required: No

ServiceAccessRoleArn

The ARN of the role that has access to the Redshift service.

Type: String

Required: No

TimeFormat

The time format 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 are not supported when you use a time format string.

If your date and time values use formats different from each other, set this to auto.

Type: String

Required: No

TrimBlanks

Removes 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.

Type: Boolean

Required: No

TruncateColumns

Truncates data in columns to the appropriate number of characters, so that it fits in the column. 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.

Type: Boolean

Required: No

Username

An Amazon Redshift user name for a registered user.

Type: String

Required: No

WriteBufferSize

The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: