String resourceArn
Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).
For AWS 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 AWS 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 AWS DMS resource that the pending maintenance action will be applied to.
String name
The name of the Availability Zone.
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",
"documentdb", "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.
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 AWS DMS Endpoints in the AWS Database Migration Service User Guide.
String kmsKeyId
An AWS 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 AWS DMS uses your default encryption
key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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.
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 AWS 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 AWS DMS in the AWS 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.
BucketName - The name of the S3 bucket to use.
CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
this value to NONE (the default). To keep the files uncompressed, don't use this value.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
MongoDbSettings mongoDbSettings
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a Target for AWS Database Migration Service in the AWS 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 Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS 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 Apache Kafka as a Target for AWS Database Migration Service in the AWS 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 AWS DMS in the AWS 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 Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
RedshiftSettings redshiftSettings
Endpoint endpoint
The endpoint that was created.
String subscriptionName
The name of the AWS 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 AWS 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 AWS Database Migration Service User Guide.
List<E> sourceIds
A list of identifiers for which AWS 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 AWS 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 AWS 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 AWS 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.
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 AWS 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 AWS DMS uses your default encryption
key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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"
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 AWS Database Migration Service User Guide.
String replicationTaskSettings
Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration 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 AWS 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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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 AWS Database Migration Service User Guide.
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 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 AWS DMS identifier for an account in a particular AWS 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 AWS 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.
AWS DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.
List<E> filters
Filters applied to the certificate 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.
List<E> filters
Filters applied to the describe action.
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 describe action.
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 AWS 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 the action.
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 AWS DMS event subscription to be described.
List<E> filters
Filters applied to the action.
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 the describe action.
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 the describe action.
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 describe action.
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 the describe table statistics action.
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 Amazon Resource Name (ARN) used by the service access IAM role.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) used by service to access the IAM role.
String endpointUri
The endpoint for the Elasticsearch cluster.
Integer fullLoadErrorPercentage
The maximum percentage of records that can fail to be written before a 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 AWS 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 AWS DMS uses your default encryption
key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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 access IAM role.
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 target DynamoDB database. 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.
BucketName - The name of the S3 bucket to use.
CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
this value to NONE (the default). To keep the files uncompressed, don't use this value.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
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.
String sourceIdentifier
The identifier of an event source.
String sourceType
The type of AWS 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 AWS customer account associated with the AWS DMS event notification subscription.
String custSubscriptionId
The AWS DMS event notification subscription Id.
String snsTopicArn
The topic ARN of the AWS DMS event notification subscription.
String status
The status of the AWS 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 AWS 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 AWS DMS event notification subscription was created.
String sourceType
The type of AWS 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 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.
List<E> tags
The tags associated with the certificate.
Certificate certificate
The certificate to be uploaded.
String broker
The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form
broker-hostname-or-ip:port . For example,
"ec2-12-345-678-901.compute-1.amazonaws.com:2345".
String topic
The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies
"kafka-default-topic" as the migration topic.
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 AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.
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.
String resourceArn
The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
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.
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 service access role you want to use to modify the endpoint.
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 AWS 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 AWS DMS in the AWS 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 AWS Identity and Access Management (IAM) role that has permission to access the Amazon S3 bucket.
BucketName - The name of the S3 bucket to use.
compressionType - An optional parameter to use GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
MongoDbSettings mongoDbSettings
Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS 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 Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS 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 Apache Kafka as a Target for AWS Database Migration Service in the AWS 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 AWS DMS in the AWS 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 Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
RedshiftSettings redshiftSettings
Endpoint endpoint
The modified endpoint.
String subscriptionName
The name of the AWS 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 AWS 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 AWS 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.
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 dsecribed 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.
AWS 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 AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the
path with file://. When working with the DMS API, provide the JSON as the parameter value, for
example: --table-mappings file://mappingfile.json
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 AWS 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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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 AWS 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 AWS 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 AWS DMS uses your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has a different default encryption key for each
AWS Region.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.
String s3BucketName
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.
String s3BucketFolder
A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by
S3BucketName
Integer errorRetryDuration
The number of milliseconds for AWS 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 AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.
Integer maxRetryCount
The number of times for AWS 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 AWS 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.
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 AWS 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.
AWS 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 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
The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.
String bucketName
The name of the S3 bucket you want to use
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 AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of
true sets empty CHAR and VARCHAR fields to null. The default is false.
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. To use SSE_S3, create an AWS Identity and Access Management
(IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions:
"s3:PutObject", "s3:ListBucket"
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.
Integer loadTimeout
The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
Integer maxFileSize
The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift. This accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).
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.
String serverSideEncryptionKmsKeyId
The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key
ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
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 of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance.
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. 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.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS 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.
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.
Boolean autoMinorVersionUpgrade
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
String kmsKeyId
An AWS 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 AWS DMS uses your default encryption
key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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 AWS 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) string that uniquely identifies the endpoint.
String targetEndpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
String replicationInstanceArn
The Amazon Resource Name (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.
String lastFailureMessage
The last error (failure) message generated for the replication instance.
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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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 AWS Database Migration Service User Guide.
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.
String s3ObjectUrl
The URL of the S3 object containing the task assessment results.
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 AWS 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 access IAM role.
String externalTableDefinition
The external table definition.
String csvRowDelimiter
The delimiter used to separate rows in the source files. The default is a carriage return (\n).
String csvDelimiter
The delimiter used to separate columns in the source files. 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. To use SSE_S3, you need an AWS 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 AWS KMS key ID. The key
that you use needs an attached policy that enables AWS 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.
AWS 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 AWS 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 AWS Database Migration Service User
Guide..
AWS 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 AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
AWS 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.
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or y, AWS DMS writes all
TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes
them with microsecond precision.
Currently, Amazon Athena and AWS 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 AWS Glue.
AWS 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 trueor y, 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 AWS Database Migration Service User
Guide..
AWS 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.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task.
ReplicationTask replicationTask
The assessed replication task.
String replicationTaskArn
The Amazon Resource Name (ARN) of the replication task to be started.
String startReplicationTaskType
The 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 AWS 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:3018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 3018-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 AWS DMS engine version that supports this endpoint engine. Note that endpoint engines released with AWS 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 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.
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 © 2020. All rights reserved.