com.amazonaws.services.rds.model

Class ModifyDBParameterGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.ModifyDBParameterGroupRequest

All Implemented Interfaces:

Serializable

public class ModifyDBParameterGroupRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ModifyDBParameterGroup operation.

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and ApplyMethod . A maximum of 20 parameters can be modified in a single request.

NOTE: The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB instances for either dynamic or static parameters. For Microsoft SQL Server DB instances, the pending-reboot method can be used only for static parameters.

See Also:

AmazonRDS.modifyDBParameterGroup(ModifyDBParameterGroupRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModifyDBParameterGroupRequest() Default constructor for a new ModifyDBParameterGroupRequest object.
ModifyDBParameterGroupRequest(String dBParameterGroupName, List<Parameter> parameters) Constructs a new ModifyDBParameterGroupRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
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.
int	hashCode()
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyDBParameterGroupRequest	withDBParameterGroupName(String dBParameterGroupName) The name of the DB parameter group.
ModifyDBParameterGroupRequest	withParameters(Collection<Parameter> parameters) An array of parameter names, values, and the apply method for the parameter update.
ModifyDBParameterGroupRequest	withParameters(Parameter... parameters) An array of parameter names, values, and the apply method for the parameter update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyDBParameterGroupRequest

public ModifyDBParameterGroupRequest()

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

ModifyDBParameterGroupRequest

public ModifyDBParameterGroupRequest(String dBParameterGroupName,
                             List<Parameter> parameters)

Constructs a new ModifyDBParameterGroupRequest 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 the name of an existing DB parameter group
• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

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.

Valid Values (for the application 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.

Method Detail

getDBParameterGroupName

public String getDBParameterGroupName()

The name of the DB parameter group.

Constraints:

• Must be the name of an existing DB parameter group
• 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 the name of an existing DB parameter group
• 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 the name of an existing DB parameter group
• 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 the name of an existing DB parameter group
• 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 ModifyDBParameterGroupRequest withDBParameterGroupName(String dBParameterGroupName)

The name of the DB parameter group.

Constraints:

• Must be the name of an existing DB parameter group
• 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 the name of an existing DB parameter group
• 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.

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.

Valid Values (for the application 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.

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.

Valid Values (for the application 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.

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.

Valid Values (for the application 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.

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.

Valid Values (for the application 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.

withParameters

public ModifyDBParameterGroupRequest 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.

Valid Values (for the application 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.

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.

Valid Values (for the application 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.

Returns:

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

withParameters

public ModifyDBParameterGroupRequest 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.

Valid Values (for the application 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.

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.

Valid Values (for the application 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.

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