DeleteReplicationInstance
Deletes the specified replication instance.
Note
You must delete any migration tasks that are associated with the replication instance before you can delete it.
Request Syntax
{
"ReplicationInstanceArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ReplicationInstanceArn
-
The Amazon Resource Name (ARN) of the replication instance to be deleted.
Type: String
Required: Yes
Response Syntax
{
"ReplicationInstance": {
"AllocatedStorage": number,
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZone": "string",
"DnsNameServers": "string",
"EngineVersion": "string",
"FreeUntil": number,
"InstanceCreateTime": number,
"KerberosAuthenticationSettings": {
"KeyCacheSecretIamArn": "string",
"KeyCacheSecretId": "string",
"Krb5FileContents": "string"
},
"KmsKeyId": "string",
"MultiAZ": boolean,
"NetworkType": "string",
"PendingModifiedValues": {
"AllocatedStorage": number,
"EngineVersion": "string",
"MultiAZ": boolean,
"NetworkType": "string",
"ReplicationInstanceClass": "string"
},
"PreferredMaintenanceWindow": "string",
"PubliclyAccessible": boolean,
"ReplicationInstanceArn": "string",
"ReplicationInstanceClass": "string",
"ReplicationInstanceIdentifier": "string",
"ReplicationInstanceIpv6Addresses": [ "string" ],
"ReplicationInstancePrivateIpAddress": "string",
"ReplicationInstancePrivateIpAddresses": [ "string" ],
"ReplicationInstancePublicIpAddress": "string",
"ReplicationInstancePublicIpAddresses": [ "string" ],
"ReplicationInstanceStatus": "string",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupDescription": "string",
"ReplicationSubnetGroupIdentifier": "string",
"SubnetGroupStatus": "string",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "string"
},
"SubnetIdentifier": "string",
"SubnetStatus": "string"
}
],
"SupportedNetworkTypes": [ "string" ],
"VpcId": "string"
},
"SecondaryAvailabilityZone": "string",
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
]
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ReplicationInstance
-
The replication instance that was deleted.
Type: ReplicationInstance object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
- message
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
- message
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteReplicationInstance.
Sample Request
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.DeleteReplicationInstance
{
"ReplicationInstanceArn": "arn:aws:dms:us-east-
1:123456789012:rep:PWEBBEUNOLU7VEB2OHTEH4I4GQ"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"ReplicationInstance":{
"AvailabilityZone":"us-east-1c",
"ReplicationInstancePrivateIpAddress":"172.31.15.23",
"ReplicationInstanceArn":"arn:aws:dms:us-east-
1:123456789012:rep:PWEBBEUNOLU7VEB2OHTEH4I4GQ",
"ReplicationInstanceClass":"dms.t2.small",
"ReplicationSubnetGroup":{
"ReplicationSubnetGroupDescription":"default",
"Subnets":[
{
"SubnetStatus":"Active",
"SubnetIdentifier":"subnet-f6dd91af",
"SubnetAvailabilityZone":{
"Name":"us-east-1d"
}
},
{
"SubnetStatus":"Active",
"SubnetIdentifier":"subnet-3605751d",
"SubnetAvailabilityZone":{
"Name":"us-east-1b"
}
},
{
"SubnetStatus":"Active",
"SubnetIdentifier":"subnet-c2daefb5",
"SubnetAvailabilityZone":{
"Name":"us-east-1c"
}
},
{
"SubnetStatus":"Active",
"SubnetIdentifier":"subnet-85e90cb8",
"SubnetAvailabilityZone":{
"Name":"us-east-1e"
}
}
],
"VpcId":"vpc-6741a603",
"SubnetGroupStatus":"Complete",
"ReplicationSubnetGroupIdentifier":"default"
},
"AutoMinorVersionUpgrade":true,
"ReplicationInstanceStatus":"deleting",
"KmsKeyId":"arn:aws:kms:us-east-1:123456789012:key/4dc17316-5543-
4ded-b1e3-d53a7cfb411d",
"InstanceCreateTime":1457645140.38,
"ReplicationInstancePublicIpAddress":"52.87.94.254",
"AllocatedStorage":5,
"EngineVersion":"1.5.0",
"ReplicationInstanceIdentifier":"test-rep-1",
"PubliclyAccessible":true,
"PreferredMaintenanceWindow":"sun:06:00-sun:14:00",
"PendingModifiedValues":{
}
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
