openapi: 3.0.0
info:
version: 2016-01-01
x-release: v4
title: 'AWS Database Migration Service Endpoints #X Amz Target=AmazonDMSv20160101.ModifyReplicationInstance API'
description:
Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.
For more information about DMS, see What Is Database Migration Service? in the Database Migration Service User Guide.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: dms x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/dms-2016-01-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://dms.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Database Migration Service multi-region endpoint - url: https://dms.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Database Migration Service multi-region endpoint - url: http://dms.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia) - url: https://dms.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=AmazonDMSv20160101.ModifyReplicationInstance' paths: /#X-Amz-Target=AmazonDMSv20160101.ModifyReplicationInstance: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ModifyReplicationInstance description:Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ModifyReplicationInstanceResponse' '480': description: AccessDeniedFault content: application/json: schema: $ref: '#/components/schemas/AccessDeniedFault' '481': description: InvalidResourceStateFault content: application/json: schema: $ref: '#/components/schemas/InvalidResourceStateFault' '482': description: ResourceAlreadyExistsFault content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsFault' '483': description: ResourceNotFoundFault content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundFault' '484': description: InsufficientResourceCapacityFault content: application/json: schema: $ref: '#/components/schemas/InsufficientResourceCapacityFault' '485': description: StorageQuotaExceededFault content: application/json: schema: $ref: '#/components/schemas/StorageQuotaExceededFault' '486': description: UpgradeDependencyFailureFault content: application/json: schema: $ref: '#/components/schemas/UpgradeDependencyFailureFault' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ModifyReplicationInstanceMessage' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.ModifyReplicationInstance tags: - '#X Amz Target=AmazonDMSv20160101.ModifyReplicationInstance' components: schemas: AvailabilityZone: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the Availability Zone. description: 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.
InsufficientResourceCapacityFault: {}
UpgradeDependencyFailureFault: {}
BooleanOptional:
type: boolean
StringList:
type: array
items:
$ref: '#/components/schemas/String'
Subnet:
type: object
properties:
SubnetIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: The subnet identifier.
SubnetAvailabilityZone:
allOf:
- $ref: '#/components/schemas/AvailabilityZone'
- description: The Availability Zone of the subnet.
SubnetStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of the subnet.
description: In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
ReplicationPendingModifiedValues:
type: object
properties:
ReplicationInstanceClass:
allOf:
- $ref: '#/components/schemas/String'
- description: The compute and memory capacity of the replication instance as defined for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
AllocatedStorage: allOf: - $ref: '#/components/schemas/IntegerOptional' - description: The amount of storage (in gigabytes) that is allocated for the replication instance. MultiAZ: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: ' Specifies whether the replication instance is a Multi-AZ deployment. You can''t set theAvailabilityZone parameter if the Multi-AZ parameter is set to true. '
EngineVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: The engine version number of the replication instance.
NetworkType:
allOf:
- $ref: '#/components/schemas/String'
- description: The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
description: '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. '
ReplicationInstanceIpv6AddressList:
type: array
items:
$ref: '#/components/schemas/String'
TStamp:
type: string
format: date-time
SubnetList:
type: array
items:
$ref: '#/components/schemas/Subnet'
ReplicationInstance:
type: object
properties:
ReplicationInstanceIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.
Constraints:
Must contain 1-63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationInstanceStatus: allOf: - $ref: '#/components/schemas/String' - description:The status of the replication instance. The possible return values include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
AvailabilityZone parameter if the Multi-AZ parameter is set to true. '
EngineVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
An KMS key identifier that is used to encrypt the data on the replication instance.
If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
ReplicationInstanceArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the replication instance. ReplicationInstancePublicIpAddress: allOf: - $ref: '#/components/schemas/String' - deprecated: true description: The public IP address of the replication instance. ReplicationInstancePrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - deprecated: true description: The private IP address of the replication instance. ReplicationInstancePublicIpAddresses: allOf: - $ref: '#/components/schemas/ReplicationInstancePublicIpAddressList' - description: One or more public IP addresses for the replication instance. ReplicationInstancePrivateIpAddresses: allOf: - $ref: '#/components/schemas/ReplicationInstancePrivateIpAddressList' - description: One or more private IP addresses for the replication instance. ReplicationInstanceIpv6Addresses: allOf: - $ref: '#/components/schemas/ReplicationInstanceIpv6AddressList' - description: One or more IPv6 addresses for the replication instance. PubliclyAccessible: allOf: - $ref: '#/components/schemas/Boolean' - description: ' Specifies the accessibility options for the replication instance. A value oftrue 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. '
SecondaryAvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The Availability Zone of the standby replication instance in a Multi-AZ deployment.
FreeUntil:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: ' The expiration date of the free replication instance that is part of the Free DMS program. '
DnsNameServers:
allOf:
- $ref: '#/components/schemas/String'
- description: The DNS name servers supported for the replication instance to access your on-premise source or target database.
NetworkType:
allOf:
- $ref: '#/components/schemas/String'
- description: The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
description: Provides information that defines a replication instance.
Integer:
type: integer
InvalidResourceStateFault: {}
ReplicationInstancePublicIpAddressList:
type: array
items:
$ref: '#/components/schemas/String'
ModifyReplicationInstanceResponse:
type: object
example:
ReplicationInstance:
AllocatedStorage: 5
AutoMinorVersionUpgrade: true
EngineVersion: 1.5.0
KmsKeyId: arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd
PendingModifiedValues: {}
PreferredMaintenanceWindow: sun:06:00-sun:14:00
PubliclyAccessible: true
ReplicationInstanceArn: arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ
ReplicationInstanceClass: dms.t2.micro
ReplicationInstanceIdentifier: test-rep-1
ReplicationInstanceStatus: available
ReplicationSubnetGroup:
ReplicationSubnetGroupDescription: default
ReplicationSubnetGroupIdentifier: default
SubnetGroupStatus: Complete
Subnets:
- SubnetAvailabilityZone:
Name: us-east-1d
SubnetIdentifier: subnet-f6dd91af
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1b
SubnetIdentifier: subnet-3605751d
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1c
SubnetIdentifier: subnet-c2daefb5
SubnetStatus: Active
- SubnetAvailabilityZone:
Name: us-east-1e
SubnetIdentifier: subnet-85e90cb8
SubnetStatus: Active
VpcId: vpc-6741a603
properties:
ReplicationInstance:
allOf:
- $ref: '#/components/schemas/ReplicationInstance'
- description: The modified replication instance.
description:
VpcSecurityGroupMembership:
type: object
properties:
VpcSecurityGroupId:
allOf:
- $ref: '#/components/schemas/String'
- description: The VPC security group ID.
Status:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of the VPC security group.
description: Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
AccessDeniedFault: {}
VpcSecurityGroupIdList:
type: array
items:
$ref: '#/components/schemas/String'
IntegerOptional:
type: integer
String:
type: string
Boolean:
type: boolean
ModifyReplicationInstanceMessage:
type: object
required:
- ReplicationInstanceArn
title: ModifyReplicationInstanceMessage
properties:
ReplicationInstanceArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the replication instance.
AllocatedStorage:
allOf:
- $ref: '#/components/schemas/IntegerOptional'
- description: The amount of storage (in gigabytes) to be allocated for the replication instance.
ApplyImmediately:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the changes should be applied immediately or during the next maintenance window.
ReplicationInstanceClass:
allOf:
- $ref: '#/components/schemas/String'
- description: The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
VpcSecurityGroupIds: allOf: - $ref: '#/components/schemas/VpcSecurityGroupIdList' - description: ' 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. ' PreferredMaintenanceWindow: allOf: - $ref: '#/components/schemas/String' - description: '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
' MultiAZ: allOf: - $ref: '#/components/schemas/BooleanOptional' - description: ' Specifies whether the replication instance is a Multi-AZ deployment. You can''t set theAvailabilityZone parameter if the Multi-AZ parameter is set to true. '
EngineVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: The engine version number of the replication instance.
When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.
This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn''t result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
This parameter is set to true during the maintenance window.
A newer minor version is available.
DMS has enabled automatic patching for the given engine version.
When AutoMinorVersionUpgrade is enabled, DMS uses the current default engine version when you modify a replication instance. For example, if you set EngineVersion to a lower version number than the current default version, DMS uses the default version.
If AutoMinorVersionUpgrade isn’t enabled when you modify a replication instance, DMS uses the engine version specified by the EngineVersion parameter.
DescribeReplicationSubnetGroups operation.
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/dms/
x-hasEquivalentPaths: true