Class CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEndpointPropsMixin.RedshiftSettingsProperty>
- Enclosing interface:
CfnEndpointPropsMixin.RedshiftSettingsProperty
CfnEndpointPropsMixin.RedshiftSettingsProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionacceptAnyDate(Boolean acceptAnyDate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getAcceptAnyDate()acceptAnyDate(IResolvable acceptAnyDate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getAcceptAnyDate()afterConnectScript(String afterConnectScript) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getAfterConnectScript()bucketFolder(String bucketFolder) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getBucketFolder()bucketName(String bucketName) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getBucketName()build()Builds the configured instance.caseSensitiveNames(Boolean caseSensitiveNames) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCaseSensitiveNames()caseSensitiveNames(IResolvable caseSensitiveNames) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCaseSensitiveNames()compUpdate(Boolean compUpdate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCompUpdate()compUpdate(IResolvable compUpdate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCompUpdate()connectionTimeout(Number connectionTimeout) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getConnectionTimeout()dateFormat(String dateFormat) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getDateFormat()emptyAsNull(Boolean emptyAsNull) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getEmptyAsNull()emptyAsNull(IResolvable emptyAsNull) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getEmptyAsNull()encryptionMode(String encryptionMode) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getEncryptionMode()explicitIds(Boolean explicitIds) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getExplicitIds()explicitIds(IResolvable explicitIds) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getExplicitIds()fileTransferUploadStreams(Number fileTransferUploadStreams) loadTimeout(Number loadTimeout) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getLoadTimeout()mapBooleanAsBoolean(Boolean mapBooleanAsBoolean) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getMapBooleanAsBoolean()mapBooleanAsBoolean(IResolvable mapBooleanAsBoolean) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getMapBooleanAsBoolean()maxFileSize(Number maxFileSize) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getMaxFileSize()removeQuotes(Boolean removeQuotes) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getRemoveQuotes()removeQuotes(IResolvable removeQuotes) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getRemoveQuotes()replaceChars(String replaceChars) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getReplaceChars()replaceInvalidChars(String replaceInvalidChars) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getReplaceInvalidChars()secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) secretsManagerSecretId(String secretsManagerSecretId) serverSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId) serviceAccessRoleArn(String serviceAccessRoleArn) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getServiceAccessRoleArn()timeFormat(String timeFormat) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTimeFormat()trimBlanks(Boolean trimBlanks) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTrimBlanks()trimBlanks(IResolvable trimBlanks) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTrimBlanks()truncateColumns(Boolean truncateColumns) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTruncateColumns()truncateColumns(IResolvable truncateColumns) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTruncateColumns()writeBufferSize(Number writeBufferSize) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getWriteBufferSize()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
acceptAnyDate
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder acceptAnyDate(Boolean acceptAnyDate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getAcceptAnyDate()- 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 choosetrueorfalse(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:
this
-
acceptAnyDate
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder acceptAnyDate(IResolvable acceptAnyDate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getAcceptAnyDate()- 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 choosetrueorfalse(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:
this
-
afterConnectScript
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder afterConnectScript(String afterConnectScript) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getAfterConnectScript()- Parameters:
afterConnectScript- Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.- Returns:
this
-
bucketFolder
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder bucketFolder(String bucketFolder) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getBucketFolder()- Parameters:
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, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS DMS uses the RedshiftCOPYcommand to upload the .csv files to the target table. The files are deleted once theCOPYoperation has finished. For more information, see COPY in the Amazon Redshift Database Developer Guide .For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
- Returns:
this
-
bucketName
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder bucketName(String bucketName) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getBucketName()- Parameters:
bucketName- The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.- Returns:
this
-
caseSensitiveNames
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder caseSensitiveNames(Boolean caseSensitiveNames) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCaseSensitiveNames()- Parameters:
caseSensitiveNames- If Amazon Redshift is configured to support case sensitive schema names, setCaseSensitiveNamestotrue. The default isfalse.- Returns:
this
-
caseSensitiveNames
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder caseSensitiveNames(IResolvable caseSensitiveNames) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCaseSensitiveNames()- Parameters:
caseSensitiveNames- If Amazon Redshift is configured to support case sensitive schema names, setCaseSensitiveNamestotrue. The default isfalse.- Returns:
this
-
compUpdate
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder compUpdate(Boolean compUpdate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCompUpdate()- Parameters:
compUpdate- If you setCompUpdatetotrueAmazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other thanRAW. If you setCompUpdatetofalse, automatic compression is disabled and existing column encodings aren't changed. The default istrue.- Returns:
this
-
compUpdate
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder compUpdate(IResolvable compUpdate) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getCompUpdate()- Parameters:
compUpdate- If you setCompUpdatetotrueAmazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other thanRAW. If you setCompUpdatetofalse, automatic compression is disabled and existing column encodings aren't changed. The default istrue.- Returns:
this
-
connectionTimeout
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder connectionTimeout(Number connectionTimeout) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getConnectionTimeout()- 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:
this
-
dateFormat
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder dateFormat(String dateFormat) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getDateFormat()- Parameters:
dateFormat- The date format that you are using. Valid values areauto(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'. Usingautorecognizes 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:
this
-
emptyAsNull
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder emptyAsNull(Boolean emptyAsNull) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getEmptyAsNull()- Parameters:
emptyAsNull- A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value oftruesets empty CHAR and VARCHAR fields to null. The default isfalse.- Returns:
this
-
emptyAsNull
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder emptyAsNull(IResolvable emptyAsNull) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getEmptyAsNull()- Parameters:
emptyAsNull- A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value oftruesets empty CHAR and VARCHAR fields to null. The default isfalse.- Returns:
this
-
encryptionMode
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder encryptionMode(String encryptionMode) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getEncryptionMode()- 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 eitherSSE_S3(the default) orSSE_KMS.For the
ModifyEndpointoperation, you can change the existing value of theEncryptionModeparameter fromSSE_KMStoSSE_S3. But you can’t change the existing value fromSSE_S3toSSE_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:
this
-
explicitIds
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder explicitIds(Boolean explicitIds) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getExplicitIds()- Parameters:
explicitIds- This setting is only valid for a full-load migration task. SetExplicitIdstotrueto have tables withIDENTITYcolumns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default isfalse.- Returns:
this
-
explicitIds
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder explicitIds(IResolvable explicitIds) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getExplicitIds()- Parameters:
explicitIds- This setting is only valid for a full-load migration task. SetExplicitIdstotrueto have tables withIDENTITYcolumns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default isfalse.- Returns:
this
-
fileTransferUploadStreams
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder fileTransferUploadStreams(Number fileTransferUploadStreams) - 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.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 .
FileTransferUploadStreamsaccepts a value from 1 through 64. It defaults to 10.- Returns:
this
-
loadTimeout
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder loadTimeout(Number loadTimeout) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getLoadTimeout()- Parameters:
loadTimeout- The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.- Returns:
this
-
mapBooleanAsBoolean
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder mapBooleanAsBoolean(Boolean mapBooleanAsBoolean) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getMapBooleanAsBoolean()- Parameters:
mapBooleanAsBoolean- When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans asvarchar(1). You must set this setting on both the source and target endpoints for it to take effect.- Returns:
this
-
mapBooleanAsBoolean
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder mapBooleanAsBoolean(IResolvable mapBooleanAsBoolean) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getMapBooleanAsBoolean()- Parameters:
mapBooleanAsBoolean- When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans asvarchar(1). You must set this setting on both the source and target endpoints for it to take effect.- Returns:
this
-
maxFileSize
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder maxFileSize(Number maxFileSize) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getMaxFileSize()- Parameters:
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:
this
-
removeQuotes
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder removeQuotes(Boolean removeQuotes) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getRemoveQuotes()- 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. Choosetrueto remove quotation marks. The default isfalse.- Returns:
this
-
removeQuotes
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder removeQuotes(IResolvable removeQuotes) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getRemoveQuotes()- 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. Choosetrueto remove quotation marks. The default isfalse.- Returns:
this
-
replaceChars
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder replaceChars(String replaceChars) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getReplaceChars()- Parameters:
replaceChars- A value that specifies to replaces the invalid characters specified inReplaceInvalidChars, substituting the specified characters instead. The default is"?".- Returns:
this
-
replaceInvalidChars
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder replaceInvalidChars(String replaceInvalidChars) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getReplaceInvalidChars()- Parameters:
replaceInvalidChars- A list of characters that you want to replace. Use withReplaceChars.- Returns:
this
-
secretsManagerAccessRoleArn
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder secretsManagerAccessRoleArn(String secretsManagerAccessRoleArn) - Parameters:
secretsManagerAccessRoleArn- The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value inSecretsManagerSecret. The role must allow theiam:PassRoleaction.SecretsManagerSecrethas the value of the AWS 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 forUserName,Password,ServerName, andPort. You can't specify both.For more information on creating this
SecretsManagerSecret, the correspondingSecretsManagerAccessRoleArn, and theSecretsManagerSecretIdthat is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .- Returns:
this
-
secretsManagerSecretId
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder secretsManagerSecretId(String secretsManagerSecretId) - Parameters:
secretsManagerSecretId- The full ARN, partial ARN, or display name of theSecretsManagerSecretthat contains the Amazon Redshift endpoint connection details.- Returns:
this
-
serverSideEncryptionKmsKeyId
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder serverSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId) - Parameters:
serverSideEncryptionKmsKeyId- The AWS key ID. If you are usingSSE_KMSfor theEncryptionMode, 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:
this
-
serviceAccessRoleArn
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder serviceAccessRoleArn(String serviceAccessRoleArn) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getServiceAccessRoleArn()- Parameters:
serviceAccessRoleArn- The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow theiam:PassRoleaction.- Returns:
this
-
timeFormat
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder timeFormat(String timeFormat) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTimeFormat()- Parameters:
timeFormat- The time format that you want to use. Valid values areauto(case-sensitive),'timeformat_string','epochsecs', or'epochmillisecs'. It defaults to 10. Usingautorecognizes 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:
this
-
trimBlanks
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder trimBlanks(Boolean trimBlanks) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTrimBlanks()- 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. Choosetrueto remove unneeded white space. The default isfalse.- Returns:
this
-
trimBlanks
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder trimBlanks(IResolvable trimBlanks) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTrimBlanks()- 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. Choosetrueto remove unneeded white space. The default isfalse.- Returns:
this
-
truncateColumns
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder truncateColumns(Boolean truncateColumns) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTruncateColumns()- 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. Choosetrueto truncate data. The default isfalse.- Returns:
this
-
truncateColumns
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder truncateColumns(IResolvable truncateColumns) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getTruncateColumns()- 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. Choosetrueto truncate data. The default isfalse.- Returns:
this
-
writeBufferSize
@Stability(Stable) public CfnEndpointPropsMixin.RedshiftSettingsProperty.Builder writeBufferSize(Number writeBufferSize) Sets the value ofCfnEndpointPropsMixin.RedshiftSettingsProperty.getWriteBufferSize()- Parameters:
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:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnEndpointPropsMixin.RedshiftSettingsProperty>- Returns:
- a new instance of
CfnEndpointPropsMixin.RedshiftSettingsProperty - Throws:
NullPointerException- if any required attribute was not provided
-