Class ParameterGroup

A parameter group.

Inheritance
object
Resource
ParameterGroup
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ParameterGroup : Resource, IParameterGroup, IResource, IDBParameterGroupRef, IDBClusterParameterGroupRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class ParameterGroup Inherits Resource Implements IParameterGroup, IResource, IDBParameterGroupRef, IDBClusterParameterGroupRef, IConstruct, IDependable, IEnvironmentAware
Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

Examples
Vpc vpc;


             var cluster = new ServerlessCluster(this, "AnotherCluster", new ServerlessClusterProps {
                 Engine = DatabaseClusterEngine.AURORA_POSTGRESQL,
                 CopyTagsToSnapshot = true,  // whether to save the cluster tags when creating the snapshot. Default is 'true'
                 ParameterGroup = ParameterGroup.FromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql11"),
                 Vpc = vpc,
                 Scaling = new ServerlessScalingOptions {
                     AutoPause = Duration.Minutes(10),  // default is to pause after 5 minutes of idle time
                     MinCapacity = AuroraCapacityUnit.ACU_8,  // default is 2 Aurora capacity units (ACUs)
                     MaxCapacity = AuroraCapacityUnit.ACU_32,  // default is 16 Aurora capacity units (ACUs)
                     Timeout = Duration.Seconds(100),  // default is 5 minutes
                     TimeoutAction = TimeoutAction.FORCE_APPLY_CAPACITY_CHANGE
                 }
             });

Synopsis

Constructors

ParameterGroup(Construct, string, IParameterGroupProps)

A parameter group.

Properties

DbClusterParameterGroupRef

A reference to this parameter group as a DB cluster parameter group.
DbParameterGroupRef

A reference to this parameter group as a DB parameter group.
PROPERTY_INJECTION_ID

Uniquely identifies this class.

Methods

AddParameter(string, string)

Add a parameter to this parameter group.
BindToCluster(IParameterGroupClusterBindOptions)

Method called when this Parameter Group is used when defining a database cluster.
BindToInstance(IParameterGroupInstanceBindOptions)

Method called when this Parameter Group is used when defining a database instance.
FromParameterGroupName(Construct, string, string)

Imports a parameter group.

Constructors

ParameterGroup(Construct, string, IParameterGroupProps)

A parameter group.

public ParameterGroup(Construct scope, string id, IParameterGroupProps props)
Parameters
scope Construct
id string
props IParameterGroupProps
Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

Examples
Vpc vpc;


             var cluster = new ServerlessCluster(this, "AnotherCluster", new ServerlessClusterProps {
                 Engine = DatabaseClusterEngine.AURORA_POSTGRESQL,
                 CopyTagsToSnapshot = true,  // whether to save the cluster tags when creating the snapshot. Default is 'true'
                 ParameterGroup = ParameterGroup.FromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql11"),
                 Vpc = vpc,
                 Scaling = new ServerlessScalingOptions {
                     AutoPause = Duration.Minutes(10),  // default is to pause after 5 minutes of idle time
                     MinCapacity = AuroraCapacityUnit.ACU_8,  // default is 2 Aurora capacity units (ACUs)
                     MaxCapacity = AuroraCapacityUnit.ACU_32,  // default is 16 Aurora capacity units (ACUs)
                     Timeout = Duration.Seconds(100),  // default is 5 minutes
                     TimeoutAction = TimeoutAction.FORCE_APPLY_CAPACITY_CHANGE
                 }
             });

Properties

DbClusterParameterGroupRef

A reference to this parameter group as a DB cluster parameter group.

public virtual IDBClusterParameterGroupReference DbClusterParameterGroupRef { get; }
Property Value

IDBClusterParameterGroupReference

Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

DbParameterGroupRef

A reference to this parameter group as a DB parameter group.

public virtual IDBParameterGroupReference DbParameterGroupRef { get; }
Property Value

IDBParameterGroupReference

Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

Methods

AddParameter(string, string)

Add a parameter to this parameter group.

public virtual bool AddParameter(string key, string value)
Parameters
key string

The key of the parameter to be added.

value string

The value of the parameter to be added.

Returns

bool

Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

BindToCluster(IParameterGroupClusterBindOptions)

Method called when this Parameter Group is used when defining a database cluster.

public virtual IParameterGroupClusterConfig BindToCluster(IParameterGroupClusterBindOptions options)
Parameters
options IParameterGroupClusterBindOptions
Returns

IParameterGroupClusterConfig

Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

BindToInstance(IParameterGroupInstanceBindOptions)

Method called when this Parameter Group is used when defining a database instance.

public virtual IParameterGroupInstanceConfig BindToInstance(IParameterGroupInstanceBindOptions options)
Parameters
options IParameterGroupInstanceBindOptions
Returns

IParameterGroupInstanceConfig

Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

FromParameterGroupName(Construct, string, string)

Imports a parameter group.

public static IParameterGroup FromParameterGroupName(Construct scope, string id, string parameterGroupName)
Parameters
scope Construct
id string
parameterGroupName string
Returns

IParameterGroup

Remarks

Represents both a cluster parameter group, and an instance parameter group.

Resource: AWS::RDS::DBParameterGroup

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable