Module aws_sdk_databasemigration::model

Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.

Modules

account_quota

See AccountQuota.

availability_zone

See AvailabilityZone.

certificate

See Certificate.

collector_health_check

See CollectorHealthCheck.

collector_response

See CollectorResponse.

collector_short_info_response

See CollectorShortInfoResponse.

connection

See Connection.

database_instance_software_details_response

See DatabaseInstanceSoftwareDetailsResponse.

database_response

See DatabaseResponse.

database_short_info_response

See DatabaseShortInfoResponse.

dms_transfer_settings

See DmsTransferSettings.

doc_db_settings

See DocDbSettings.

dynamo_db_settings

See DynamoDbSettings.

elasticsearch_settings

See ElasticsearchSettings.

endpoint

See Endpoint.

endpoint_setting

See EndpointSetting.

event

See Event.

event_category_group

See EventCategoryGroup.

event_subscription

See EventSubscription.

filter

See Filter.

fleet_advisor_lsa_analysis_response

See FleetAdvisorLsaAnalysisResponse.

fleet_advisor_schema_object_response

See FleetAdvisorSchemaObjectResponse.

gcp_my_sql_settings

See GcpMySqlSettings.

ibm_db2_settings

See IbmDb2Settings.

inventory_data

See InventoryData.

kafka_settings

See KafkaSettings.

kinesis_settings

See KinesisSettings.

microsoft_sql_server_settings

See MicrosoftSqlServerSettings.

mongo_db_settings

See MongoDbSettings.

my_sql_settings

See MySqlSettings.

neptune_settings

See NeptuneSettings.

oracle_settings

See OracleSettings.

orderable_replication_instance

See OrderableReplicationInstance.

pending_maintenance_action

See PendingMaintenanceAction.

postgre_sql_settings

See PostgreSqlSettings.

redis_settings

See RedisSettings.

redshift_settings

See RedshiftSettings.

refresh_schemas_status

See RefreshSchemasStatus.

replication_instance

See ReplicationInstance.

replication_instance_task_log

See ReplicationInstanceTaskLog.

replication_pending_modified_values

See ReplicationPendingModifiedValues.

replication_subnet_group

See ReplicationSubnetGroup.

replication_task

See ReplicationTask.

replication_task_assessment_result

See ReplicationTaskAssessmentResult.

replication_task_assessment_run

See ReplicationTaskAssessmentRun.

replication_task_assessment_run_progress

See ReplicationTaskAssessmentRunProgress.

replication_task_individual_assessment

See ReplicationTaskIndividualAssessment.

replication_task_stats

See ReplicationTaskStats.

resource_pending_maintenance_actions

See ResourcePendingMaintenanceActions.

s3_settings

See S3Settings.

schema_response

See SchemaResponse.

schema_short_info_response

See SchemaShortInfoResponse.

server_short_info_response

See ServerShortInfoResponse.

subnet

See Subnet.

supported_endpoint_type

See SupportedEndpointType.

sybase_settings

See SybaseSettings.

table_statistics

See TableStatistics.

table_to_reload

See TableToReload.

tag

See Tag.

vpc_security_group_membership

See VpcSecurityGroupMembership.

Structs

AccountQuota

Describes a quota for an Amazon Web Services account, for example the number of replication instances allowed.

AvailabilityZone

The name of an Availability Zone for use during database migration. AvailabilityZone is an optional parameter to the CreateReplicationInstance operation, and it’s value relates to the Amazon Web Services Region of an endpoint. For example, the availability zone of an endpoint in the us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.

Certificate

The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

CollectorHealthCheck

Describes the last Fleet Advisor collector health check.

CollectorResponse

Describes a Fleet Advisor collector.

CollectorShortInfoResponse

Briefly describes a Fleet Advisor collector.

Connection

Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.

DatabaseInstanceSoftwareDetailsResponse

Describes an inventory database instance for a Fleet Advisor collector.

DatabaseResponse

Describes a database in a Fleet Advisor collector inventory.

DatabaseShortInfoResponse

Describes a database in a Fleet Advisor collector inventory.

DmsTransferSettings

The settings in JSON format for the DMS Transfer type source endpoint.

DocDbSettings

Provides information that defines a DocumentDB endpoint.

DynamoDbSettings

Provides the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.

ElasticsearchSettings

Provides information that defines an OpenSearch endpoint.

Endpoint

Describes an endpoint of a database instance in response to operations such as the following:

EndpointSetting

Endpoint settings.

Event

Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the DMS resource type.

EventCategoryGroup

Lists categories of events subscribed to, and generated by, the applicable DMS resource type. This data type appears in response to the DescribeEventCategories action.

EventSubscription

Describes an event notification subscription created by the CreateEventSubscription operation.

Filter

Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

FleetAdvisorLsaAnalysisResponse

Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor collector.

FleetAdvisorSchemaObjectResponse

Describes a schema object in a Fleet Advisor collector inventory.

GcpMySqlSettings

Settings in JSON format for the source GCP MySQL endpoint.

IbmDb2Settings

Provides information that defines an IBM Db2 LUW endpoint.

InventoryData

Describes a Fleet Advisor collector inventory.

KafkaSettings

Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

KinesisSettings

Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

MicrosoftSqlServerSettings

Provides information that defines a Microsoft SQL Server endpoint.

MongoDbSettings

Provides information that defines a MongoDB endpoint.

MySqlSettings

Provides information that defines a MySQL endpoint.

NeptuneSettings

Provides information that defines an Amazon Neptune endpoint.

OracleSettings

Provides information that defines an Oracle endpoint.

OrderableReplicationInstance

In response to the DescribeOrderableReplicationInstances operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.

PendingMaintenanceAction

Describes a maintenance action pending for an DMS resource, including when and how it will be applied. This data type is a response element to the DescribePendingMaintenanceActions operation.

PostgreSqlSettings

Provides information that defines a PostgreSQL endpoint.

RedisSettings

Provides information that defines a Redis target endpoint.

RedshiftSettings

Provides information that defines an Amazon Redshift endpoint.

RefreshSchemasStatus

Provides information that describes status of a schema at an endpoint specified by the DescribeRefreshSchemaStatus operation.

ReplicationInstance

Provides information that defines a replication instance.

ReplicationInstanceTaskLog

Contains metadata for a replication instance task log.

ReplicationPendingModifiedValues

Provides information about the values of pending modifications to a replication instance. This data type is an object of the ReplicationInstance user-defined data type.

ReplicationSubnetGroup

Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.

ReplicationTask

Provides information that describes a replication task created by the CreateReplicationTask operation.

ReplicationTaskAssessmentResult

The task assessment report in JSON format.

ReplicationTaskAssessmentRun

Provides information that describes a premigration assessment run that you have started using the StartReplicationTaskAssessmentRun operation.

ReplicationTaskAssessmentRunProgress

The progress values reported by the AssessmentProgress response element.

ReplicationTaskIndividualAssessment

Provides information that describes an individual assessment from a premigration assessment run.

ReplicationTaskStats

In response to a request by the DescribeReplicationTasks operation, this object provides a collection of statistics about a replication task.

ResourcePendingMaintenanceActions

Identifies an DMS resource and any pending actions for it.

S3Settings

Settings for exporting data to Amazon S3.

SchemaResponse

Describes a schema in a Fleet Advisor collector inventory.

SchemaShortInfoResponse

Describes a schema in a Fleet Advisor collector inventory.

ServerShortInfoResponse

Describes a server in a Fleet Advisor collector inventory.

Subnet

In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.

SupportedEndpointType

Provides information about types of supported endpoints in response to a request by the DescribeEndpointTypes operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.

SybaseSettings

Provides information that defines a SAP ASE endpoint.

TableStatistics

Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.

TableToReload

Provides the name of the schema and table to be reloaded.

Tag

A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:

VpcSecurityGroupMembership

Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.

Enums

AuthMechanismValue

When writing a match expression against AuthMechanismValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AuthTypeValue

When writing a match expression against AuthTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CannedAclForObjectsValue

When writing a match expression against CannedAclForObjectsValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CharLengthSemantics

When writing a match expression against CharLengthSemantics, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CollectorStatus

When writing a match expression against CollectorStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CompressionTypeValue

When writing a match expression against CompressionTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DataFormatValue

When writing a match expression against DataFormatValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DatePartitionDelimiterValue

When writing a match expression against DatePartitionDelimiterValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DatePartitionSequenceValue

When writing a match expression against DatePartitionSequenceValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DmsSslModeValue

When writing a match expression against DmsSslModeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncodingTypeValue

When writing a match expression against EncodingTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionModeValue

When writing a match expression against EncryptionModeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EndpointSettingTypeValue

When writing a match expression against EndpointSettingTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

KafkaSecurityProtocol

When writing a match expression against KafkaSecurityProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MessageFormatValue

When writing a match expression against MessageFormatValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MigrationTypeValue

When writing a match expression against MigrationTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NestingLevelValue

When writing a match expression against NestingLevelValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParquetVersionValue

When writing a match expression against ParquetVersionValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PluginNameValue

When writing a match expression against PluginNameValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RedisAuthTypeValue

When writing a match expression against RedisAuthTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RefreshSchemasStatusTypeValue

When writing a match expression against RefreshSchemasStatusTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ReleaseStatusValues

When writing a match expression against ReleaseStatusValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ReloadOptionValue

When writing a match expression against ReloadOptionValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ReplicationEndpointTypeValue

When writing a match expression against ReplicationEndpointTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SafeguardPolicy

When writing a match expression against SafeguardPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SourceType

When writing a match expression against SourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SslSecurityProtocolValue

When writing a match expression against SslSecurityProtocolValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StartReplicationTaskTypeValue

When writing a match expression against StartReplicationTaskTypeValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TargetDbType

When writing a match expression against TargetDbType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VersionStatus

When writing a match expression against VersionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.