Class CfnDBParameterGroup
AWS::Neptune::DBParameterGroup
creates a new DB parameter group.
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
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
parameter of AWS::Neptune::DBInstance
.
Applying a parameter group to a DB instance might require the instance to reboot, resulting in a database outage for the duration of the reboot. > If you provide a custom DBParameterGroup
that you associate with DBInstance
, it is best to specify an EngineVersion
property in DBCluster
. That EngineVersion
needs to be compatible with the value of the Family
property in the DBParameterGroup
.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup . Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance . When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
CloudformationResource: AWS::Neptune::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.Neptune;
var parameters;
var cfnDBParameterGroup = new CfnDBParameterGroup(this, "MyCfnDBParameterGroup", new CfnDBParameterGroupProps {
Description = "description",
Family = "family",
Parameters = parameters,
// the properties below are optional
Name = "name",
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
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | Provides the customer-specified description for this DB parameter group. |
Family | Must be |
Name | Provides the name of the DB parameter group. |
Parameters | The parameters to set for this DB parameter group. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags that you want to attach to this 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
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
Description
Provides the customer-specified description for this DB parameter group.
public virtual string Description { get; set; }
Property Value
System.String
Family
Must be neptune1
for engine versions prior to 1.2.0.0 , or neptune1.2
for engine version 1.2.0.0
and higher.
public virtual string Family { get; set; }
Property Value
System.String
Name
Provides the name of the DB parameter group.
public virtual string Name { get; set; }
Property Value
System.String
Parameters
The parameters to set for this DB parameter group.
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
The tags that you want to attach to this 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>