com.amazonaws.services.rds.model

Class CreateDBParameterGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.CreateDBParameterGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDBParameterGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDBParameterGroupRequest() Default constructor for CreateDBParameterGroupRequest object.
CreateDBParameterGroupRequest(String dBParameterGroupName, String dBParameterGroupFamily, String description) Constructs a new CreateDBParameterGroupRequest object.

Method Summary

Modifier and Type	Method and Description
CreateDBParameterGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDBParameterGroupFamily() The DB parameter group family name.
String	getDBParameterGroupName() The name of the DB parameter group.
String	getDescription() The description for the DB parameter group.
List<Tag>	getTags() Tags to assign to the DB parameter group.
int	hashCode()
void	setDBParameterGroupFamily(String dBParameterGroupFamily) The DB parameter group family name.
void	setDBParameterGroupName(String dBParameterGroupName) The name of the DB parameter group.
void	setDescription(String description) The description for the DB parameter group.
void	setTags(Collection<Tag> tags) Tags to assign to the DB parameter group.
String	toString() Returns a string representation of this object.
CreateDBParameterGroupRequest	withDBParameterGroupFamily(String dBParameterGroupFamily) The DB parameter group family name.
CreateDBParameterGroupRequest	withDBParameterGroupName(String dBParameterGroupName) The name of the DB parameter group.
CreateDBParameterGroupRequest	withDescription(String description) The description for the DB parameter group.
CreateDBParameterGroupRequest	withTags(Collection<Tag> tags) Tags to assign to the DB parameter group.
CreateDBParameterGroupRequest	withTags(Tag... tags) Tags to assign to the DB parameter group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDBParameterGroupRequest

public CreateDBParameterGroupRequest()

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

CreateDBParameterGroupRequest

public CreateDBParameterGroupRequest(String dBParameterGroupName,
                                     String dBParameterGroupFamily,
                                     String description)

Constructs a new CreateDBParameterGroupRequest 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 letters, numbers, or hyphens.

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• db2-ae

• db2-se

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

description - The description for the DB parameter group.

Method Detail

setDBParameterGroupName

public void setDBParameterGroupName(String dBParameterGroupName)

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

Parameters:

dBParameterGroupName - The name of the DB parameter group.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

getDBParameterGroupName

public String getDBParameterGroupName()

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

Returns:

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

withDBParameterGroupName

public CreateDBParameterGroupRequest withDBParameterGroupName(String dBParameterGroupName)

The name of the DB parameter group.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

Parameters:

dBParameterGroupName - The name of the DB parameter group.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

Returns:

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

setDBParameterGroupFamily

public void setDBParameterGroupFamily(String dBParameterGroupFamily)

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• db2-ae

• db2-se

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Parameters:

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• db2-ae

• db2-se

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

getDBParameterGroupFamily

public String getDBParameterGroupFamily()

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• db2-ae

• db2-se

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Returns:

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• db2-ae

• db2-se

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

withDBParameterGroupFamily

public CreateDBParameterGroupRequest withDBParameterGroupFamily(String dBParameterGroupFamily)

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• db2-ae

• db2-se

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Parameters:

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

The output contains duplicates.

The following are the valid DB engine values:

• aurora-mysql

• aurora-postgresql

• db2-ae

• db2-se

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Returns:

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

setDescription

public void setDescription(String description)

The description for the DB parameter group.

Parameters:

description - The description for the DB parameter group.

getDescription

public String getDescription()

The description for the DB parameter group.

Returns:

The description for the DB parameter group.

withDescription

public CreateDBParameterGroupRequest withDescription(String description)

The description for the DB parameter group.

Parameters:

description - The description for the DB parameter group.

Returns:

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

getTags

public List<Tag> getTags()

Tags to assign to the DB parameter group.

Returns:

Tags to assign to the DB parameter group.

setTags

public void setTags(Collection<Tag> tags)

Tags to assign to the DB parameter group.

Parameters:

tags - Tags to assign to the DB parameter group.

withTags

public CreateDBParameterGroupRequest withTags(Tag... tags)

Tags to assign to the DB parameter group.

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.

Parameters:

tags - Tags to assign to the DB parameter group.

Returns:

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

withTags

public CreateDBParameterGroupRequest withTags(Collection<Tag> tags)

Tags to assign to the DB parameter group.

Parameters:

tags - Tags to assign to the DB parameter group.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDBParameterGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()