RedshiftSettings.Builder (AWS Java SDK :: Services :: AWS Database Migration Service 2.10.56 API)

All Superinterfaces:

Buildable, CopyableBuilder<RedshiftSettings.Builder,RedshiftSettings>, SdkBuilder<RedshiftSettings.Builder,RedshiftSettings>, SdkPojo

Enclosing class:

RedshiftSettings
```
public static interface RedshiftSettings.Builder
extends SdkPojo, CopyableBuilder<RedshiftSettings.Builder,RedshiftSettings>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RedshiftSettings.Builder`	`acceptAnyDate(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.Builder`	`afterConnectScript(String afterConnectScript)` Code to run after connecting.
`RedshiftSettings.Builder`	`bucketFolder(String bucketFolder)` The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.
`RedshiftSettings.Builder`	`bucketName(String bucketName)` The name of the S3 bucket you want to use
`RedshiftSettings.Builder`	`connectionTimeout(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.Builder`	`databaseName(String databaseName)` The name of the Amazon Redshift data warehouse (service) that you are working with.
`RedshiftSettings.Builder`	`dateFormat(String dateFormat)` The date format that you are using.
`RedshiftSettings.Builder`	`emptyAsNull(Boolean emptyAsNull)` A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
`RedshiftSettings.Builder`	`encryptionMode(EncryptionModeValue encryptionMode)` The type of server-side encryption that you want to use for your data.
`RedshiftSettings.Builder`	`encryptionMode(String encryptionMode)` The type of server-side encryption that you want to use for your data.
`RedshiftSettings.Builder`	`fileTransferUploadStreams(Integer fileTransferUploadStreams)` The number of threads used to upload a single file.
`RedshiftSettings.Builder`	`loadTimeout(Integer loadTimeout)` The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
`RedshiftSettings.Builder`	`maxFileSize(Integer maxFileSize)` The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift.
`RedshiftSettings.Builder`	`password(String password)` The password for the user named in the `username` property.
`RedshiftSettings.Builder`	`port(Integer port)` The port number for Amazon Redshift.
`RedshiftSettings.Builder`	`removeQuotes(Boolean removeQuotes)` A value that specifies to remove surrounding quotation marks from strings in the incoming data.
`RedshiftSettings.Builder`	`replaceChars(String replaceChars)` A value that specifies to replaces the invalid characters specified in `ReplaceInvalidChars`, substituting the specified characters instead.
`RedshiftSettings.Builder`	`replaceInvalidChars(String replaceInvalidChars)` A list of characters that you want to replace.
`RedshiftSettings.Builder`	`serverName(String serverName)` The name of the Amazon Redshift cluster you are using.
`RedshiftSettings.Builder`	`serverSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)` The AWS KMS key ID.
`RedshiftSettings.Builder`	`serviceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
`RedshiftSettings.Builder`	`timeFormat(String timeFormat)` The time format that you want to use.
`RedshiftSettings.Builder`	`trimBlanks(Boolean trimBlanks)` A value that specifies to remove the trailing white space characters from a VARCHAR string.
`RedshiftSettings.Builder`	`truncateColumns(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.Builder`	`username(String username)` An Amazon Redshift user name for a registered user.
`RedshiftSettings.Builder`	`writeBufferSize(Integer writeBufferSize)` The size of the write buffer to use in rows.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - acceptAnyDate
```
RedshiftSettings.Builder acceptAnyDate(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - afterConnectScript
```
RedshiftSettings.Builder afterConnectScript(String afterConnectScript)
```
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    
    Parameters:
    
    afterConnectScript - Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - bucketFolder
```
RedshiftSettings.Builder bucketFolder(String bucketFolder)
```
    The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.
    
    Parameters:
    
    bucketFolder - The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - bucketName
```
RedshiftSettings.Builder bucketName(String bucketName)
```
    The name of the S3 bucket you want to use
    
    Parameters:
    
    bucketName - The name of the S3 bucket you want to use
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - connectionTimeout
```
RedshiftSettings.Builder connectionTimeout(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - databaseName
```
RedshiftSettings.Builder databaseName(String databaseName)
```
    The name of the Amazon Redshift data warehouse (service) that you are working with.
    
    Parameters:
    
    databaseName - The name of the Amazon Redshift data warehouse (service) that you are working with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dateFormat
```
RedshiftSettings.Builder dateFormat(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - emptyAsNull
```
RedshiftSettings.Builder emptyAsNull(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - encryptionMode
```
RedshiftSettings.Builder encryptionMode(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. 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"
    
    Parameters:
    
    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"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionModeValue, EncryptionModeValue
  - encryptionMode
```
RedshiftSettings.Builder encryptionMode(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"
    
    Parameters:
    
    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"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionModeValue, EncryptionModeValue
  - fileTransferUploadStreams
```
RedshiftSettings.Builder fileTransferUploadStreams(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - loadTimeout
```
RedshiftSettings.Builder loadTimeout(Integer loadTimeout)
```
    The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
    
    Parameters:
    
    loadTimeout - The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxFileSize
```
RedshiftSettings.Builder maxFileSize(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - password
```
RedshiftSettings.Builder password(String password)
```
    The password for the user named in the username property.
    
    Parameters:
    
    password - The password for the user named in the username property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - port
```
RedshiftSettings.Builder port(Integer port)
```
    The port number for Amazon Redshift. The default value is 5439.
    
    Parameters:
    
    port - The port number for Amazon Redshift. The default value is 5439.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - removeQuotes
```
RedshiftSettings.Builder removeQuotes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - replaceInvalidChars
```
RedshiftSettings.Builder replaceInvalidChars(String replaceInvalidChars)
```
    A list of characters that you want to replace. Use with ReplaceChars.
    
    Parameters:
    
    replaceInvalidChars - A list of characters that you want to replace. Use with ReplaceChars.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - replaceChars
```
RedshiftSettings.Builder replaceChars(String replaceChars)
```
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    
    Parameters:
    
    replaceChars - A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serverName
```
RedshiftSettings.Builder serverName(String serverName)
```
    The name of the Amazon Redshift cluster you are using.
    
    Parameters:
    
    serverName - The name of the Amazon Redshift cluster you are using.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serviceAccessRoleArn
```
RedshiftSettings.Builder serviceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serverSideEncryptionKmsKeyId
```
RedshiftSettings.Builder serverSideEncryptionKmsKeyId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeFormat
```
RedshiftSettings.Builder timeFormat(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - trimBlanks
```
RedshiftSettings.Builder trimBlanks(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - truncateColumns
```
RedshiftSettings.Builder truncateColumns(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - username
```
RedshiftSettings.Builder username(String username)
```
    An Amazon Redshift user name for a registered user.
    
    Parameters:
    
    username - An Amazon Redshift user name for a registered user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - writeBufferSize
```
RedshiftSettings.Builder writeBufferSize(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.

Interface RedshiftSettings.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

acceptAnyDate

afterConnectScript

bucketFolder

bucketName

connectionTimeout

databaseName

dateFormat

emptyAsNull

encryptionMode

encryptionMode

fileTransferUploadStreams

loadTimeout

maxFileSize

password

port

removeQuotes

replaceInvalidChars

replaceChars

serverName

serviceAccessRoleArn

serverSideEncryptionKmsKeyId

timeFormat

trimBlanks

truncateColumns

username

writeBufferSize