software.amazon.awssdk.services.rds.model

Class CreateDbClusterParameterGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.CreateDbClusterParameterGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDbClusterParameterGroupRequest
extends RdsRequest
implements ToCopyableBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDbClusterParameterGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDbClusterParameterGroupRequest.Builder	builder()
String	dbClusterParameterGroupName() The name of the DB cluster parameter group.
String	dbParameterGroupFamily() The DB cluster parameter group family name.
String	description() The description for the DB cluster parameter group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDbClusterParameterGroupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Tags to assign to the DB cluster parameter group.
CreateDbClusterParameterGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dbClusterParameterGroupName

public final String dbClusterParameterGroupName()

The name of the DB cluster parameter group.

Constraints:

• Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

Returns:

The name of the DB cluster parameter group.

Constraints:

• Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

dbParameterGroupFamily

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

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql9.6

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres12

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 Aurora PostgreSQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

• aurora (for MySQL 5.6-compatible Aurora)

• aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

• aurora-postgresql

• mysql

• postgres

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.

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql9.6

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres12

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 Aurora PostgreSQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

• aurora (for MySQL 5.6-compatible Aurora)

• aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

• aurora-postgresql

• mysql

• postgres

description

public final String description()

The description for the DB cluster parameter group.

Returns:

The description for the DB cluster parameter group.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Tags to assign to the DB cluster parameter group.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Tags to assign to the DB cluster parameter group.

toBuilder

public CreateDbClusterParameterGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static CreateDbClusterParameterGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDbClusterParameterGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo