RebootReplicationInstance
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
Request Syntax
{
"ForceFailover": boolean
,
"ForcePlannedFailover": boolean
,
"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.
- 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 specifytrue
. (--force-planned-failover
and--force-failover
can't both be set totrue
.)Type: Boolean
Required: No
- ForcePlannedFailover
-
If this parameter is
true
, the reboot is conducted through a planned Multi-AZ failover where resources are released and cleaned up prior to conducting the failover. If the instance isn''t configured for Multi-AZ, then you can't specifytrue
. (--force-planned-failover
and--force-failover
can't both be set totrue
.)Type: Boolean
Required: No
- ReplicationInstanceArn
-
The Amazon Resource Name (ARN) of the replication instance.
Type: String
Required: Yes
Response Syntax
{
"ReplicationInstance": {
"AllocatedStorage": number,
"AutoMinorVersionUpgrade": boolean,
"AvailabilityZone": "string",
"DnsNameServers": "string",
"EngineVersion": "string",
"FreeUntil": number,
"InstanceCreateTime": number,
"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 is being rebooted.
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.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: