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("software.amazon.awssdk:codegen") public final class CreateDbClusterParameterGroupRequest extends RdsRequest implements ToCopyableBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDbClusterParameterGroupRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateDbClusterParameterGroupRequest.Builderbuilder()StringdbClusterParameterGroupName()The name of the DB cluster parameter group.StringdbParameterGroupFamily()The DB cluster parameter group family name.Stringdescription()The description for the DB cluster parameter group.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateDbClusterParameterGroupRequest.Builder>serializableBuilderClass()List<Tag>tags()Tags to assign to the DB cluster parameter group.CreateDbClusterParameterGroupRequest.BuildertoBuilder()StringtoString()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:
aurora-mysql5.7,aurora-mysql8.0Aurora PostgreSQL
Example:
aurora-postgresql14RDS for MySQL
Example:
mysql8.0RDS for PostgreSQL
Example:
postgres13To 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-postgresqlThe output contains duplicates.
The following are the valid DB engine values:
-
aurora-mysql -
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:
aurora-mysql5.7,aurora-mysql8.0Aurora PostgreSQL
Example:
aurora-postgresql14RDS for MySQL
Example:
mysql8.0RDS for PostgreSQL
Example:
postgres13To 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-postgresqlThe output contains duplicates.
The following are the valid DB engine values:
-
aurora-mysql -
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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<CreateDbClusterParameterGroupRequest.Builder,CreateDbClusterParameterGroupRequest>- Specified by:
toBuilderin classRdsRequest
-
builder
public static CreateDbClusterParameterGroupRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDbClusterParameterGroupRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-