@aws-cdk_aws-neptune-alpha.ClusterParameterGroup

class ClusterParameterGroup (construct) ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Neptune.Alpha.ClusterParameterGroup
Gogithub.com/aws/aws-cdk-go/awscdkneptunealpha/v2#ClusterParameterGroup
Javasoftware.amazon.awscdk.services.neptune.alpha.ClusterParameterGroup
Pythonaws_cdk.aws_neptune_alpha.ClusterParameterGroup
TypeScript (source)@aws-cdk/aws-neptune-alpha ยป ClusterParameterGroup

Implements IConstruct, IDependable, IResource, IClusterParameterGroup

A cluster parameter group.

Example

const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {
  description: 'Cluster parameter group',
  parameters: {
    neptune_enable_audit_log: '1'
  },
});

const dbParams = new neptune.ParameterGroup(this, 'DbParams', {
  description: 'Db parameter group',
  parameters: {
    neptune_query_timeout: '120000',
  },
});

const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  clusterParameterGroup: clusterParams,
  parameterGroup: dbParams,
});

Initializer

new ClusterParameterGroup(scope: Construct, id: string, props: ClusterParameterGroupProps)

Parameters

  • scope Construct
  • id string
  • props ClusterParameterGroupProps

Construct Props

NameTypeDescription
parameters๐Ÿ”น{ [string]: string }The parameters in this parameter group.
clusterParameterGroupName?๐Ÿ”นstringThe name of the parameter group.
description?๐Ÿ”นstringDescription for this parameter group.
family?๐Ÿ”นParameterGroupFamilyParameter group family.

parameters๐Ÿ”น

Type: { [string]: string }

The parameters in this parameter group.


clusterParameterGroupName?๐Ÿ”น

Type: string (optional, default: A CDK generated name for the parameter group)

The name of the parameter group.


description?๐Ÿ”น

Type: string (optional, default: a CDK generated description)

Description for this parameter group.


family?๐Ÿ”น

Type: ParameterGroupFamily (optional, default: NEPTUNE_1)

Parameter group family.

Properties

NameTypeDescription
clusterParameterGroupName๐Ÿ”นstringThe name of the parameter group.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

clusterParameterGroupName๐Ÿ”น

Type: string

The name of the parameter group.


env๐Ÿ”น

Type: ResourceEnvironment

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๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromClusterParameterGroupName(scope, id, clusterParameterGroupName)๐Ÿ”นImports a parameter group.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromClusterParameterGroupName(scope, id, clusterParameterGroupName)๐Ÿ”น

public static fromClusterParameterGroupName(scope: Construct, id: string, clusterParameterGroupName: string): IClusterParameterGroup

Parameters

  • scope Construct
  • id string
  • clusterParameterGroupName string

Returns

  • IClusterParameterGroup

Imports a parameter group.