ParameterGroup

class aws_cdk.aws_neptune.ParameterGroup(scope, id, *, parameters, description=None, parameter_group_name=None)

Bases: Resource

(experimental) DB parameter group.

Stability:: experimental
Resource:: AWS::Neptune::DBParameterGroup
ExampleMetadata:: infused

Example:

cluster_params = neptune.ClusterParameterGroup(self, "ClusterParams",
    description="Cluster parameter group",
    parameters={
        "neptune_enable_audit_log": "1"
    }
)

db_params = neptune.ParameterGroup(self, "DbParams",
    description="Db parameter group",
    parameters={
        "neptune_query_timeout": "120000"
    }
)

cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    cluster_parameter_group=cluster_params,
    parameter_group=db_params
)

Parameters:

scope (Construct) –
id (str) –
parameters (Mapping[str, str]) – (experimental) The parameters in this parameter group.
description (Optional[str]) – (experimental) Description for this parameter group. Default: a CDK generated description
parameter_group_name (Optional[str]) – (experimental) The name of the parameter group. Default: A CDK generated name for the parameter group

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

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.

node: The construct tree node associated with this construct.

parameter_group_name

(experimental) The name of the parameter group.

Stability:: experimental

stack: The stack in which this resource is defined.

Static Methods

classmethod from_parameter_group_name(scope, id, parameter_group_name)

(experimental) Imports a parameter group.

Parameters:

scope (Construct) –
id (str) –
parameter_group_name (str) –

Stability:

experimental

Return type:

IParameterGroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool