com.amazonaws.services.rds.model

Class ResetDBClusterParameterGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.ResetDBClusterParameterGroupRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ResetDBClusterParameterGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ResetDBClusterParameterGroup operation.

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod . To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName 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. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

See Also:

AmazonRDS.resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ResetDBClusterParameterGroupRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ResetDBClusterParameterGroupRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBClusterParameterGroupName() The name of the DB cluster parameter group to reset.
List<Parameter>	getParameters() A list of parameter names in the DB cluster parameter group to reset to the default values.
Boolean	getResetAllParameters() A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise.
int	hashCode()
Boolean	isResetAllParameters() A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise.
void	setDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of the DB cluster parameter group to reset.
void	setParameters(Collection<Parameter> parameters) A list of parameter names in the DB cluster parameter group to reset to the default values.
void	setResetAllParameters(Boolean resetAllParameters) A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ResetDBClusterParameterGroupRequest	withDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of the DB cluster parameter group to reset.
ResetDBClusterParameterGroupRequest	withParameters(Collection<Parameter> parameters) A list of parameter names in the DB cluster parameter group to reset to the default values.
ResetDBClusterParameterGroupRequest	withParameters(Parameter... parameters) A list of parameter names in the DB cluster parameter group to reset to the default values.
ResetDBClusterParameterGroupRequest	withResetAllParameters(Boolean resetAllParameters) A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ResetDBClusterParameterGroupRequest

public ResetDBClusterParameterGroupRequest()

Method Detail

getDBClusterParameterGroupName

public String getDBClusterParameterGroupName()

The name of the DB cluster parameter group to reset.

Returns:

The name of the DB cluster parameter group to reset.

setDBClusterParameterGroupName

public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of the DB cluster parameter group to reset.

Parameters:

dBClusterParameterGroupName - The name of the DB cluster parameter group to reset.

withDBClusterParameterGroupName

public ResetDBClusterParameterGroupRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of the DB cluster parameter group to reset.

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

Parameters:

dBClusterParameterGroupName - The name of the DB cluster parameter group to reset.

Returns:

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

isResetAllParameters

public Boolean isResetAllParameters()

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

Returns:

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

setResetAllParameters

public void setResetAllParameters(Boolean resetAllParameters)

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

Parameters:

resetAllParameters - A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

withResetAllParameters

public ResetDBClusterParameterGroupRequest withResetAllParameters(Boolean resetAllParameters)

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

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

Parameters:

resetAllParameters - A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

Returns:

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

getResetAllParameters

public Boolean getResetAllParameters()

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

Returns:

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

getParameters

public List<Parameter> getParameters()

A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

Returns:

A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

setParameters

public void setParameters(Collection<Parameter> parameters)

A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

Parameters:

parameters - A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

withParameters

public ResetDBClusterParameterGroupRequest withParameters(Parameter... parameters)

A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

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 - A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

Returns:

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

withParameters

public ResetDBClusterParameterGroupRequest withParameters(Collection<Parameter> parameters)

A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

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

Parameters:

parameters - A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

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 ResetDBClusterParameterGroupRequest 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()