com.amazonaws.services.rds.model
Class RebootDBInstanceRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.rds.model.RebootDBInstanceRequest

All Implemented Interfaces:

Serializable

public class RebootDBInstanceRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the RebootDBInstance operation.

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

See Also:

AmazonRDS.rebootDBInstance(RebootDBInstanceRequest), Serialized Form

Constructor Summary

RebootDBInstanceRequest()
Default constructor for a new RebootDBInstanceRequest object.

RebootDBInstanceRequest(String dBInstanceIdentifier)
Constructs a new RebootDBInstanceRequest object.

Method Summary

boolean	equals(Object obj)
String	getDBInstanceIdentifier() The DB instance identifier.
Boolean	getForceFailover() When true, the reboot will be conducted through a MultiAZ failover.
int	hashCode()
Boolean	isForceFailover() When true, the reboot will be conducted through a MultiAZ failover.
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The DB instance identifier.
void	setForceFailover(Boolean forceFailover) When true, the reboot will be conducted through a MultiAZ failover.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RebootDBInstanceRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The DB instance identifier.
RebootDBInstanceRequest	withForceFailover(Boolean forceFailover) When true, the reboot will be conducted through a MultiAZ failover.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RebootDBInstanceRequest

public RebootDBInstanceRequest()

Default constructor for a new RebootDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

RebootDBInstanceRequest

public RebootDBInstanceRequest(String dBInstanceIdentifier)

Constructs a new RebootDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

dBInstanceIdentifier - The DB 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

Method Detail

getDBInstanceIdentifier

public String getDBInstanceIdentifier()

The DB 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

Returns:

The DB 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

setDBInstanceIdentifier

public void setDBInstanceIdentifier(String dBInstanceIdentifier)

The DB 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

Parameters:

dBInstanceIdentifier - The DB 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

withDBInstanceIdentifier

public RebootDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)

The DB 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

Returns a reference to this object so that method calls can be chained together.

Parameters:

dBInstanceIdentifier - The DB 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

Returns:

A reference to this updated object so that method calls can be chained together.

isForceFailover

public Boolean isForceFailover()

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Returns:

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

setForceFailover

public void setForceFailover(Boolean forceFailover)

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Parameters:

forceFailover - When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

withForceFailover

public RebootDBInstanceRequest withForceFailover(Boolean forceFailover)

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Returns a reference to this object so that method calls can be chained together.

Parameters:

forceFailover - When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Returns:

A reference to this updated object so that method calls can be chained together.

getForceFailover

public Boolean getForceFailover()

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Returns:

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object