Package software.amazon.awscdk.services.dms

Class CfnEndpoint.PostgreSqlSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnEndpoint.PostgreSqlSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpoint.PostgreSqlSettingsProperty

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

An implementation for CfnEndpoint.PostgreSqlSettingsProperty

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

CfnEndpoint.PostgreSqlSettingsProperty.Builder, CfnEndpoint.PostgreSqlSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEndpoint.PostgreSqlSettingsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEndpoint.PostgreSqlSettingsProperty.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 String	getAfterConnectScript()	For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
final String	getBabelfishDatabaseName()	The Babelfish for Aurora PostgreSQL database name for the endpoint.
final Object	getCaptureDdls()	To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.
final String	getDatabaseMode()	Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
final String	getDdlArtifactsSchema()	The schema in which the operational DDL database artifacts are created.
final Number	getExecuteTimeout()	Sets the client statement timeout for the PostgreSQL instance, in seconds.
final Object	getFailTasksOnLobTruncation()	When set to true , this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize .
final Object	getHeartbeatEnable()	The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
final Number	getHeartbeatFrequency()	Sets the WAL heartbeat frequency (in minutes).
final String	getHeartbeatSchema()	Sets the schema in which the heartbeat artifacts are created.
final Object	getMapBooleanAsBoolean()	When true, lets PostgreSQL migrate the boolean type as boolean.
final Number	getMaxFileSize()	Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
final String	getPluginName()	Specifies the plugin to use to create a replication slot.
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 PostgreSQL endpoint connection details.
final String	getSlotName()	Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source 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.PostgreSqlSettingsProperty.Builder builder)

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

Method Details

getAfterConnectScript

public final String getAfterConnectScript()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.

Example: afterConnectScript=SET session_replication_role='replica'

Specified by:

getAfterConnectScript in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getBabelfishDatabaseName

public final String getBabelfishDatabaseName()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

The Babelfish for Aurora PostgreSQL database name for the endpoint.

Specified by:

getBabelfishDatabaseName in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getCaptureDdls

public final Object getCaptureDdls()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts.

You can later remove these artifacts.

If this value is set to True , you don't have to create tables or triggers on the source database.

Specified by:

getCaptureDdls in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getDatabaseMode

public final String getDatabaseMode()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.

Specified by:

getDatabaseMode in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getDdlArtifactsSchema

public final String getDdlArtifactsSchema()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

The schema in which the operational DDL database artifacts are created.

The default value is public .

Example: ddlArtifactsSchema=xyzddlschema;

Specified by:

getDdlArtifactsSchema in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getExecuteTimeout

public final Number getExecuteTimeout()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.

Example: executeTimeout=100;

Specified by:

getExecuteTimeout in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getFailTasksOnLobTruncation

public final Object getFailTasksOnLobTruncation()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

When set to true , this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize .

The default value is false .

If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

Specified by:

getFailTasksOnLobTruncation in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getHeartbeatEnable

public final Object getHeartbeatEnable()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.

By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps restart_lsn moving and prevents storage full scenarios.

The default value is false .

Specified by:

getHeartbeatEnable in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getHeartbeatFrequency

public final Number getHeartbeatFrequency()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

Sets the WAL heartbeat frequency (in minutes).

The default value is 5 minutes.

Specified by:

getHeartbeatFrequency in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getHeartbeatSchema

public final String getHeartbeatSchema()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

Sets the schema in which the heartbeat artifacts are created.

The default value is public .

Specified by:

getHeartbeatSchema in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getMapBooleanAsBoolean

public final Object getMapBooleanAsBoolean()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

When true, lets PostgreSQL migrate the boolean type as boolean.

By default, PostgreSQL migrates booleans as varchar(5) . You must set this setting on both the source and target endpoints for it to take effect.

The default value is false .

Specified by:

getMapBooleanAsBoolean in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getMaxFileSize

public final Number getMaxFileSize()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.

The default value is 32,768 KB (32 MB).

Example: maxFileSize=512

Specified by:

getMaxFileSize in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getPluginName

public final String getPluginName()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

Specifies the plugin to use to create a replication slot.

The default value is pglogical .

Specified by:

getPluginName in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getSecretsManagerAccessRoleArn

public final String getSecretsManagerAccessRoleArn()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

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 PostgreSQL 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.PostgreSqlSettingsProperty

See Also:

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

getSecretsManagerSecretId

public final String getSecretsManagerSecretId()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

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

Specified by:

getSecretsManagerSecretId in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

getSlotName

public final String getSlotName()

Description copied from interface: CfnEndpoint.PostgreSqlSettingsProperty

Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.

When used with the CdcStartPosition request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of CdcStartPosition . If the specified slot doesn't exist or the task doesn't have a valid CdcStartPosition setting, DMS raises an error.

For more information about setting the CdcStartPosition request parameter, see Determining a CDC native start point in the AWS Database Migration Service User Guide . For more information about using CdcStartPosition , see CreateReplicationTask , StartReplicationTask , and ModifyReplicationTask .

Specified by:

getSlotName in interface CfnEndpoint.PostgreSqlSettingsProperty

See Also:

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

$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