Class CfnDBParameterGroup
A CloudFormation AWS::RDS::DBParameterGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CfnDBParameterGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDBParameterGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::RDS::DBParameterGroup
resource creates a custom parameter group for an RDS database family.
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.
CloudformationResource: AWS::RDS::DBParameterGroup
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html
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 |
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 |
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 | An optional array of key-value pairs to apply to this DB parameter group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnDBParameterGroupProps
- resource properties.
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
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
Remarks
Constraints:
If you don't specify a value for DBParameterGroupName
property, a name is automatically created for the DB parameter group.
This value is stored as a lowercase string.
Description
Provides the customer-specified description for this DB parameter group.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Family
The DB parameter group family name.
public virtual string Family { get; set; }
Property Value
System.String
Remarks
A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.
The DB parameter group family can't be changed when updating a DB parameter group.
To list all of the available parameter group families, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
The output contains duplicates.
For more information, see CreateDBParameterGroup
.
Parameters
An array of parameter names and values for the parameter update.
public virtual object Parameters { get; set; }
Property Value
System.Object
Remarks
At least one parameter name and value must be supplied. Subsequent arguments are optional.
For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide .
For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster Parameter Groups in the Amazon Aurora User Guide .
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
Tags
An optional array of key-value pairs to apply to this DB parameter group.
public virtual TagManager Tags { get; }
Property Value
Remarks
Currently, this is the only property that supports drift detection.
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>