class ParameterGroup (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Neptune.Alpha.ParameterGroup |
![]() | github.com/aws/aws-cdk-go/awscdkneptunealpha/v2#ParameterGroup |
![]() | software.amazon.awscdk.services.neptune.alpha.ParameterGroup |
![]() | aws_cdk.aws_neptune_alpha.ParameterGroup |
![]() | @aws-cdk/aws-neptune-alpha ยป ParameterGroup |
Implements
IConstruct
, IDependable
, IResource
, IParameter
DB 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 ParameterGroup(scope: Construct, id: string, props: ParameterGroupProps)
Parameters
- scope
Construct
- id
string
- props
Parameter
Group Props
Construct Props
Name | Type | Description |
---|---|---|
parameters | { [string]: string } | The parameters in this parameter group. |
description? | string | Description for this parameter group. |
family? | Parameter | Parameter group family. |
parameter | string | The name of the parameter group. |
parameters
Type:
{ [string]: string }
The parameters in this parameter group.
description?
Type:
string
(optional, default: a CDK generated description)
Description for this parameter group.
family?
Type:
Parameter
(optional, default: NEPTUNE_1)
Parameter group family.
parameterGroupName?
Type:
string
(optional, default: A CDK generated name for the parameter group)
The name of the parameter group.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
parameter | string | The name of the parameter group. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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.
parameterGroupName
Type:
string
The name of the parameter group.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Imports a parameter group. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromParameterGroupName(scope, id, parameterGroupName)
public static fromParameterGroupName(scope: Construct, id: string, parameterGroupName: string): IParameterGroup
Parameters
- scope
Construct
- id
string
- parameterGroupName
string
Returns
Imports a parameter group.