Package software.amazon.awscdk.services.dms

Class CfnEndpoint.RedshiftSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.dms.CfnEndpoint.RedshiftSettingsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnEndpoint.RedshiftSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpoint.RedshiftSettingsProperty

@Stability(Stable)
@Internal
public static final class CfnEndpoint.RedshiftSettingsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEndpoint.RedshiftSettingsProperty

An implementation for CfnEndpoint.RedshiftSettingsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dms.CfnEndpoint.RedshiftSettingsProperty

CfnEndpoint.RedshiftSettingsProperty.Builder, CfnEndpoint.RedshiftSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEndpoint.RedshiftSettingsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEndpoint.RedshiftSettingsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAcceptAnyDate()	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.
final String	getAfterConnectScript()	Code to run after connecting.
final String	getBucketFolder()	An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
final String	getBucketName()	The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
final Object	getCaseSensitiveNames()	If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true .
final Object	getCompUpdate()	If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
final Number	getConnectionTimeout()	A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
final String	getDateFormat()	The date format that you are using.
final Object	getEmptyAsNull()	A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
final String	getEncryptionMode()	The type of server-side encryption that you want to use for your data.
final Object	getExplicitIds()	This setting is only valid for a full-load migration task.
final Number	getFileTransferUploadStreams()	The number of threads used to upload a single file.
final Number	getLoadTimeout()	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.
final Object	getMapBooleanAsBoolean()	When true, lets Redshift migrate the boolean type as boolean.
final Number	getMaxFileSize()	The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift.
final Object	getRemoveQuotes()	A value that specifies to remove surrounding quotation marks from strings in the incoming data.
final String	getReplaceChars()	A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead.
final String	getReplaceInvalidChars()	A list of characters that you want to replace.
final String	getSecretsManagerAccessRoleArn()	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 in SecretsManagerSecret .
final String	getSecretsManagerSecretId()	The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
final String	getServerSideEncryptionKmsKeyId()	The AWS KMS key ID.
final String	getServiceAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
final String	getTimeFormat()	The time format that you want to use.
final Object	getTrimBlanks()	A value that specifies to remove the trailing white space characters from a VARCHAR string.
final Object	getTruncateColumns()	A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
final Number	getWriteBufferSize()	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.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnEndpoint.RedshiftSettingsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEndpoint.RedshiftSettingsProperty.Builder.

Method Details

getAcceptAnyDate

public final Object getAcceptAnyDate()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getAcceptAnyDate in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-acceptanydate

getAfterConnectScript

public final String getAfterConnectScript()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

Code to run after connecting.

This parameter should contain the code itself, not the name of a file containing the code.

Specified by:

getAfterConnectScript in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-afterconnectscript

getBucketFolder

public final String getBucketFolder()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 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, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.

Specified by:

getBucketFolder in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-bucketfolder

getBucketName

public final String getBucketName()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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

Specified by:

getBucketName in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-bucketname

getCaseSensitiveNames

public final Object getCaseSensitiveNames()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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

The default is false .

Returns union: either Boolean or IResolvable

Specified by:

getCaseSensitiveNames in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-casesensitivenames

getCompUpdate

public final Object getCompUpdate()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getCompUpdate in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-compupdate

getConnectionTimeout

public final Number getConnectionTimeout()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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

Specified by:

getConnectionTimeout in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-connectiontimeout

getDateFormat

public final String getDateFormat()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 .

Specified by:

getDateFormat in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-dateformat

getEmptyAsNull

public final Object getEmptyAsNull()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getEmptyAsNull in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-emptyasnull

getEncryptionMode

public final String getEncryptionMode()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 AWS Identity and Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"

Specified by:

getEncryptionMode in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-encryptionmode

getExplicitIds

public final Object getExplicitIds()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getExplicitIds in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-explicitids

getFileTransferUploadStreams

public final Number getFileTransferUploadStreams()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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.

Specified by:

getFileTransferUploadStreams in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-filetransferuploadstreams

getLoadTimeout

public final Number getLoadTimeout()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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.

Specified by:

getLoadTimeout in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-loadtimeout

getMapBooleanAsBoolean

public final Object getMapBooleanAsBoolean()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getMapBooleanAsBoolean in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-mapbooleanasboolean

getMaxFileSize

public final Number getMaxFileSize()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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

Specified by:

getMaxFileSize in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-maxfilesize

getRemoveQuotes

public final Object getRemoveQuotes()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getRemoveQuotes in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-removequotes

getReplaceChars

public final String getReplaceChars()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars , substituting the specified characters instead.

The default is "?" .

Specified by:

getReplaceChars in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-replacechars

getReplaceInvalidChars

public final String getReplaceInvalidChars()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

A list of characters that you want to replace.

Use with ReplaceChars .

Specified by:

getReplaceInvalidChars in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-replaceinvalidchars

getSecretsManagerAccessRoleArn

public final String getSecretsManagerAccessRoleArn()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 in SecretsManagerSecret .

The role must allow the iam:PassRole action. SecretsManagerSecret has 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 for UserName , Password , ServerName , and Port . You can't specify both.

For more information on creating this SecretsManagerSecret , the corresponding SecretsManagerAccessRoleArn , and the SecretsManagerSecretId that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

Specified by:

getSecretsManagerAccessRoleArn in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-secretsmanageraccessrolearn

getSecretsManagerSecretId

public final String getSecretsManagerSecretId()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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

Specified by:

getSecretsManagerSecretId in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-secretsmanagersecretid

getServerSideEncryptionKmsKeyId

public final String getServerSideEncryptionKmsKeyId()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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.

Specified by:

getServerSideEncryptionKmsKeyId in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-serversideencryptionkmskeyid

getServiceAccessRoleArn

public final String getServiceAccessRoleArn()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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.

Specified by:

getServiceAccessRoleArn in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-serviceaccessrolearn

getTimeFormat

public final String getTimeFormat()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 .

Specified by:

getTimeFormat in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-timeformat

getTrimBlanks

public final Object getTrimBlanks()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getTrimBlanks in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-trimblanks

getTruncateColumns

public final Object getTruncateColumns()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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 union: either Boolean or IResolvable

Specified by:

getTruncateColumns in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-truncatecolumns

getWriteBufferSize

public final Number getWriteBufferSize()

Description copied from interface: CfnEndpoint.RedshiftSettingsProperty

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

Specified by:

getWriteBufferSize in interface CfnEndpoint.RedshiftSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html#cfn-dms-endpoint-redshiftsettings-writebuffersize

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object