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>

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() The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.
String	bucketName() The name of the S3 bucket you want to use
static RedshiftSettings.Builder	builder()
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 AWS 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)
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, beginning from when you begin loading.
Integer	maxFileSize() The maximum size (in KB) of any .csv file used to 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()
static Class<? extends RedshiftSettings.Builder>	serializableBuilderClass()
String	serverName() The name of the Amazon Redshift cluster you are using.
String	serverSideEncryptionKmsKeyId() The AWS 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 of the write buffer to use in rows.

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 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 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 String bucketFolder()

The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.

Returns:

The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.

bucketName

public String bucketName()

The name of the S3 bucket you want to use

Returns:

The name of the S3 bucket you want to use

connectionTimeout

public 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 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 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 Boolean emptyAsNull()

A value that 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.

Returns:

A value that 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.

encryptionMode

public 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. To use SSE_S3, create an AWS 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. To use SSE_S3, create an AWS 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 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. To use SSE_S3, create an AWS 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. To use SSE_S3, create an AWS 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

fileTransferUploadStreams

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

Returns:

The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.

loadTimeout

public Integer loadTimeout()

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

Returns:

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

maxFileSize

public Integer maxFileSize()

The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift. This accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).

Returns:

The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift. This accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).

password

public 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 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 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 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 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 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 String serviceAccessRoleArn()

The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.

Returns:

The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.

serverSideEncryptionKmsKeyId

public String serverSideEncryptionKmsKeyId()

The AWS 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 AWS 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 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 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 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 String username()

An Amazon Redshift user name for a registered user.

Returns:

An Amazon Redshift user name for a registered user.

writeBufferSize

public Integer writeBufferSize()

The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance.

Returns:

The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo