software.amazon.awscdk.services.dms

Interface CfnEndpoint.GcpMySQLSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.GcpMySQLSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(value=Stable)
public static interface CfnEndpoint.GcpMySQLSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Provides information that defines a GCP MySQL endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source for AWS DMS in the AWS Database Migration Service User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 GcpMySQLSettingsProperty gcpMySQLSettingsProperty = GcpMySQLSettingsProperty.builder()
         .afterConnectScript("afterConnectScript")
         .cleanSourceMetadataOnMismatch(false)
         .databaseName("databaseName")
         .eventsPollInterval(123)
         .maxFileSize(123)
         .parallelLoadThreads(123)
         .password("password")
         .port(123)
         .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
         .secretsManagerSecretId("secretsManagerSecretId")
         .serverName("serverName")
         .serverTimezone("serverTimezone")
         .username("username")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEndpoint.GcpMySQLSettingsProperty.Builder A builder for CfnEndpoint.GcpMySQLSettingsProperty
static class	CfnEndpoint.GcpMySQLSettingsProperty.Jsii$Proxy An implementation for CfnEndpoint.GcpMySQLSettingsProperty

Method Summary

Modifier and Type	Method and Description
static CfnEndpoint.GcpMySQLSettingsProperty.Builder	builder()
default String	getAfterConnectScript() Specifies a script to run immediately after AWS DMS connects to the endpoint.
default Object	getCleanSourceMetadataOnMismatch() Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster.
default String	getDatabaseName() Database name for the endpoint.
default Number	getEventsPollInterval() Specifies how often to check the binary log for new changes/events when the database is idle.
default Number	getMaxFileSize() Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
default Number	getParallelLoadThreads() Improves performance when loading data into the MySQL-compatible target database.
default String	getPassword() Endpoint connection password.
default Number	getPort() The port used by the endpoint database.
default 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.` The role must allow the `iam:PassRole` action.
default String	getSecretsManagerSecretId() The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details.
default String	getServerName() Endpoint TCP port.
default String	getServerTimezone() Specifies the time zone for the source MySQL database.
default String	getUsername() Endpoint connection user name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAfterConnectScript

@Stability(value=Stable)
 @Nullable
default String getAfterConnectScript()

Specifies a script to run immediately after AWS DMS connects to the endpoint.

The migration task continues running regardless if the SQL statement succeeds or fails.

For this parameter, provide the code of the script itself, not the name of a file containing the script.

getCleanSourceMetadataOnMismatch

@Stability(value=Stable)
 @Nullable
default Object getCleanSourceMetadataOnMismatch()

Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster.

If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .

getDatabaseName

@Stability(value=Stable)
 @Nullable
default String getDatabaseName()

Database name for the endpoint.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the AWS DMS task.

getEventsPollInterval

@Stability(value=Stable)
 @Nullable
default Number getEventsPollInterval()

Specifies how often to check the binary log for new changes/events when the database is idle.

The default is five seconds.

Example: eventsPollInterval=5;

In the example, AWS DMS checks for changes in the binary logs every five seconds.

getMaxFileSize

@Stability(value=Stable)
 @Nullable
default Number getMaxFileSize()

Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.

Example: maxFileSize=512

getParallelLoadThreads

@Stability(value=Stable)
 @Nullable
default Number getParallelLoadThreads()

Improves performance when loading data into the MySQL-compatible target database.

Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.

Example: parallelLoadThreads=1

getPassword

@Stability(value=Stable)
 @Nullable
default String getPassword()

Endpoint connection password.

getPort

@Stability(value=Stable)
 @Nullable
default Number getPort()

The port used by the endpoint database.

getSecretsManagerAccessRoleArn

@Stability(value=Stable)
 @Nullable
default 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.` The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL 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 required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .

getSecretsManagerSecretId

@Stability(value=Stable)
 @Nullable
default String getSecretsManagerSecretId()

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

getServerName

@Stability(value=Stable)
 @Nullable
default String getServerName()

Endpoint TCP port.

getServerTimezone

@Stability(value=Stable)
 @Nullable
default String getServerTimezone()

Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.

Example: serverTimezone=US/Pacific;

getUsername

@Stability(value=Stable)
 @Nullable
default String getUsername()

Endpoint connection user name.

builder

@Stability(value=Stable)
static CfnEndpoint.GcpMySQLSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.GcpMySQLSettingsProperty.Builder of CfnEndpoint.GcpMySQLSettingsProperty