com.amazonaws.services.rds.model

Class CreateDBClusterParameterGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.CreateDBClusterParameterGroupRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateDBClusterParameterGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateDBClusterParameterGroup operation.

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

IMPORTANT: After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

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

See Also:

AmazonRDS.createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDBClusterParameterGroupRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateDBClusterParameterGroupRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBClusterParameterGroupName() The name of the DB cluster parameter group.
String	getDBParameterGroupFamily() The DB cluster parameter group family name.
String	getDescription() The description for the DB cluster parameter group.
List<Tag>	getTags() A list of tags.
int	hashCode()
void	setDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of the DB cluster parameter group.
void	setDBParameterGroupFamily(String dBParameterGroupFamily) The DB cluster parameter group family name.
void	setDescription(String description) The description for the DB cluster parameter group.
void	setTags(Collection<Tag> tags) A list of tags.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDBClusterParameterGroupRequest	withDBClusterParameterGroupName(String dBClusterParameterGroupName) The name of the DB cluster parameter group.
CreateDBClusterParameterGroupRequest	withDBParameterGroupFamily(String dBParameterGroupFamily) The DB cluster parameter group family name.
CreateDBClusterParameterGroupRequest	withDescription(String description) The description for the DB cluster parameter group.
CreateDBClusterParameterGroupRequest	withTags(Collection<Tag> tags) A list of tags.
CreateDBClusterParameterGroupRequest	withTags(Tag... tags) A list of tags.

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

CreateDBClusterParameterGroupRequest

public CreateDBClusterParameterGroupRequest()

Method Detail

getDBClusterParameterGroupName

public String getDBClusterParameterGroupName()

The name of the DB cluster 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

This value is stored as a lowercase string.

Returns:

The name of the DB cluster 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

This value is stored as a lowercase string.

setDBClusterParameterGroupName

public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of the DB cluster 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

This value is stored as a lowercase string.

Parameters:

dBClusterParameterGroupName - The name of the DB cluster 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

This value is stored as a lowercase string.

withDBClusterParameterGroupName

public CreateDBClusterParameterGroupRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)

The name of the DB cluster 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

This value is stored as a lowercase string.

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

Parameters:

dBClusterParameterGroupName - The name of the DB cluster 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

This value is stored as a lowercase string.

Returns:

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

getDBParameterGroupFamily

public String getDBParameterGroupFamily()

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Returns:

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

setDBParameterGroupFamily

public void setDBParameterGroupFamily(String dBParameterGroupFamily)

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Parameters:

dBParameterGroupFamily - The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

withDBParameterGroupFamily

public CreateDBClusterParameterGroupRequest withDBParameterGroupFamily(String dBParameterGroupFamily)

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

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

Parameters:

dBParameterGroupFamily - The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

Returns:

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

getDescription

public String getDescription()

The description for the DB cluster parameter group.

Returns:

The description for the DB cluster parameter group.

setDescription

public void setDescription(String description)

The description for the DB cluster parameter group.

Parameters:

description - The description for the DB cluster parameter group.

withDescription

public CreateDBClusterParameterGroupRequest withDescription(String description)

The description for the DB cluster parameter group.

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

Parameters:

description - The description for the DB cluster parameter group.

Returns:

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

getTags

public List<Tag> getTags()

A list of tags.

Returns:

A list of tags.

setTags

public void setTags(Collection<Tag> tags)

A list of tags.

Parameters:

tags - A list of tags.

withTags

public CreateDBClusterParameterGroupRequest withTags(Tag... tags)

A list of tags.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(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:

tags - A list of tags.

Returns:

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

withTags

public CreateDBClusterParameterGroupRequest withTags(Collection<Tag> tags)

A list of tags.

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

Parameters:

tags - A list of tags.

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