software.amazon.awssdk.services.databasemigration.model

Class RedshiftSettings

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.RedshiftSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RedshiftSettings.Builder,RedshiftSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class RedshiftSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RedshiftSettings.Builder,RedshiftSettings>

Provides information that defines an Amazon Redshift endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RedshiftSettings.Builder

Method Summary

Modifier and Type	Method and Description
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.
String	afterConnectScript() Code to run after connecting.
String	bucketFolder() An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
String	bucketName() The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
static RedshiftSettings.Builder	builder()
Boolean	caseSensitiveNames() If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true.
Boolean	compUpdate() If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
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.
String	databaseName() The name of the Amazon Redshift data warehouse (service) that you are working with.
String	dateFormat() The date format that you are using.
Boolean	emptyAsNull() A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL.
EncryptionModeValue	encryptionMode() The type of server-side encryption that you want to use for your data.
String	encryptionModeAsString() The type of server-side encryption that you want to use for your data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	explicitIds() This setting is only valid for a full-load migration task.
Integer	fileTransferUploadStreams() The number of threads used to upload a single file.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
Boolean	mapBooleanAsBoolean() When true, lets Redshift migrate the boolean type as boolean.
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.
String	password() The password for the user named in the username property.
Integer	port() The port number for Amazon Redshift.
Boolean	removeQuotes() A value that specifies to remove surrounding quotation marks from strings in the incoming data.
String	replaceChars() A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead.
String	replaceInvalidChars() A list of characters that you want to replace.
List<SdkField<?>>	sdkFields()
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.
String	secretsManagerSecretId() The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
static Class<? extends RedshiftSettings.Builder>	serializableBuilderClass()
String	serverName() The name of the Amazon Redshift cluster you are using.
String	serverSideEncryptionKmsKeyId() The KMS key ID.
String	serviceAccessRoleArn() The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
String	timeFormat() The time format that you want to use.
RedshiftSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	trimBlanks() A value that specifies to remove the trailing white space characters from a VARCHAR string.
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.
String	username() An Amazon Redshift user name for a registered user.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

acceptAnyDate

public final 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.

Returns:

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.

afterConnectScript

public final String afterConnectScript()

Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.

Returns:

Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.

bucketFolder

public final 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.

Returns:

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.

bucketName

public final String bucketName()

The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.

Returns:

The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.

caseSensitiveNames

public final Boolean caseSensitiveNames()

If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.

Returns:

If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.

compUpdate

public final 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.

Returns:

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.

connectionTimeout

public final 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.

Returns:

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

databaseName

public final String databaseName()

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

Returns:

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

dateFormat

public final 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.

Returns:

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.

emptyAsNull

public final 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.

Returns:

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.

encryptionMode

public final 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"

If the service returns an enum value that is not available in the current SDK version, encryptionMode will return EncryptionModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionModeAsString().

Returns:

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"

See Also:

EncryptionModeValue

encryptionModeAsString

public final String encryptionModeAsString()

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"

If the service returns an enum value that is not available in the current SDK version, encryptionMode will return EncryptionModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionModeAsString().

Returns:

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"

See Also:

EncryptionModeValue

explicitIds

public final 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.

Returns:

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.

fileTransferUploadStreams

public final 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.

Returns:

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.

loadTimeout

public final 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.

Returns:

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.

maxFileSize

public final 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).

Returns:

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

password

public final String password()

The password for the user named in the username property.

Returns:

The password for the user named in the username property.

port

public final Integer port()

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

Returns:

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

removeQuotes

public final 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.

Returns:

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.

replaceInvalidChars

public final String replaceInvalidChars()

A list of characters that you want to replace. Use with ReplaceChars.

Returns:

A list of characters that you want to replace. Use with ReplaceChars.

replaceChars

public final String replaceChars()

A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".

Returns:

A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".

serverName

public final String serverName()

The name of the Amazon Redshift cluster you are using.

Returns:

The name of the Amazon Redshift cluster you are using.

serviceAccessRoleArn

public final 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.

Returns:

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.

serverSideEncryptionKmsKeyId

public final 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.

Returns:

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.

timeFormat

public final 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.

Returns:

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.

trimBlanks

public final 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.

Returns:

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.

truncateColumns

public final 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.

Returns:

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.

username

public final String username()

An Amazon Redshift user name for a registered user.

Returns:

An Amazon Redshift user name for a registered user.

writeBufferSize

public final 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).

Returns:

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

secretsManagerAccessRoleArn

public final 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.

Returns:

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.

secretsManagerSecretId

public final String secretsManagerSecretId()

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.

Returns:

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.

mapBooleanAsBoolean

public final 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.

Returns:

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.

toBuilder

public RedshiftSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RedshiftSettings.Builder,RedshiftSettings>

builder

public static RedshiftSettings.Builder builder()

serializableBuilderClass

public static Class<? extends RedshiftSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo