com.amazonaws.services.rds.model
Class ResetDBParameterGroupRequest

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

All Implemented Interfaces:

Serializable

public class ResetDBParameterGroupRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ResetDBParameterGroup operation.

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod . To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

See Also:

AmazonRDS.resetDBParameterGroup(ResetDBParameterGroupRequest), Serialized Form

Constructor Summary

ResetDBParameterGroupRequest()
Default constructor for a new ResetDBParameterGroupRequest object.

ResetDBParameterGroupRequest(String dBParameterGroupName)
Constructs a new ResetDBParameterGroupRequest object.

Method Summary

boolean	equals(Object obj)
String	getDBParameterGroupName() The name of the DB parameter group.
List<Parameter>	getParameters() An array of parameter names, values, and the apply method for the parameter update.
Boolean	getResetAllParameters() Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
int	hashCode()
Boolean	isResetAllParameters() Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
void	setDBParameterGroupName(String dBParameterGroupName) The name of the DB parameter group.
void	setParameters(Collection<Parameter> parameters) An array of parameter names, values, and the apply method for the parameter update.
void	setResetAllParameters(Boolean resetAllParameters) Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ResetDBParameterGroupRequest	withDBParameterGroupName(String dBParameterGroupName) The name of the DB parameter group.
ResetDBParameterGroupRequest	withParameters(Collection<Parameter> parameters) An array of parameter names, values, and the apply method for the parameter update.
ResetDBParameterGroupRequest	withParameters(Parameter... parameters) An array of parameter names, values, and the apply method for the parameter update.
ResetDBParameterGroupRequest	withResetAllParameters(Boolean resetAllParameters) Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

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

ResetDBParameterGroupRequest

public ResetDBParameterGroupRequest()

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

ResetDBParameterGroupRequest

public ResetDBParameterGroupRequest(String dBParameterGroupName)

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

Parameters:

dBParameterGroupName - The name of the DB parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Method Detail

getDBParameterGroupName

public String getDBParameterGroupName()

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

setDBParameterGroupName

public void setDBParameterGroupName(String dBParameterGroupName)

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

dBParameterGroupName - The name of the DB parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

withDBParameterGroupName

public ResetDBParameterGroupRequest withDBParameterGroupName(String dBParameterGroupName)

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• 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:

dBParameterGroupName - The name of the DB parameter group.

Constraints:

• Must be 1 to 255 alphanumeric characters
• 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.

isResetAllParameters

public Boolean isResetAllParameters()

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

Returns:

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

setResetAllParameters

public void setResetAllParameters(Boolean resetAllParameters)

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

Parameters:

resetAllParameters - Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

withResetAllParameters

public ResetDBParameterGroupRequest withResetAllParameters(Boolean resetAllParameters)

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

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

Parameters:

resetAllParameters - Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

Returns:

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

getResetAllParameters

public Boolean getResetAllParameters()

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

Returns:

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

getParameters

public List<Parameter> getParameters()

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

Returns:

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

setParameters

public void setParameters(Collection<Parameter> parameters)

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

Parameters:

parameters - An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

withParameters

public ResetDBParameterGroupRequest withParameters(Parameter... parameters)

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

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

Parameters:

parameters - An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

Returns:

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

withParameters

public ResetDBParameterGroupRequest withParameters(Collection<Parameter> parameters)

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

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

Parameters:

parameters - An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

Returns:

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

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