String resourceArn
Identifies the DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).
For DMS, you can tag a replication instance, an endpoint, or a replication task.
List<E> tags
One or more tags to be assigned to the resource.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to.
String applyAction
The pending maintenance action to apply to this resource.
String optInType
A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request
of type immediate.
Valid values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
ResourcePendingMaintenanceActions resourcePendingMaintenanceActions
The DMS resource that the pending maintenance action will be applied to.
String name
The name of the Availability Zone.
String replicationTaskAssessmentRunArn
Amazon Resource Name (ARN) of the premigration assessment run to be canceled.
ReplicationTaskAssessmentRun replicationTaskAssessmentRun
The ReplicationTaskAssessmentRun object for the canceled assessment run.
String certificateIdentifier
A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
Date certificateCreationDate
The date that the certificate was created.
String certificatePem
The contents of a .pem file, which contains an X.509 certificate.
ByteBuffer certificateWallet
The location of an imported Oracle Wallet certificate for use with SSL.
String certificateArn
The Amazon Resource Name (ARN) for the certificate.
String certificateOwner
The owner of the certificate.
Date validFromDate
The beginning date that the certificate is valid.
Date validToDate
The final date that the certificate is valid.
String signingAlgorithm
The signing algorithm for the certificate.
Integer keyLength
The key length of the cryptographic algorithm being used.
String replicationInstanceArn
The ARN of the replication instance.
String endpointArn
The ARN string that uniquely identifies the endpoint.
String status
The connection status. This parameter can return one of the following values:
"successful"
"testing"
"failed"
"deleting"
String lastFailureMessage
The error message when the connection last failed.
String endpointIdentifier
The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
String replicationInstanceIdentifier
The replication instance identifier. This parameter is stored as a lowercase string.
String endpointIdentifier
The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
String endpointType
The type of endpoint. Valid values are source and target.
String engineName
The type of engine for the endpoint. Valid values, depending on the EndpointType value, include
"mysql", "oracle", "postgres", "mariadb",
"aurora", "aurora-postgresql", "redshift", "s3",
"db2", "azuredb", "sybase", "dynamodb",
"mongodb", "kinesis", "kafka", "elasticsearch",
"docdb", "sqlserver", and "neptune".
String username
The user name to be used to log in to the endpoint database.
String password
The password to be used to log in to the endpoint database.
String serverName
The name of the server where the endpoint database resides.
Integer port
The port used by the endpoint database.
String databaseName
The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
String extraConnectionAttributes
Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.
String kmsKeyId
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
List<E> tags
One or more tags to be assigned to the endpoint.
String certificateArn
The Amazon Resource Name (ARN) for the certificate.
String sslMode
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
String serviceAccessRoleArn
The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role
must allow the iam:PassRole action.
String externalTableDefinition
The external table definition.
DynamoDbSettings dynamoDbSettings
Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.
S3Settings s3Settings
Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.
DmsTransferSettings dmsTransferSettings
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. The role
must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", }
MongoDbSettings mongoDbSettings
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
KinesisSettings kinesisSettings
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
KafkaSettings kafkaSettings
Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
ElasticsearchSettings elasticsearchSettings
Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in the Database Migration Service User Guide.
NeptuneSettings neptuneSettings
Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
RedshiftSettings redshiftSettings
PostgreSQLSettings postgreSQLSettings
Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
MySQLSettings mySQLSettings
Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
OracleSettings oracleSettings
Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
SybaseSettings sybaseSettings
Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
MicrosoftSQLServerSettings microsoftSQLServerSettings
Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
IBMDb2Settings iBMDb2Settings
Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.
String resourceIdentifier
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is
returned in the created Endpoint object. The value for this parameter can have up to 31 characters.
It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two
consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this
value might result in the EndpointArn value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a
ResourceIdentifier value, DMS generates a default identifier value for the end of
EndpointArn.
DocDbSettings docDbSettings
Endpoint endpoint
The endpoint that was created.
String subscriptionName
The name of the DMS event notification subscription. This name must be less than 255 characters.
String snsTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
String sourceType
The type of DMS resource that generates the events. For example, if you want to be notified of events generated
by a replication instance, you set this parameter to replication-instance. If this value isn't
specified, all events are returned.
Valid values: replication-instance | replication-task
List<E> eventCategories
A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.
List<E> sourceIds
A list of identifiers for which DMS provides notification events.
If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
Boolean enabled
A Boolean value; set to true to activate the subscription, or set to false to create
the subscription but not activate it.
List<E> tags
One or more tags to be assigned to the event subscription.
EventSubscription eventSubscription
The event subscription that was created.
String replicationInstanceIdentifier
The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
Integer allocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
String replicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance
class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
List<E> vpcSecurityGroupIds
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
String availabilityZone
The Availability Zone where the replication instance will be created. The default value is a random,
system-chosen Availability Zone in the endpoint's Region, for example: us-east-1d
String replicationSubnetGroupIdentifier
A subnet group to associate with the replication instance.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Boolean multiAZ
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZone parameter if the Multi-AZ parameter is set to true.
String engineVersion
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the replication instance during
the maintenance window. This parameter defaults to true.
Default: true
List<E> tags
One or more tags to be assigned to the replication instance.
String kmsKeyId
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
Boolean publiclyAccessible
Specifies the accessibility options for the replication instance. A value of true represents an
instance with a public IP address. A value of false represents an instance with a private IP
address. The default value is true.
String dnsNameServers
A list of custom DNS name servers supported for the replication instance to access your on-premise source or
target database. This list overrides the default name servers supported by the replication instance. You can
specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example:
"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
String resourceIdentifier
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is
returned in the created Endpoint object. The value for this parameter can have up to 31 characters.
It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two
consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this
value might result in the EndpointArn value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a
ResourceIdentifier value, DMS generates a default identifier value for the end of
EndpointArn.
ReplicationInstance replicationInstance
The replication instance that was created.
String replicationSubnetGroupIdentifier
The name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".
Example: mySubnetgroup
String replicationSubnetGroupDescription
The description for the subnet group.
List<E> subnetIds
One or more subnet IDs to be assigned to the subnet group.
List<E> tags
One or more tags to be assigned to the subnet group.
ReplicationSubnetGroup replicationSubnetGroup
The replication subnet group that was created.
String replicationTaskIdentifier
An identifier for the replication task.
Constraints:
Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
String sourceEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
String targetEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
String replicationInstanceArn
The Amazon Resource Name (ARN) of a replication instance.
String migrationType
The migration type. Valid values: full-load | cdc | full-load-and-cdc
String tableMappings
The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide.
String replicationTaskSettings
Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide.
Date cdcStartTime
Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
String cdcStartPosition
Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be
created and associated with the source endpoint. You can verify this by setting the slotName extra
connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
String cdcStopPosition
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
List<E> tags
One or more tags to be assigned to the replication task.
String taskData
Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
String resourceIdentifier
A friendly name for the resource identifier at the end of the EndpointArn response parameter that is
returned in the created Endpoint object. The value for this parameter can have up to 31 characters.
It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two
consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this
value might result in the EndpointArn value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a
ResourceIdentifier value, DMS generates a default identifier value for the end of
EndpointArn.
ReplicationTask replicationTask
The replication task that was created.
String certificateArn
The Amazon Resource Name (ARN) of the deleted certificate.
Certificate certificate
The Secure Sockets Layer (SSL) certificate.
Connection connection
The connection that is being deleted.
String endpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Endpoint endpoint
The endpoint that was deleted.
String subscriptionName
The name of the DMS event notification subscription to be deleted.
EventSubscription eventSubscription
The event subscription that was deleted.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance to be deleted.
ReplicationInstance replicationInstance
The replication instance that was deleted.
String replicationSubnetGroupIdentifier
The subnet group name of the replication instance.
String replicationTaskAssessmentRunArn
Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
ReplicationTaskAssessmentRun replicationTaskAssessmentRun
The ReplicationTaskAssessmentRun object for the deleted assessment run.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task to be deleted.
ReplicationTask replicationTask
The deleted replication task.
List<E> accountQuotas
Account quota information.
String uniqueAccountIdentifier
A unique DMS identifier for an account in a particular Region. The value of this identifier has the following
format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this
identifier to name the default Amazon S3 bucket for storing task assessment reports in a given Region. The format
of this S3 bucket name is the following: dms-AccountNumber-UniqueAccountIdentifier.
Here is an example name for this default S3 bucket: dms-111122223333-c44445555666.
DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.
String replicationTaskArn
Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.
String replicationInstanceArn
ARN of a replication instance on which you want to base the default list of individual assessments.
String sourceEngineName
Name of a database engine that the specified replication instance supports as a source.
String targetEngineName
Name of a database engine that the specified replication instance supports as a target.
String migrationType
Name of the migration type that each provided individual assessment must support.
Integer maxRecords
Maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
String marker
Optional pagination token provided by a previous request. If this parameter is specified, the response includes
only records beyond the marker, up to the value specified by MaxRecords.
List<E> individualAssessmentNames
List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the Database Migration Service User Guide.
String marker
Pagination token returned for you to pass to a subsequent request. If you pass this token as the
Marker value in a subsequent request, the response includes only records beyond the marker, up to
the value specified in the request by MaxRecords.
List<E> filters
Filters applied to the certificates described in the form of key-value pairs.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 10
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> filters
The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String engineName
The databse engine used for your source or target endpoint.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> endpointSettings
Descriptions of the endpoint settings available for your source or target database engine.
List<E> filters
Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> filters
Filters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> supportedEndpointTypes
The types of endpoints that are supported.
String sourceIdentifier
The identifier of an event source.
String sourceType
The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
Date startTime
The start time for the events to be listed.
Date endTime
The end time for the events to be listed.
Integer duration
The duration of the events to be listed.
List<E> eventCategories
A list of event categories for the source type that you've chosen.
List<E> filters
Filters applied to events.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String subscriptionName
The name of the DMS event subscription to be described.
List<E> filters
Filters applied to event subscriptions.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> orderableReplicationInstances
The order-able replication instances available.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
List<E> filters
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
List<E> pendingMaintenanceActions
The pending maintenance action.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String endpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
RefreshSchemasStatus refreshSchemasStatus
The status of the schema.
List<E> filters
Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
List<E> replicationInstanceTaskLogs
An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> filters
Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> replicationSubnetGroups
A description of the replication subnet groups.
String replicationTaskArn
The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified,
the API returns only one result and ignore the values of the MaxRecords and Marker
parameters.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String bucketName
- The Amazon S3 bucket where the task assessment report is located.
List<E> replicationTaskAssessmentResults
The task assessment report.
List<E> filters
Filters applied to the premigration assessment runs described in the form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn, replication-task-arn,
replication-instance-arn, status
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String marker
A pagination token returned for you to pass to a subsequent request. If you pass this token as the
Marker value in a subsequent request, the response includes only records beyond the marker, up to
the value specified in the request by MaxRecords.
List<E> replicationTaskAssessmentRuns
One or more premigration assessment runs as specified by Filters.
List<E> filters
Filters applied to the individual assessments described in the form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn, replication-task-arn,
status
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String marker
A pagination token returned for you to pass to a subsequent request. If you pass this token as the
Marker value in a subsequent request, the response includes only records beyond the marker, up to
the value specified in the request by MaxRecords.
List<E> replicationTaskIndividualAssessments
One or more individual assessments as specified by Filters.
List<E> filters
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
Boolean withoutSettings
An option to set to avoid returning information about settings. Use this to reduce overhead when setting
information is too large. To use this option, choose true; otherwise, choose false (the
default).
String endpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords value, a pagination token called a marker is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 500.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
List<E> filters
Filters applied to table statistics.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
List<E> tableStatistics
The table statistics.
String marker
An optional pagination token provided by a previous request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords.
String serviceAccessRoleArn
The IAM role that has permission to access the Amazon S3 bucket. When specified as part of request syntax, such
as for the CreateEndpoint and ModifyEndpoint actions, the role must allow the
iam:PassRole action.
String bucketName
The name of the S3 bucket to use.
String username
The user name you use to access the DocumentDB source endpoint.
String password
The password for the user account you use to access the DocumentDB source endpoint.
String serverName
The name of the server on the DocumentDB source endpoint.
Integer port
The port value for the DocumentDB source endpoint.
String databaseName
The database name on the DocumentDB source endpoint.
String nestingLevel
Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode. Specify
"one" to use table mode.
Boolean extractDocId
Specifies the document ID. Use this setting when NestingLevel is set to "none".
Default value is "false".
Integer docsToInvestigate
Indicates the number of documents to preview to determine the document organization. Use this setting when
NestingLevel is set to "one".
Must be a positive value greater than 0. Default value is 1000.
String kmsKeyId
The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a
value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default
encryption key for your account. Your account has a different default encryption key for each Region.
String 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 DocumentDB 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB
endpoint connection details.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole action.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole action.
String endpointUri
The endpoint for the Elasticsearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
Integer fullLoadErrorPercentage
The maximum percentage of records that can fail to be written before a full load operation stops.
To avoid early failure, this counter is only effective after 1000 records are transferred. Elasticsearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.
Integer errorRetryDuration
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
String endpointIdentifier
The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
String endpointType
The type of endpoint. Valid values are source and target.
String engineName
The database engine name. Valid values, depending on the EndpointType, include "mysql",
"oracle", "postgres", "mariadb", "aurora",
"aurora-postgresql", "redshift", "s3", "db2",
"azuredb", "sybase", "dynamodb", "mongodb",
"kinesis", "kafka", "elasticsearch", "documentdb",
"sqlserver", and "neptune".
String engineDisplayName
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this
value would be "Amazon Aurora MySQL."
String username
The user name used to connect to the endpoint.
String serverName
The name of the server at the endpoint.
Integer port
The port value used to access the endpoint.
String databaseName
The name of the database at the endpoint.
String extraConnectionAttributes
Additional connection attributes used to connect to the endpoint.
String status
The status of the endpoint.
String kmsKeyId
An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
String endpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
String certificateArn
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
String sslMode
The SSL mode used to connect to the endpoint. The default value is none.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole action.
String externalTableDefinition
The external table definition.
String externalId
Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.
DynamoDbSettings dynamoDbSettings
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings
structure.
S3Settings s3Settings
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
DmsTransferSettings dmsTransferSettings
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket. The role
must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string"}
MongoDbSettings mongoDbSettings
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
structure.
KinesisSettings kinesisSettings
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings
structure.
KafkaSettings kafkaSettings
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings
structure.
ElasticsearchSettings elasticsearchSettings
The settings for the Elasticsearch source endpoint. For more information, see the
ElasticsearchSettings structure.
NeptuneSettings neptuneSettings
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings
structure.
RedshiftSettings redshiftSettings
Settings for the Amazon Redshift endpoint.
PostgreSQLSettings postgreSQLSettings
The settings for the PostgreSQL source and target endpoint. For more information, see the
PostgreSQLSettings structure.
MySQLSettings mySQLSettings
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings
structure.
OracleSettings oracleSettings
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings
structure.
SybaseSettings sybaseSettings
The settings for the SAP ASE source and target endpoint. For more information, see the
SybaseSettings structure.
MicrosoftSQLServerSettings microsoftSQLServerSettings
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the
MicrosoftSQLServerSettings structure.
IBMDb2Settings iBMDb2Settings
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings
structure.
DocDbSettings docDbSettings
String name
The name that you want to give the endpoint settings.
String type
The type of endpoint. Valid values are source and target.
List<E> enumValues
Enumerated values to use for this endpoint.
Boolean sensitive
A value that marks this endpoint setting as sensitive.
String units
The unit of measure for this endpoint setting.
String applicability
The relevance or validity of an endpoint setting for an engine name and its endpoint type.
Integer intValueMin
The minimum value of an endpoint setting that is of type int.
Integer intValueMax
The maximum value of an endpoint setting that is of type int.
String defaultValue
The default value of the endpoint setting if no value is specified using CreateEndpoint or
ModifyEndpoint.
String sourceIdentifier
The identifier of an event source.
String sourceType
The type of DMS resource that generates events.
Valid values: replication-instance | endpoint | replication-task
String message
The event message.
List<E> eventCategories
The event categories available for the specified source type.
Date date
The date of the event.
String customerAwsId
The Amazon Web Services customer account associated with the DMS event notification subscription.
String custSubscriptionId
The DMS event notification subscription Id.
String snsTopicArn
The topic ARN of the DMS event notification subscription.
String status
The status of the DMS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
String subscriptionCreationTime
The time the DMS event notification subscription was created.
String sourceType
The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
List<E> sourceIdsList
A list of source Ids for the event subscription.
List<E> eventCategoriesList
A lists of event categories.
Boolean enabled
Boolean value that indicates if the event subscription is enabled.
String databaseName
Database name for the endpoint.
String password
Endpoint connection password.
Integer port
Endpoint TCP port. The default value is 50000.
String serverName
Fully qualified domain name of the endpoint.
Boolean setDataCaptureChanges
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
String currentLsn
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
Integer maxKBytesPerRead
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
String username
Endpoint connection user name.
String 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 Db2 LUW 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW
endpoint connection details.
String certificateIdentifier
A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
String certificatePem
The contents of a .pem file, which contains an X.509 certificate.
ByteBuffer certificateWallet
The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a .sso
file using the fileb:// prefix. You can't provide the certificate inline.
List<E> tags
The tags associated with the certificate.
Certificate certificate
The certificate to be uploaded.
String broker
A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.
Specify each broker location in the form broker-hostname-or-ip:port . For example,
"ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a
list of broker locations, see Using Apache Kafka as a target for
Database Migration Service in the Database Migration Service User Guide.
String topic
The topic to which you migrate the data. If you don't specify a topic, DMS specifies
"kafka-default-topic" as the migration topic.
String messageFormat
The output format for the records created on the endpoint. The message format is JSON (default) or
JSON_UNFORMATTED (a single line with no tab).
Boolean includeTransactionDetails
Provides detailed transaction information from the source database. This information includes a commit timestamp,
a log position, and values for transaction_id, previous transaction_id, and
transaction_record_id (the record offset within a transaction). The default is false.
Boolean includePartitionValue
Shows the partition value within the Kafka message output unless the partition type is
schema-table-type. The default is false.
Boolean partitionIncludeSchemaTable
Prefixes schema and table names to partition values, when the partition type is primary-key-type.
Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has
thousands of tables and each table has only limited range for a primary key. In this case, the same primary key
is sent from thousands of tables to the same partition, which causes throttling. The default is
false.
Boolean includeTableAlterOperations
Includes any data definition language (DDL) operations that change the table in the control data, such as
rename-table, drop-table, add-column, drop-column, and
rename-column. The default is false.
Boolean includeControlDetails
Shows detailed control information for table definition, column definition, and table and column changes in the
Kafka message output. The default is false.
Integer messageMaxBytes
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
Boolean includeNullAndEmpty
Include NULL and empty columns for records migrated to the endpoint. The default is false.
String securityProtocol
Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include
ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl
requires SaslUsername and SaslPassword.
String sslClientCertificateArn
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
String sslClientKeyArn
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
String sslClientKeyPassword
The password for the client private key used to securely connect to a Kafka target endpoint.
String sslCaCertificateArn
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
String saslUsername
The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
String saslPassword
The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
Boolean noHexPrefix
If this attribute is Y, it allows hexadecimal values that don't have the 0x prefix when migrated to
a Kafka target. If this attribute is N, all hexadecimal values include this prefix when migrated to Kafka.
String streamArn
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
String messageFormat
The output format for the records created on the endpoint. The message format is JSON (default) or
JSON_UNFORMATTED (a single line with no tab).
String serviceAccessRoleArn
The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must
allow the iam:PassRole action.
Boolean includeTransactionDetails
Provides detailed transaction information from the source database. This information includes a commit timestamp,
a log position, and values for transaction_id, previous transaction_id, and
transaction_record_id (the record offset within a transaction). The default is false.
Boolean includePartitionValue
Shows the partition value within the Kinesis message output, unless the partition type is
schema-table-type. The default is false.
Boolean partitionIncludeSchemaTable
Prefixes schema and table names to partition values, when the partition type is primary-key-type.
Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has
thousands of tables and each table has only limited range for a primary key. In this case, the same primary key
is sent from thousands of tables to the same shard, which causes throttling. The default is false.
Boolean includeTableAlterOperations
Includes any data definition language (DDL) operations that change the table in the control data, such as
rename-table, drop-table, add-column, drop-column, and
rename-column. The default is false.
Boolean includeControlDetails
Shows detailed control information for table definition, column definition, and table and column changes in the
Kinesis message output. The default is false.
Boolean includeNullAndEmpty
Include NULL and empty columns for records migrated to the endpoint. The default is false.
Boolean noHexPrefix
If this attribute is Y, it allows hexadecimal values that don't have the 0x prefix when migrated to
a Kinesis target. If this attribute is N, all hexadecimal values include this prefix when migrated to Kinesis.
String resourceArn
The Amazon Resource Name (ARN) string that uniquely identifies the DMS resource.
Integer port
Endpoint TCP port.
Integer bcpPacketSize
The maximum size of the packets (in bytes) used to transfer data using BCP.
String databaseName
Database name for the endpoint.
String controlTablesFileGroup
Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.
String password
Endpoint connection password.
Boolean querySingleAlwaysOnNode
Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.
Boolean readBackupOnly
When this attribute is set to Y, DMS only reads changes from transaction log backups and doesn't
read from the active transaction log file during ongoing replication. Setting this parameter to Y
enables you to control active transaction log file growth during full load and ongoing replication tasks.
However, it can add some source latency to ongoing replication.
String safeguardPolicy
Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.
Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.
String serverName
Fully qualified domain name of the endpoint.
String username
Endpoint connection user name.
Boolean useBcpFullLoad
Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.
Boolean useThirdPartyBackupDevice
When this attribute is set to Y, DMS processes third-party transaction log backups if they are
created in native format.
String 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 SQL Server 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server
endpoint connection details.
String endpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
String endpointIdentifier
The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
String endpointType
The type of endpoint. Valid values are source and target.
String engineName
The type of engine for the endpoint. Valid values, depending on the EndpointType, include "mysql",
"oracle", "postgres", "mariadb", "aurora",
"aurora-postgresql", "redshift", "s3", "db2",
"azuredb", "sybase", "dynamodb", "mongodb",
"kinesis", "kafka", "elasticsearch", "documentdb",
"sqlserver", and "neptune".
String username
The user name to be used to login to the endpoint database.
String password
The password to be used to login to the endpoint database.
String serverName
The name of the server where the endpoint database resides.
Integer port
The port used by the endpoint database.
String databaseName
The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
String extraConnectionAttributes
Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
String certificateArn
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
String sslMode
The SSL mode used to connect to the endpoint. The default value is none.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the
iam:PassRole action.
String externalTableDefinition
The external table definition.
DynamoDbSettings dynamoDbSettings
Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.
S3Settings s3Settings
Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.
DmsTransferSettings dmsTransferSettings
The settings in JSON format for the DMS transfer type of source endpoint.
Attributes include the following:
serviceAccessRoleArn - The Identity and Access Management (IAM) role that has permission to access the Amazon S3
bucket. The role must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string"}
MongoDbSettings mongoDbSettings
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
KinesisSettings kinesisSettings
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
KafkaSettings kafkaSettings
Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
ElasticsearchSettings elasticsearchSettings
Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in the Database Migration Service User Guide.
NeptuneSettings neptuneSettings
Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
RedshiftSettings redshiftSettings
PostgreSQLSettings postgreSQLSettings
Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
MySQLSettings mySQLSettings
Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
OracleSettings oracleSettings
Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
SybaseSettings sybaseSettings
Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
MicrosoftSQLServerSettings microsoftSQLServerSettings
Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
IBMDb2Settings iBMDb2Settings
Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.
DocDbSettings docDbSettings
Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.
Boolean exactSettings
If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings
with the exact settings that you specify in this call. If this attribute is N, the current call to
ModifyEndpoint does two things:
It replaces any endpoint settings that already exist with new values, for settings with the same names.
It creates new endpoint settings that you specify in the call, for settings with different names.
For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the
following endpoint settings: '{"a":1}'. If you then call
modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the
following settings: '{"a":1,"b":2}'.
However, suppose that you follow this with a call to
modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again.
Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the
exact settings that you specify.
Endpoint endpoint
The modified endpoint.
String subscriptionName
The name of the DMS event notification subscription to be modified.
String snsTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
String sourceType
The type of DMS resource that generates the events you want to subscribe to.
Valid values: replication-instance | replication-task
List<E> eventCategories
A list of event categories for a source type that you want to subscribe to. Use the
DescribeEventCategories action to see a list of event categories.
Boolean enabled
A Boolean value; set to true to activate the subscription.
EventSubscription eventSubscription
The modified event subscription.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
Integer allocatedStorage
The amount of storage (in gigabytes) to be allocated for the replication instance.
Boolean applyImmediately
Indicates whether the changes should be applied immediately or during the next maintenance window.
String replicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance
class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
List<E> vpcSecurityGroupIds
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
String preferredMaintenanceWindow
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
Boolean multiAZ
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZone parameter if the Multi-AZ parameter is set to true.
String engineVersion
The engine version number of the replication instance.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to
true.
Boolean allowMajorVersionUpgrade
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.
This parameter must be set to true when specifying a value for the EngineVersion
parameter that is a different major version than the replication instance's current version.
Boolean autoMinorVersionUpgrade
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
This parameter is set to true during the maintenance window.
A newer minor version is available.
DMS has enabled automatic patching for the given engine version.
String replicationInstanceIdentifier
The replication instance identifier. This parameter is stored as a lowercase string.
ReplicationInstance replicationInstance
The modified replication instance.
String replicationSubnetGroupIdentifier
The name of the replication instance subnet group.
String replicationSubnetGroupDescription
A description for the replication instance subnet group.
List<E> subnetIds
A list of subnet IDs.
ReplicationSubnetGroup replicationSubnetGroup
The modified replication subnet group.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
String replicationTaskIdentifier
The replication task identifier.
Constraints:
Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
String migrationType
The migration type. Valid values: full-load | cdc | full-load-and-cdc
String tableMappings
When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path
with file://. For example, --table-mappings file://mappingfile.json. When working with
the DMS API, provide the JSON as the parameter value.
String replicationTaskSettings
JSON file that contains settings for the task, such as task metadata settings.
Date cdcStartTime
Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
String cdcStartPosition
Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be
created and associated with the source endpoint. You can verify this by setting the slotName extra
connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
String cdcStopPosition
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
String taskData
Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
ReplicationTask replicationTask
The replication task that was modified.
String username
The user name you use to access the MongoDB source endpoint.
String password
The password for the user account you use to access the MongoDB source endpoint.
String serverName
The name of the server on the MongoDB source endpoint.
Integer port
The port value for the MongoDB source endpoint.
String databaseName
The database name on the MongoDB source endpoint.
String authType
The authentication type you use to access the MongoDB source endpoint.
When when set to "no", user name and password parameters are not used and can be empty.
String authMechanism
The authentication mechanism you use to access the MongoDB source endpoint.
For the default value, in MongoDB version 2.x, "default" is "mongodb_cr". For MongoDB
version 3.x or later, "default" is "scram_sha_1". This setting isn't used when
AuthType is set to "no".
String nestingLevel
Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode. Specify
"one" to use table mode.
String extractDocId
Specifies the document ID. Use this setting when NestingLevel is set to "none".
Default value is "false".
String docsToInvestigate
Indicates the number of documents to preview to determine the document organization. Use this setting when
NestingLevel is set to "one".
Must be a positive value greater than 0. Default value is 1000.
String authSource
The MongoDB database name. This setting isn't used when AuthType is set to "no".
The default is "admin".
String kmsKeyId
The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a
value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default
encryption key for your account. Your account has a different default encryption key for each Region.
String 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 MongoDB 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB
endpoint connection details.
ReplicationTask replicationTask
The replication task that was moved.
String 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.
Boolean 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.
String 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.
Integer eventsPollInterval
Specifies how often to check the binary log for new changes/events when the database is idle.
Example: eventsPollInterval=5;
In the example, DMS checks for changes in the binary logs every five seconds.
String targetDbType
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
Integer maxFileSize
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
Integer 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.
Example: parallelLoadThreads=1
String password
Endpoint connection password.
Integer port
Endpoint TCP port.
String serverName
Fully qualified domain name of the endpoint.
String serverTimezone
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
String username
Endpoint connection user name.
String 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL
endpoint connection details.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role
must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the Database Migration Service
User Guide.
String s3BucketName
The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files.
String s3BucketFolder
A folder path where you want DMS to store migrated graph data in the S3 bucket specified by
S3BucketName
Integer errorRetryDuration
The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.
Integer maxFileSize
The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data.
Integer maxRetryCount
The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
Boolean iamAuthEnabled
If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to
true. Then attach the appropriate IAM policy document to your service role specified by
ServiceAccessRoleArn. The default is false.
Boolean addSupplementalLogging
Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.
If you use this option, you still need to enable database-level supplemental logging.
Integer archivedLogDestId
Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the
dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the
AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves
performance by ensuring that the correct logs are accessed from the outset.
Integer additionalArchivedLogDestId
Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in
the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read
changes. This need arises because the previous primary instance is now a standby instance after switchover.
Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use
RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
Boolean allowSelectNestedTables
Set this attribute to true to enable replication of Oracle tables containing columns that are nested
tables or defined types.
Integer parallelAsmReadThreads
Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC)
load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default)
and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.
Integer readAheadBlocks
Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).
Boolean accessAlternateDirectly
Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon
RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path
prefix replacement using direct file access.
Boolean useAlternateFolderForOnline
Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon
RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all
online redo logs.
String oraclePathPrefix
Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.
String usePathPrefix
Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.
Boolean replacePathPrefix
Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle
as the source. This setting tells DMS instance to replace the default Oracle root with the specified
usePathPrefix setting to access the redo logs.
Boolean enableHomogenousTablespace
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
Boolean directPathNoLog
When set to true, this attribute helps to increase the commit rate on the Oracle target database by
writing directly to tables and not writing a trail to database logs.
Boolean archivedLogsOnly
When this field is set to Y, DMS only accesses the archived redo logs. If the archived redo logs are
stored on Oracle ASM only, the DMS user account needs to be granted ASM privileges.
String asmPassword
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value
from the asm_user_password value. You set this value as part of the comma-separated value
that you set to the Password request parameter when you create the endpoint to access transaction
logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
String asmServer
For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server
value. You set asm_server as part of the extra connection attribute string to access an Oracle
server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
String asmUser
For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value.
You set asm_user as part of the extra connection attribute string to access an Oracle server with
Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
String charLengthSemantics
Specifies whether the length of a character column is in bytes or in characters. To indicate that the character
column length is in characters, set this attribute to CHAR. Otherwise, the character column length
is in bytes.
Example: charLengthSemantics=CHAR;
String databaseName
Database name for the endpoint.
Boolean directPathParallelLoad
When set to true, this attribute specifies a parallel load when useDirectPathFullLoad
is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that
the target table cannot have any constraints or indexes.
Boolean failTasksOnLobTruncation
When set to true, this attribute causes a task to fail if the actual size of an LOB column is
greater than the specified LobMaxSize.
If a task is set to limited LOB mode and this option is set to true, the task fails instead of
truncating the LOB data.
Integer numberDatatypeScale
Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.
Example: numberDataTypeScale=12
String password
Endpoint connection password.
Integer port
Endpoint TCP port.
Boolean readTableSpaceName
When set to true, this attribute supports tablespace replication.
Integer retryInterval
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
String securityDbEncryption
For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access
Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of
the comma-separated value you set to the Password request parameter when you create the endpoint.
The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting.
For more information, see
Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
Guide.
String securityDbEncryptionName
For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns
and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the
SecurityDbEncryption setting. For more information on setting the key name value of
SecurityDbEncryptionName, see the information and example for setting the
securityDbEncryptionName extra connection attribute in
Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User
Guide.
String serverName
Fully qualified domain name of the endpoint.
String spatialDataOptionToGeoJsonFunctionName
Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the
SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function
that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName
to call it instead.
Integer standbyDelayTime
Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.
In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.
String username
Endpoint connection user name.
Boolean useBFile
Set this attribute to Y to capture change data using the Binary Reader utility. Set
UseLogminerReader to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle
as the source, you set additional attributes. For more information about using this setting with Oracle Automatic
Storage Management (ASM), see Using
Oracle LogMiner or DMS Binary Reader for CDC.
Boolean useDirectPathFullLoad
Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.
Boolean useLogminerReader
Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this
attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader
to N, also set UseBfile to Y. For more information on this setting and using Oracle ASM, see Using
Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.
String 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 Oracle 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle
endpoint connection details.
String secretsManagerOracleAsmAccessRoleArn
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN of the IAM role that
specifies DMS as the trusted entity and grants the required permissions to access the
SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value
that allows access to the Oracle ASM of the endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and
SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUserName,
AsmPassword, and AsmServerName. You can't specify both. For more information on
creating this SecretsManagerOracleAsmSecret and the
SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to
access it, see Using
secrets to access Database Migration Service resources in the Database Migration Service User Guide.
String secretsManagerOracleAsmSecretId
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly
name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the
Oracle endpoint.
String engineVersion
The version of the replication engine.
String replicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance
class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
String storageType
The type of storage used by the replication instance.
Integer minAllocatedStorage
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
Integer maxAllocatedStorage
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
Integer defaultAllocatedStorage
The default amount of storage (in gigabytes) that is allocated for the replication instance.
Integer includedAllocatedStorage
The amount of storage (in gigabytes) that is allocated for the replication instance.
List<E> availabilityZones
List of Availability Zones for this replication instance.
String releaseStatus
The value returned when the specified EngineVersion of the replication instance is in Beta or test
mode. This indicates some features might not work as expected.
DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
String action
The type of pending maintenance action that is available for the resource.
Date autoAppliedAfterDate
The date of the maintenance window when the action is to be applied. The maintenance action is applied to the
resource during its first maintenance window after this date. If this date is specified, any
next-maintenance opt-in requests are ignored.
Date forcedApplyDate
The date when the maintenance action will be automatically applied. The maintenance action is applied to the
resource on this date regardless of the maintenance window for the resource. If this date is specified, any
immediate opt-in requests are ignored.
String optInStatus
The type of opt-in request that has been received for the resource.
Date currentApplyDate
The effective date when the pending maintenance action will be applied to the resource. This date takes into
account opt-in requests received from the ApplyPendingMaintenanceAction API operation, and also the
AutoAppliedAfterDate and ForcedApplyDate parameter values. This value is blank if an
opt-in request has not been received and nothing has been specified for AutoAppliedAfterDate or
ForcedApplyDate.
String description
A description providing more detail about the maintenance action.
String afterConnectScript
For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
Boolean captureDdls
To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
If this value is set to N, you don't have to create tables or triggers on the source database.
Integer maxFileSize
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
String databaseName
Database name for the endpoint.
String ddlArtifactsSchema
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
Integer executeTimeout
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
Boolean failTasksOnLobTruncation
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.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
Boolean heartbeatEnable
If this attribute is set to true, the write-ahead log (WAL) heartbeat keeps restart_lsn moving and
prevents storage full scenarios. The WAL heartbeat mimics a dummy transaction, so that idle logical replication
slots don't hold onto old WAL logs that result in storage full situations on the source.
String heartbeatSchema
Sets the schema in which the heartbeat artifacts are created.
Integer heartbeatFrequency
Sets the WAL heartbeat frequency (in minutes).
String password
Endpoint connection password.
Integer port
Endpoint TCP port.
String serverName
Fully qualified domain name of the endpoint.
String username
Endpoint connection user name.
String slotName
Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.
When used with the DMS API CdcStartPosition request parameter, this attribute also enables using
native CDC start points.
String pluginName
Specifies the plugin to use to create a replication slot.
String 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 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 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL
endpoint connection details.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
Boolean forceFailover
If this parameter is true, the reboot is conducted through a Multi-AZ failover. (If the instance
isn't configured for Multi-AZ, then you can't specify true.)
ReplicationInstance replicationInstance
The replication instance that is being rebooted.
Boolean 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 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.
String afterConnectScript
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
String 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, DMS converts source records into .csv files and loads them to the BucketFolder/TableID
path. 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, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
String bucketName
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
Boolean caseSensitiveNames
If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to
true. The default is false.
Boolean compUpdate
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.
Integer connectionTimeout
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
String databaseName
The name of the Amazon Redshift data warehouse (service) that you are working with.
String dateFormat
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.
Boolean emptyAsNull
A value that specifies whether 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.
String 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 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 Identity and Access Management (IAM) role with a policy that allows
"arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket"
Boolean explicitIds
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.
Integer 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.
FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10.
Integer loadTimeout
The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
Integer 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).
String password
The password for the user named in the username property.
Integer port
The port number for Amazon Redshift. The default value is 5439.
Boolean 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. Choose true to remove quotation
marks. The default is false.
String replaceInvalidChars
A list of characters that you want to replace. Use with ReplaceChars.
String replaceChars
A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars,
substituting the specified characters instead. The default is "?".
String serverName
The name of the Amazon Redshift cluster you are using.
String serviceAccessRoleArn
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.
String serverSideEncryptionKmsKeyId
The 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.
String timeFormat
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.
Boolean 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. Choose true to remove unneeded white space. The
default is false.
Boolean 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. Choose true to truncate data. The default is false.
String username
An Amazon Redshift user name for a registered user.
Integer 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).
String 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 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 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon
Redshift endpoint connection details.
RefreshSchemasStatus refreshSchemasStatus
The status of the refreshed schema.
String endpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
String status
The status of the schema.
Date lastRefreshDate
The date the schema was last refreshed.
String lastFailureMessage
The last failure message for the schema.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
List<E> tablesToReload
The name and schema of the table to be reloaded.
String reloadOption
Options for reload. Specify data-reload to reload the data and re-validate it if validation is
enabled. Specify validate-only to re-validate the table. This option applies only when validation is
enabled for the task.
Valid values: data-reload, validate-only
Default value is data-reload.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
String replicationInstanceIdentifier
The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
String replicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
String replicationInstanceStatus
The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
Integer allocatedStorage
The amount of storage (in gigabytes) that is allocated for the replication instance.
Date instanceCreateTime
The time the replication instance was created.
List<E> vpcSecurityGroups
The VPC security group for the instance.
String availabilityZone
The Availability Zone for the instance.
ReplicationSubnetGroup replicationSubnetGroup
The subnet group for the replication instance.
String preferredMaintenanceWindow
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
ReplicationPendingModifiedValues pendingModifiedValues
The pending modification values.
Boolean multiAZ
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZone parameter if the Multi-AZ parameter is set to true.
String engineVersion
The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to
true.
Boolean autoMinorVersionUpgrade
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
String kmsKeyId
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your account. Your account has a different default encryption key for each Region.
String replicationInstanceArn
The Amazon Resource Name (ARN) of the replication instance.
String replicationInstancePublicIpAddress
The public IP address of the replication instance.
String replicationInstancePrivateIpAddress
The private IP address of the replication instance.
List<E> replicationInstancePublicIpAddresses
One or more public IP addresses for the replication instance.
List<E> replicationInstancePrivateIpAddresses
One or more private IP addresses for the replication instance.
Boolean publiclyAccessible
Specifies the accessibility options for the replication instance. A value of true represents an
instance with a public IP address. A value of false represents an instance with a private IP
address. The default value is true.
String secondaryAvailabilityZone
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
Date freeUntil
The expiration date of the free replication instance that is part of the Free DMS program.
String dnsNameServers
The DNS name servers supported for the replication instance to access your on-premise source or target database.
String replicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
Integer allocatedStorage
The amount of storage (in gigabytes) that is allocated for the replication instance.
Boolean multiAZ
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZone parameter if the Multi-AZ parameter is set to true.
String engineVersion
The engine version number of the replication instance.
String replicationSubnetGroupIdentifier
The identifier of the replication instance subnet group.
String replicationSubnetGroupDescription
A description for the replication subnet group.
String vpcId
The ID of the VPC.
String subnetGroupStatus
The status of the subnet group.
List<E> subnets
The subnets that are in the subnet group.
String replicationTaskIdentifier
The user-assigned replication task identifier or name.
Constraints:
Must contain 1-255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
String sourceEndpointArn
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
String targetEndpointArn
The ARN that uniquely identifies the endpoint.
String replicationInstanceArn
The ARN of the replication instance.
String migrationType
The type of migration.
String tableMappings
Table mappings specified in the task.
String replicationTaskSettings
The settings for the replication task.
String status
The status of the replication task. This response parameter can return one of the following values:
"moving" – The task is being moved in response to running the
MoveReplicationTask operation.
"creating" – The task is being created in response to running the
CreateReplicationTask operation.
"deleting" – The task is being deleted in response to running the
DeleteReplicationTask operation.
"failed" – The task failed to successfully complete the database migration in response to running
the
StartReplicationTask operation.
"failed-move" – The task failed to move in response to running the
MoveReplicationTask operation.
"modifying" – The task definition is being modified in response to running the
ModifyReplicationTask operation.
"ready" – The task is in a ready state where it can respond to other task operations,
such as
StartReplicationTask or
DeleteReplicationTask .
"running" – The task is performing a database migration in response to running the
StartReplicationTask operation.
"starting" – The task is preparing to perform a database migration in response to running the
StartReplicationTask operation.
"stopped" – The task has stopped in response to running the
StopReplicationTask operation.
"stopping" – The task is preparing to stop in response to running the
StopReplicationTask operation.
"testing" – The database migration specified for this task is being tested in response to running
either the
StartReplicationTaskAssessmentRun or the
StartReplicationTaskAssessment operation.
StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The
StartReplicationTaskAssessment operation assesses data type compatibility only between the
source and target database of a given migration task. In contrast,
StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task
assessments in addition to data type compatibility. These assessments include ones for the validity of primary
key definitions and likely issues with database migration performance, among others.
String lastFailureMessage
The last error (failure) message generated for the replication task.
String stopReason
The reason the replication task was stopped. This response parameter can return one of the following values:
"STOP_REASON_FULL_LOAD_COMPLETED" – Full-load migration completed.
"STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.
"STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped
as specified before starting the CDC migration.
"STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.
Date replicationTaskCreationDate
The date the replication task was created.
Date replicationTaskStartDate
The date the replication task is scheduled to start.
String cdcStartPosition
Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition
or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results
in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
String cdcStopPosition
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
String recoveryCheckpoint
Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this
value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskStats replicationTaskStats
The statistics for the task, including elapsed time, tables loaded, and table errors.
String taskData
Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.
String targetReplicationInstanceArn
The ARN of the replication instance to which this task is moved in response to running the
MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the
ReplicationTask object.
String replicationTaskIdentifier
The replication task identifier of the task on which the task assessment was run.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
Date replicationTaskLastAssessmentDate
The date the task assessment was completed.
String assessmentStatus
The status of the task assessment.
String assessmentResultsFile
The file containing the results of the task assessment.
String assessmentResults
The task assessment results in JSON format.
The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
String s3ObjectUrl
The URL of the S3 object containing the task assessment results.
The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
String replicationTaskAssessmentRunArn
Amazon Resource Name (ARN) of this assessment run.
String replicationTaskArn
ARN of the migration task associated with this premigration assessment run.
String status
Assessment run status.
This status can have one of the following values:
"cancelling" – The assessment run was canceled by the
CancelReplicationTaskAssessmentRun operation.
"deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun
operation.
"failed" – At least one individual assessment completed with a failed status.
"error-provisioning" – An internal error occurred while resources were provisioned (during
provisioning status).
"error-executing" – An internal error occurred while individual assessments ran (during
running status).
"invalid state" – The assessment run is in an unknown state.
"passed" – All individual assessments have completed, and none has a failed status.
"provisioning" – Resources required to run individual assessments are being provisioned.
"running" – Individual assessments are being run.
"starting" – The assessment run is starting, but resources are not yet being provisioned for
individual assessments.
Date replicationTaskAssessmentRunCreationDate
Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.
ReplicationTaskAssessmentRunProgress assessmentProgress
Indication of the completion progress for the individual assessments specified to run.
String lastFailureMessage
Last message generated by an individual assessment failure.
String serviceAccessRoleArn
ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun
operation. The role must allow the iam:PassRole action.
String resultLocationBucket
Amazon S3 bucket where DMS stores the results of this assessment run.
String resultLocationFolder
Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
String resultEncryptionMode
Encryption mode used to encrypt the assessment run results.
String resultKmsKeyArn
ARN of the KMS encryption key used to encrypt the assessment run results.
String assessmentRunName
Unique name of the assessment run.
String replicationTaskIndividualAssessmentArn
Amazon Resource Name (ARN) of this individual assessment.
String replicationTaskAssessmentRunArn
ARN of the premigration assessment run that is created to run this individual assessment.
String individualAssessmentName
Name of this individual assessment.
String status
Individual assessment status.
This status can have one of the following values:
"cancelled"
"error"
"failed"
"passed"
"pending"
"running"
Date replicationTaskIndividualAssessmentStartDate
Date when this individual assessment was started as part of running the
StartReplicationTaskAssessmentRun operation.
Integer fullLoadProgressPercent
The percent complete for the full load migration task.
Long elapsedTimeMillis
The elapsed time of the task, in milliseconds.
Integer tablesLoaded
The number of tables loaded for this task.
Integer tablesLoading
The number of tables currently loading for this task.
Integer tablesQueued
The number of tables queued for this task.
Integer tablesErrored
The number of errors that have occurred during this task.
Date freshStartDate
The date the replication task was started either with a fresh start or a target reload.
Date startDate
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType.
Date stopDate
The date the replication task was stopped.
Date fullLoadStartDate
The date the replication task full load was started.
Date fullLoadFinishDate
The date the replication task full load was completed.
String resourceArn
String resourceIdentifier
The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) for DMS in the DMS documentation.
List<E> pendingMaintenanceActionDetails
Detailed information about the pending maintenance action.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the
iam:PassRole action. It is a required parameter that enables DMS to write and read objects from an
S3 bucket.
String externalTableDefinition
Specifies how tables are defined in the S3 source files only.
String csvRowDelimiter
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return
(\n).
String csvDelimiter
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
String bucketFolder
An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path
bucketFolder/schema_name/table_name/. If this parameter isn't specified, then
the path used is schema_name/table_name/.
String bucketName
The name of the S3 bucket.
String compressionType
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats.
String 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 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, you need an Identity and Access Management (IAM) role with permission to allow
"arn:aws:s3:::dms-*" to use the following actions:
s3:CreateBucket
s3:ListBucket
s3:DeleteBucket
s3:GetBucketLocation
s3:GetObject
s3:PutObject
s3:DeleteObject
s3:GetObjectVersion
s3:GetBucketPolicy
s3:PutBucketPolicy
s3:DeleteBucketPolicy
String serverSideEncryptionKmsKeyId
If you are using SSE_KMS for the EncryptionMode, provide the KMS key ID. The key that
you use needs an attached policy that enables Identity and Access Management (IAM) user permissions and allows
use of the key.
Here is a CLI example:
aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value
String dataFormat
The format of the data that you want to use for output. You can choose one of the following:
csv : This is a row-based file format with comma-separated values (.csv).
parquet : Apache Parquet (.parquet) is a columnar storage file format that features efficient
compression and provides faster query response.
String encodingType
The type of encoding you are using:
RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values
more efficiently. This is the default.
PLAIN doesn't use encoding at all. Values are stored as they are.
PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is
stored in a dictionary page for each column chunk.
Integer dictPageSizeLimit
The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is
stored using an encoding type of PLAIN. This parameter defaults to 1024 * 1024 bytes (1 MiB), the
maximum size of a dictionary page before it reverts to PLAIN encoding. This size is used for
.parquet file format only.
Integer rowGroupLength
The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.
If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in
bytes (64 * 1024 * 1024).
Integer dataPageSize
The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only.
String parquetVersion
The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or
parquet_2_0.
Boolean enableStatistics
A value that enables statistics for Parquet pages and row groups. Choose true to enable statistics,
false to disable. Statistics include NULL, DISTINCT, MAX, and
MIN values. This parameter defaults to true. This value is used for .parquet file
format only.
Boolean includeOpForFullLoad
A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later.
For full load, records can only be inserted. By default (the false setting), no information is
recorded in these output files for a full load to indicate that the rows were inserted at the source database. If
IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I
annotation in the first field of the .csv file. This allows the format of your target records from a full load to
be consistent with the target records from a CDC load.
This setting works together with the CdcInsertsOnly and the CdcInsertsAndUpdates
parameters for output to .csv files only. For more information about how these settings work together, see
Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
Boolean cdcInsertsOnly
A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage
(.parquet) output files. By default (the false setting), the first field in a .csv or .parquet
record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was
inserted, updated, or deleted at the source database for a CDC load to the target.
If CdcInsertsOnly is set to true or y, only INSERTs from the source
database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends
on the value of IncludeOpForFullLoad. If IncludeOpForFullLoad is set to
true, the first field of every CDC record is set to I to indicate the INSERT operation at the
source. If IncludeOpForFullLoad is set to false, every CDC record is written without a
first field to indicate the INSERT operation at the source. For more information about how these settings work
together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the interaction described preceding between the CdcInsertsOnly and
IncludeOpForFullLoad parameters in versions 3.1.4 and later.
CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the
same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true
for the same endpoint, but not both.
String timestampColumnName
A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.
DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data
when you set TimestampColumnName to a nonblank value.
For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.
For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.
The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the
precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit
timestamp supported by DMS for the source database.
When the AddColumnName parameter is set to true, DMS also includes a name for the
timestamp column that you set with TimestampColumnName.
Boolean parquetTimestampInMillisecond
A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3
object file in .parquet format.
DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y, DMS writes all
TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes
them with microsecond precision.
Currently, Amazon Athena and Glue can handle only millisecond precision for TIMESTAMP values. Set
this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan to
query or process the data with Athena or Glue.
DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond
precision.
Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column
value that is inserted by setting the TimestampColumnName parameter.
Boolean cdcInsertsAndUpdates
A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet
(columnar storage) output files. The default setting is false, but when
CdcInsertsAndUpdates is set to true or y, only INSERTs and UPDATEs from
the source database are migrated to the .csv or .parquet file.
For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the
IncludeOpForFullLoad parameter. If IncludeOpForFullLoad is set to true,
the first field of every CDC record is set to either I or U to indicate INSERT and
UPDATE operations at the source. But if IncludeOpForFullLoad is set to false, CDC
records are written without an indication of INSERT or UPDATE operations at the source. For more information
about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the use of the CdcInsertsAndUpdates parameter in versions 3.3.1 and later.
CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the
same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true
for the same endpoint, but not both.
Boolean datePartitionEnabled
When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The
default value is false. For more information about date-based folder partitioning, see Using
date-based folder partitioning.
String datePartitionSequence
Identifies the sequence of the date format to use during folder partitioning. The default value is
YYYYMMDD. Use this parameter when DatePartitionedEnabled is set to true.
String datePartitionDelimiter
Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH.
Use this parameter when DatePartitionedEnabled is set to true.
Boolean useCsvNoSupValue
This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format.
If set to true for columns not included in the supplemental log, DMS uses the value specified by
CsvNoSupValue . If not set or set to false, DMS uses the null value for these
columns.
This setting is supported in DMS versions 3.4.1 and later.
String csvNoSupValue
This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in
.csv format. If
UseCsvNoSupValue is set to true, specify a string value that you want DMS to use for all
columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for
these columns regardless of the UseCsvNoSupValue setting.
This setting is supported in DMS versions 3.4.1 and later.
Boolean preserveTransactions
If set to true, DMS saves the transaction order for a change data capture (CDC) load on the Amazon
S3 target specified by
CdcPath . For more information, see Capturing data changes (CDC) including transaction order on the S3 target.
This setting is supported in DMS versions 3.4.2 and later.
String cdcPath
Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change
data; otherwise, it's optional. If CdcPath is set, DMS reads CDC files from this path and replicates
the data changes to the target endpoint. For an S3 target if you set PreserveTransactions to true, DMS verifies that you have set this parameter to a
folder path on your S3 target where DMS can save the transaction order for the CDC load. DMS creates this CDC
folder path in either your S3 target working directory or the S3 target location specified by
BucketFolder and
BucketName .
For example, if you specify CdcPath as MyChangedData, and you specify
BucketName as MyTargetBucket but do not specify BucketFolder, DMS creates
the CDC folder path following: MyTargetBucket/MyChangedData.
If you specify the same CdcPath, and you specify BucketName as
MyTargetBucket and BucketFolder as MyTargetData, DMS creates the CDC
folder path following: MyTargetBucket/MyTargetData/MyChangedData.
For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target.
This setting is supported in DMS versions 3.4.2 and later.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
ReplicationTask replicationTask
The assessed replication task.
String replicationTaskArn
Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
String serviceAccessRoleArn
ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole
action.
String resultLocationBucket
Amazon S3 bucket where you want DMS to store the results of this assessment run.
String resultLocationFolder
Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
String resultEncryptionMode
Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:
"SSE_S3" – The server-side encryption provided as a default by Amazon S3.
"SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS
encryption key that you specify or the default KMS encryption key that DMS provides.
String resultKmsKeyArn
ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to
"SSE_KMS".
String assessmentRunName
Unique name to identify the assessment run.
List<E> includeOnly
Space-separated list of names for specific individual assessments that you want to include. These names come from
the default list of individual assessments that DMS supports for the associated migration task. This task is
specified by ReplicationTaskArn.
You can't set a value for IncludeOnly if you also set a value for Exclude in the API
operation.
To identify the names of the default individual assessments that DMS supports for the associated migration task,
run the DescribeApplicableIndividualAssessments operation using its own
ReplicationTaskArn request parameter.
List<E> exclude
Space-separated list of names for specific individual assessments that you want to exclude. These names come from
the default list of individual assessments that DMS supports for the associated migration task. This task is
specified by ReplicationTaskArn.
You can't set a value for Exclude if you also set a value for IncludeOnly in the API
operation.
To identify the names of the default individual assessments that DMS supports for the associated migration task,
run the DescribeApplicableIndividualAssessments operation using its own
ReplicationTaskArn request parameter.
ReplicationTaskAssessmentRun replicationTaskAssessmentRun
The premigration assessment run that was started.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task to be started.
String startReplicationTaskType
A type of replication task.
Date cdcStartTime
Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
String cdcStartPosition
Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be
created and associated with the source endpoint. You can verify this by setting the slotName extra
connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
String cdcStopPosition
Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
ReplicationTask replicationTask
The replication task started.
String replicationTaskArn
The Amazon Resource Name(ARN) of the replication task to be stopped.
ReplicationTask replicationTask
The replication task stopped.
String subnetIdentifier
The subnet identifier.
AvailabilityZone subnetAvailabilityZone
The Availability Zone of the subnet.
String subnetStatus
The status of the subnet.
String engineName
The database engine name. Valid values, depending on the EndpointType, include "mysql",
"oracle", "postgres", "mariadb", "aurora",
"aurora-postgresql", "redshift", "s3", "db2",
"azuredb", "sybase", "dynamodb", "mongodb",
"kinesis", "kafka", "elasticsearch", "documentdb",
"sqlserver", and "neptune".
Boolean supportsCDC
Indicates if change data capture (CDC) is supported.
String endpointType
The type of endpoint. Valid values are source and target.
String replicationInstanceEngineMinimumVersion
The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.
String engineDisplayName
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this
value would be "Amazon Aurora MySQL."
String databaseName
Database name for the endpoint.
String password
Endpoint connection password.
Integer port
Endpoint TCP port.
String serverName
Fully qualified domain name of the endpoint.
String username
Endpoint connection user name.
String 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 SAP ASE 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.
String secretsManagerSecretId
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE
endpoint connection details.
String schemaName
The schema name.
String tableName
The name of the table.
Long inserts
The number of insert actions performed on a table.
Long deletes
The number of delete actions performed on a table.
Long updates
The number of update actions performed on a table.
Long ddls
The data definition language (DDL) used to build and modify the structure of your tables.
Long fullLoadRows
The number of rows added during the full load operation.
Long fullLoadCondtnlChkFailedRows
The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).
Long fullLoadErrorRows
The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).
Date fullLoadStartTime
The time when the full load operation started.
Date fullLoadEndTime
The time when the full load operation completed.
Boolean fullLoadReloaded
A value that indicates if the table was reloaded (true) or loaded as part of a new full load
operation (false).
Date lastUpdateTime
The last time a table was updated.
String tableState
The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
Long validationPendingRecords
The number of records that have yet to be validated.
Long validationFailedRecords
The number of records that failed validation.
Long validationSuspendedRecords
The number of records that couldn't be validated.
String validationState
The validation state of the table.
This parameter can have the following values:
Not enabled – Validation isn't enabled for the table in the migration task.
Pending records – Some records in the table are waiting for validation.
Mismatched records – Some records in the table don't match between the source and target.
Suspended records – Some records in the table couldn't be validated.
No primary key –The table couldn't be validated because it has no primary key.
Table error – The table wasn't validated because it's in an error state and some data wasn't migrated.
Validated – All rows in the table are validated. If the table is updated, the status can change from Validated.
Error – The table couldn't be validated because of an unexpected error.
Pending validation – The table is waiting validation.
Preparing table – Preparing the table enabled in the migration task for validation.
Pending revalidation – All rows in the table are pending validation after the table was updated.
String validationStateDetails
Additional details about the state of validation.
String key
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
String value
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
Connection connection
The connection tested.
Copyright © 2021. All rights reserved.