Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data GcpMySQLSettings = GcpMySQLSettings' {
- afterConnectScript :: Maybe Text
- cleanSourceMetadataOnMismatch :: Maybe Bool
- databaseName :: Maybe Text
- eventsPollInterval :: Maybe Int
- maxFileSize :: Maybe Int
- parallelLoadThreads :: Maybe Int
- password :: Maybe (Sensitive Text)
- port :: Maybe Int
- secretsManagerAccessRoleArn :: Maybe Text
- secretsManagerSecretId :: Maybe Text
- serverName :: Maybe Text
- serverTimezone :: Maybe Text
- targetDbType :: Maybe TargetDbType
- username :: Maybe Text
- newGcpMySQLSettings :: GcpMySQLSettings
- gcpMySQLSettings_afterConnectScript :: Lens' GcpMySQLSettings (Maybe Text)
- gcpMySQLSettings_cleanSourceMetadataOnMismatch :: Lens' GcpMySQLSettings (Maybe Bool)
- gcpMySQLSettings_databaseName :: Lens' GcpMySQLSettings (Maybe Text)
- gcpMySQLSettings_eventsPollInterval :: Lens' GcpMySQLSettings (Maybe Int)
- gcpMySQLSettings_maxFileSize :: Lens' GcpMySQLSettings (Maybe Int)
- gcpMySQLSettings_parallelLoadThreads :: Lens' GcpMySQLSettings (Maybe Int)
- gcpMySQLSettings_password :: Lens' GcpMySQLSettings (Maybe Text)
- gcpMySQLSettings_port :: Lens' GcpMySQLSettings (Maybe Int)
- gcpMySQLSettings_secretsManagerAccessRoleArn :: Lens' GcpMySQLSettings (Maybe Text)
- gcpMySQLSettings_secretsManagerSecretId :: Lens' GcpMySQLSettings (Maybe Text)
- gcpMySQLSettings_serverName :: Lens' GcpMySQLSettings (Maybe Text)
- gcpMySQLSettings_serverTimezone :: Lens' GcpMySQLSettings (Maybe Text)
- gcpMySQLSettings_targetDbType :: Lens' GcpMySQLSettings (Maybe TargetDbType)
- gcpMySQLSettings_username :: Lens' GcpMySQLSettings (Maybe Text)
Documentation
data GcpMySQLSettings Source #
Settings in JSON format for the source GCP MySQL endpoint.
See: newGcpMySQLSettings
smart constructor.
GcpMySQLSettings' | |
|
Instances
newGcpMySQLSettings :: GcpMySQLSettings Source #
Create a value of GcpMySQLSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:afterConnectScript:GcpMySQLSettings'
, gcpMySQLSettings_afterConnectScript
- Specifies a script to run immediately after 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.
$sel:cleanSourceMetadataOnMismatch:GcpMySQLSettings'
, gcpMySQLSettings_cleanSourceMetadataOnMismatch
- Adjusts the behavior of DMS when migrating from an SQL Server source
database that is hosted as part of an Always On availability group
cluster. If you need DMS to poll all the nodes in the Always On cluster
for transaction backups, set this attribute to false
.
$sel:databaseName:GcpMySQLSettings'
, gcpMySQLSettings_databaseName
- 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 DMS task.
$sel:eventsPollInterval:GcpMySQLSettings'
, gcpMySQLSettings_eventsPollInterval
- 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, DMS checks for changes in the binary logs every five seconds.
$sel:maxFileSize:GcpMySQLSettings'
, gcpMySQLSettings_maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer
data to a MySQL-compatible database.
Example: maxFileSize=512
$sel:parallelLoadThreads:GcpMySQLSettings'
, gcpMySQLSettings_parallelLoadThreads
- 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
$sel:password:GcpMySQLSettings'
, gcpMySQLSettings_password
- Endpoint connection password.
$sel:port:GcpMySQLSettings'
, gcpMySQLSettings_port
-
$sel:secretsManagerAccessRoleArn:GcpMySQLSettings'
, gcpMySQLSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies 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 Amazon Web Services
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
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:secretsManagerSecretId:GcpMySQLSettings'
, gcpMySQLSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the MySQL endpoint connection
details.
$sel:serverName:GcpMySQLSettings'
, gcpMySQLSettings_serverName
- Endpoint TCP port.
$sel:serverTimezone:GcpMySQLSettings'
, gcpMySQLSettings_serverTimezone
- Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
$sel:targetDbType:GcpMySQLSettings'
, gcpMySQLSettings_targetDbType
- Specifies where to migrate source tables on the target, either to a
single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
$sel:username:GcpMySQLSettings'
, gcpMySQLSettings_username
- Endpoint connection user name.
gcpMySQLSettings_afterConnectScript :: Lens' GcpMySQLSettings (Maybe Text) Source #
Specifies a script to run immediately after 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.
gcpMySQLSettings_cleanSourceMetadataOnMismatch :: Lens' GcpMySQLSettings (Maybe Bool) Source #
Adjusts the behavior of DMS when migrating from an SQL Server source
database that is hosted as part of an Always On availability group
cluster. If you need DMS to poll all the nodes in the Always On cluster
for transaction backups, set this attribute to false
.
gcpMySQLSettings_databaseName :: Lens' GcpMySQLSettings (Maybe Text) Source #
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 DMS task.
gcpMySQLSettings_eventsPollInterval :: Lens' GcpMySQLSettings (Maybe Int) Source #
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, DMS checks for changes in the binary logs every five seconds.
gcpMySQLSettings_maxFileSize :: Lens' GcpMySQLSettings (Maybe Int) Source #
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
gcpMySQLSettings_parallelLoadThreads :: Lens' GcpMySQLSettings (Maybe Int) Source #
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
gcpMySQLSettings_password :: Lens' GcpMySQLSettings (Maybe Text) Source #
Endpoint connection password.
gcpMySQLSettings_secretsManagerAccessRoleArn :: Lens' GcpMySQLSettings (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the IAM role that specifies 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 Amazon Web Services
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
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
gcpMySQLSettings_secretsManagerSecretId :: Lens' GcpMySQLSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the MySQL endpoint connection
details.
gcpMySQLSettings_serverName :: Lens' GcpMySQLSettings (Maybe Text) Source #
Endpoint TCP port.
gcpMySQLSettings_serverTimezone :: Lens' GcpMySQLSettings (Maybe Text) Source #
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
gcpMySQLSettings_targetDbType :: Lens' GcpMySQLSettings (Maybe TargetDbType) Source #
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
gcpMySQLSettings_username :: Lens' GcpMySQLSettings (Maybe Text) Source #
Endpoint connection user name.