Class CfnDBParameterGroup
The AWS::RDS::DBParameterGroup
resource creates a custom parameter group for an RDS database family.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBParameterGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDBParameterGroup
Inherits CfnResource
Implements IInspectable, 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBParameterGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDBParameterGroup(Construct, String, ICfnDBParameterGroupProps) |
Properties
AttrDbParameterGroupName | The name of the DB parameter group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DbParameterGroupName | The name of the DB parameter group. |
Description | Provides the customer-specified description for this DB parameter group. |
Family | The DB parameter group family name. |
Parameters | An array 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. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBParameterGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBParameterGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBParameterGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBParameterGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDBParameterGroup(Construct, String, ICfnDBParameterGroupProps)
public CfnDBParameterGroup(Construct scope, string id, ICfnDBParameterGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDBParameterGroupProps
Resource properties.
Properties
AttrDbParameterGroupName
The name of the DB parameter group.
public virtual string AttrDbParameterGroupName { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DbParameterGroupName
The name of the DB parameter group.
public virtual string DbParameterGroupName { get; set; }
Property Value
System.String
Description
Provides the customer-specified description for this DB parameter group.
public virtual string Description { get; set; }
Property Value
System.String
Family
The DB parameter group family name.
public virtual string Family { get; set; }
Property Value
System.String
Parameters
An array of parameter names and values for the parameter update.
public virtual object Parameters { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Tags to assign to the DB parameter group.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>