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. An opt-in request of type
immediate cannot be undone.
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
The customer-assigned name of the certificate. Valid characters are A-z and 0-9.
Date certificateCreationDate
The date that the certificate was created.
String certificatePem
The contents of the .pem X.509 certificate file for the certificate.
ByteBuffer certificateWallet
The location of the 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 Amazon Resource Name (ARN) of the replication instance.
String endpointArn
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
String status
The connection status.
String lastFailureMessage
The error message when the connection last failed.
String endpointIdentifier
The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not 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; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
String endpointType
The type of endpoint.
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, and sqlserver.
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.
String kmsKeyId
The AWS KMS key identifier to use to encrypt the connection parameters. 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
Tags to be added 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 SSL mode can be one of four values:
none, require, verify-ca, verify-full. The default value 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 more information about the 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 attributes 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 attributes is as follows:
ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these attributes 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 Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration 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 User Guide.
RedshiftSettings redshiftSettings
Endpoint endpoint
The endpoint that was created.
String subscriptionName
The name of the AWS DMS event notification subscription.
Constraints: The 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
is not specified, all events are returned.
Valid values: replication-instance | migration-task
List<E> eventCategories
A list of event categories for a source type that you want to subscribe to. You can see a list of the categories
for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and
Notifications in the AWS Database Migration Service User Guide.
List<E> sourceIds
The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
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
A tag to be attached 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 from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot 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 specified by the replication instance class.
Valid Values:
dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
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 EC2 Availability Zone that the replication instance will be created in.
Default: A random, system-chosen Availability Zone in the endpoint's region.
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 if the replication instance is a Multi-AZ deployment. You cannot 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
Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
Default: true
List<E> tags
Tags to be associated with the replication instance.
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.
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 DNS name servers supported for the replication instance.
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
The EC2 subnet IDs for the subnet group.
List<E> tags
The tag to be assigned to the subnet group.
ReplicationSubnetGroup replicationSubnetGroup
The replication subnet group that was created.
String replicationTaskIdentifier
The replication task identifier.
Constraints:
Must contain from 1 to 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 migration type.
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
Settings for the task, such as target metadata settings. For a complete list of task settings, see 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”
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
Tags to be added to the replication instance.
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.
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> 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 type of endpoints that are supported.
String sourceIdentifier
The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.
String sourceType
The type of AWS DMS resource that generates events.
Valid values: replication-instance | migration-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 a source type that you want to subscribe to.
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 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.
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 will return only one result and ignore the values of the max-records 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
Set this flag to avoid returning setting information. Use this to reduce overhead when settings are too large. Choose TRUE to use this flag, otherwise choose FALSE (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 that DMS retries failed API requests to the Elasticsearch cluster.
String endpointIdentifier
The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
String endpointType
The type of endpoint.
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, sybase, dynamodb, mongodb, and sqlserver.
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
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 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.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
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 attributes 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 attributes is as follows:
ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
JSON syntax for these attributes 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 source endpoint. For more information, see the KinesisSettings
structure.
ElasticsearchSettings elasticsearchSettings
The settings for the Elasticsearch source endpoint. For more information, see the
ElasticsearchSettings structure.
RedshiftSettings redshiftSettings
Settings for the Amazon Redshift endpoint
String sourceIdentifier
The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
Constraints:replication instance, endpoint, migration task
String sourceType
The type of AWS DMS resource that generates events.
Valid values: replication-instance | endpoint | migration-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 RDS event notification subscription was created.
String sourceType
The type of AWS DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | migration-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
The customer-assigned name of the certificate. Valid characters are A-z and 0-9.
String certificatePem
The contents of the .pem X.509 certificate file for the certificate.
ByteBuffer certificateWallet
The location of the 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 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.
String serviceAccessRoleArn
The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
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; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
String endpointType
The type of endpoint.
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, sybase, dynamodb, mongodb, and sqlserver.
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 to be used.
SSL mode can be one of four values: none, require, verify-ca, verify-full.
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 more information about the 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 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. Set to NONE (the default) or do not use to leave the files uncompressed.
Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
JSON syntax:
{ "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 Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration 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 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 | migration-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.
Valid Values:
dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
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 if the replication instance is a Multi-AZ deployment. You cannot 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.
Constraints: 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
Indicates that minor version upgrades will be applied automatically to the replication instance during the
maintenance window. Changing this parameter does not result in an outage except in the following case and the
change is asynchronously applied as soon as possible. An outage will result if this parameter is set to
true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled
auto patching for that 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
The description of 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 from 1 to 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 target 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”
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 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.
Valid values: NO, PASSWORD
When NO is selected, 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.
Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.
String nestingLevel
Specifies either document or table mode.
Valid values: NONE, ONE
Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
String extractDocId
Specifies the document ID. Use this attribute 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 attribute 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 attribute is not used when authType=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 engineVersion
The version of the replication engine.
String replicationInstanceClass
The compute and memory capacity of the replication instance.
Valid Values:
dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
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 action
The type of pending maintenance action that is available for the resource.
Date autoAppliedAfterDate
The date of the maintenance window when the action will be applied. The maintenance action will be 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 will be 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
Indicates 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, the
AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request
has not been received and nothing has been specified as 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
Allows 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 (default).
This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
String afterConnectScript
Code to run after connecting. This should be the code, not a filename.
String bucketFolder
The location where the 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
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) you are working with.
String dateFormat
The date format you are using. Valid values are auto (case-sensitive), your date format string
enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using
auto recognizes most strings, even some that are not 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
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 you want to use for your data. This is part of the endpoint settings or the
extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3,
create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions:
"s3:PutObject", "s3:ListBucket".
Integer fileTransferUploadStreams
Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
Integer loadTimeout
Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
Integer maxFileSize
Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 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
Removes 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 chars you want to replace. Use with ReplaceChars.
String replaceChars
Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value
instead. The default is "?".
String serverName
The name of the Amazon Redshift cluster you are using.
String serviceAccessRoleArn
The ARN of the role that has access to the Redshift service.
String serverSideEncryptionKmsKeyId
If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an
attached policy that enables IAM user permissions and allows use of the key.
String timeFormat
The time format 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 are not supported when you use a time format string.
If your date and time values use formats different from each other, set this to auto.
Boolean trimBlanks
Removes 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
Truncates data in columns to the appropriate number of characters, so that it fits in the column. 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 to 2048. Defaults to 1024. 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 from 1 to 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.
Valid Values:
dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
String replicationInstanceStatus
The status of the replication instance.
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 if the replication instance is a Multi-AZ deployment. You cannot 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
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 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
The public IP address of the replication instance.
List<E> replicationInstancePrivateIpAddresses
The private IP address of 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 for the replication instance.
String replicationInstanceClass
The compute and memory capacity of the replication instance.
Valid Values:
dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
Integer allocatedStorage
The amount of storage (in gigabytes) that is allocated for the replication instance.
Boolean multiAZ
Specifies if the replication instance is a Multi-AZ deployment. You cannot 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
The description of 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 from 1 to 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.
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 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”
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 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.
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) 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 is not 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. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.
String encryptionMode
The type of server side encryption you want to use for your data. This is part of the endpoint settings or the
extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or
SSE_KMS. To use SSE_S3, you need an 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 you use needs an
attached policy that enables 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 which you want to use for output. You can choose one of the following:
CSV : This is a row-based format with comma-separated values.
PARQUET : Apache Parquet is a columnar storage format that features efficient compression and
provides faster query response.
String encodingType
The type of encoding you are using: RLE_DICTIONARY (default), PLAIN, or
PLAIN_DICTIONARY.
RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values
more efficiently.
PLAIN does not 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. Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a
dictionary page before it reverts to PLAIN encoding. For PARQUET 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. Defaults to 10,000 (ten thousand) rows. For PARQUET 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. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.
String parquetVersion
The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or
PARQUET_2_0.
Boolean enableStatistics
Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose
FALSE to disable. Statistics include NULL, DISTINCT, MAX, and
MIN values. Defaults to TRUE. For PARQUET format only.
Boolean cdcInsertsOnly
Option to write only INSERT operations to the comma-separated value (CSV) output files. By default,
the first field in a CSV record contains the letter I (insert), U (update) or
D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If
cdcInsertsOnly is set to true, then only INSERTs are recorded in the CSV file, without
the I annotation on each line. Valid values are TRUE and FALSE.
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”
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, sybase, dynamodb, mongodb, and sqlserver.
Boolean supportsCDC
Indicates if Change Data Capture (CDC) is supported.
String endpointType
The type of endpoint.
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 DynamoDB as a target migrations).
Long fullLoadErrorRows
The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).
Date lastUpdateTime
The last time the 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 could not be validated.
String validationState
The validation state of the table.
The parameter can have the following values
Not enabled—Validation is not 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 do not match between the source and target.
Suspended records—Some records in the table could not be validated.
No primary key—The table could not be validated because it had no primary key.
Table error—The table was not validated because it was in an error state and some data was not migrated.
Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.
Error—The table could not 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 from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
String value
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
Connection connection
The connection tested.
Copyright © 2019. All rights reserved.