com.amazonaws.services.rds.model

Class ModifyDBParameterGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.ModifyDBParameterGroupRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ModifyDBParameterGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

IMPORTANT: After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

See Also:

AmazonRDS.modifyDBParameterGroup(ModifyDBParameterGroupRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

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
ModifyDBParameterGroupRequest	clone() Creates a shallow clone of this request.
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

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, 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 can 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 you reboot the DB instance without failover.

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 can 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 you reboot the DB instance without failover.

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 can 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 you reboot the DB instance without failover.

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 can 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 you reboot the DB instance without failover.

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 can 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 you reboot the DB instance without failover.

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 can 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 you reboot the DB instance without failover.

NOTE: This method appends the values to the existing list (if any). Use setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to override the existing values.

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 can 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 you reboot the DB instance without failover.

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 can 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 you reboot the DB instance without failover.

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 can 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 you reboot the DB instance without failover.

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

clone

public ModifyDBParameterGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()