Package software.amazon.awscdk.services.rds

Interface CfnDBClusterParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBClusterParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.931Z")
@Stability(Stable)
public interface CfnDBClusterParameterGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBClusterParameterGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 Object parameters;
 CfnDBClusterParameterGroupProps cfnDBClusterParameterGroupProps = CfnDBClusterParameterGroupProps.builder()
         .description("description")
         .family("family")
         .parameters(parameters)
         // the properties below are optional
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBClusterParameterGroupProps.Builder	A builder for CfnDBClusterParameterGroupProps
static final class	CfnDBClusterParameterGroupProps.Jsii$Proxy	An implementation for CfnDBClusterParameterGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnDBClusterParameterGroupProps.Builder	builder()
default String	getDbClusterParameterGroupName()	The name of the DB cluster parameter group.
String	getDescription()	A friendly description for this DB cluster parameter group.
String	getFamily()	The DB cluster parameter group family name.
Object	getParameters()	Provides a list of parameters for the DB cluster parameter group.
default List<CfnTag>	getTags()	An optional array of key-value pairs to apply to this DB cluster parameter group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

A friendly description for this DB cluster parameter group.

getFamily

@Stability(Stable)
@NotNull
String getFamily()

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 DB engine and engine version compatible with that DB cluster parameter group family.

The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.

To list all of the available parameter group families, use the following command:

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

The output contains duplicates.

For more information, see [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) .

getParameters

@Stability(Stable)
@NotNull
Object getParameters()

Provides a list of parameters for the DB cluster parameter group.

getDbClusterParameterGroupName

@Stability(Stable)
@Nullable
default String getDbClusterParameterGroupName()

The name of the DB cluster parameter group.

Constraints:

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

If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group.

This value is stored as a lowercase string.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An optional array of key-value pairs to apply to this DB cluster parameter group.

builder

@Stability(Stable)
static CfnDBClusterParameterGroupProps.Builder builder()

Returns:

a CfnDBClusterParameterGroupProps.Builder of CfnDBClusterParameterGroupProps