Package software.amazon.awscdk.services.docdb

Interface CfnDBClusterParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBClusterParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:05.430Z")
@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.docdb.*;
 Object parameters;
 CfnDBClusterParameterGroupProps cfnDBClusterParameterGroupProps = CfnDBClusterParameterGroupProps.builder()
         .description("description")
         .family("family")
         .parameters(parameters)
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html

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()
String	getDescription()	The description for the cluster parameter group.
String	getFamily()	The cluster parameter group family name.
default String	getName()	The name of the DB cluster parameter group.
Object	getParameters()	Provides a list of parameters for the cluster parameter group.
default List<CfnTag>	getTags()	The tags to be assigned to the cluster parameter group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description for the cluster parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-description

getFamily

@Stability(Stable)
@NotNull
String getFamily()

The cluster parameter group family name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-family

getParameters

@Stability(Stable)
@NotNull
Object getParameters()

Provides a list of parameters for the cluster parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-parameters

getName

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

The name of the DB cluster parameter group.

Constraints:

• Must not match the name of an existing DBClusterParameterGroup .

This value is stored as a lowercase string.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-name

getTags

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

The tags to be assigned to the cluster parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-tags

builder

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

Returns:

a CfnDBClusterParameterGroupProps.Builder of CfnDBClusterParameterGroupProps