Class CfnDBParameterGroup

The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDBParameterGroup

Implements

IInspectable

IDBParameterGroupRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBParameterGroup : CfnResource, IInspectable, IDBParameterGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDBParameterGroup Inherits CfnResource Implements IInspectable, IDBParameterGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var parameters;

             var cfnDBParameterGroup = new CfnDBParameterGroup(this, "MyCfnDBParameterGroup", new CfnDBParameterGroupProps {
                 Description = "description",
                 Family = "family",

                 // the properties below are optional
                 DbParameterGroupName = "dbParameterGroupName",
                 Parameters = parameters,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDBParameterGroup(Construct, string, ICfnDBParameterGroupProps)

Create a new AWS::RDS::DBParameterGroup.

Properties

AttrDbParameterGroupName	The name of the DB parameter group.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.
DbParameterGroupName	The name of the DB parameter group.
DbParameterGroupRef	A reference to a DBParameterGroup resource.
Description	Provides the customer-specified description for this DB parameter group.
Family	The DB parameter group family name.
Parameters	A mapping of parameter names and values for the parameter update.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Tags to assign to the DB parameter group.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDBParameterGroup(object)	Checks whether the given object is a CfnDBParameterGroup.
RenderProperties(IDictionary<string, object>)	The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.

Constructors

CfnDBParameterGroup(Construct, string, ICfnDBParameterGroupProps)

Create a new AWS::RDS::DBParameterGroup.

public CfnDBParameterGroup(Construct scope, string id, ICfnDBParameterGroupProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDBParameterGroupProps

Resource properties.

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Properties

AttrDbParameterGroupName

The name of the DB parameter group.

public virtual string AttrDbParameterGroupName { get; }

Property Value

string

Remarks

CloudformationAttribute: DBParameterGroupName

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

DbParameterGroupName

The name of the DB parameter group.

public virtual string? DbParameterGroupName { get; set; }

Property Value

string

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

DbParameterGroupRef

A reference to a DBParameterGroup resource.

public virtual IDBParameterGroupReference DbParameterGroupRef { get; }

Property Value

IDBParameterGroupReference

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Description

Provides the customer-specified description for this DB parameter group.

public virtual string Description { get; set; }

Property Value

string

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Family

The DB parameter group family name.

public virtual string Family { get; set; }

Property Value

string

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Parameters

A mapping of parameter names and values for the parameter update.

public virtual object? Parameters { get; set; }

Property Value

object

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

TagsRaw

Tags to assign to the DB parameter group.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

IsCfnDBParameterGroup(object)

Checks whether the given object is a CfnDBParameterGroup.

public static bool IsCfnDBParameterGroup(object x)

Parameters

x object

Returns

bool

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with parameter groups in the Amazon RDS User Guide .

For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups in the Amazon Aurora User Guide .

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html

CloudformationResource: AWS::RDS::DBParameterGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDBParameterGroupRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable