ClusterParameterGroup

class aws_cdk.aws_docdb.ClusterParameterGroup(scope, id, *, family, parameters, db_cluster_parameter_group_name=None, description=None)

Bases: aws_cdk.core.Resource

A cluster parameter group.

stability :stability: experimental resource: :resource:: AWS::DocDB::DBClusterParameterGroup

__init__(scope, id, *, family, parameters, db_cluster_parameter_group_name=None, description=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • family (str) – Database family of this parameter group.

  • parameters (Mapping[str, str]) – The parameters in this parameter group.

  • db_cluster_parameter_group_name (Optional[str]) – The name of the cluster parameter group. Default: A CDK generated name for the cluster parameter group

  • description (Optional[str]) – Description for this parameter group. Default: a CDK generated description

stability :stability: experimental

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

parameter_group_name

The name of the parameter group.

stability :stability: experimental

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_parameter_group_name(scope, id, parameter_group_name)

Imports a parameter group.

Parameters
  • scope (Construct) –

  • id (str) –

  • parameter_group_name (str) –

stability :stability: experimental

Return type

IClusterParameterGroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool