Class CfnParameterGroup
Specifies a new MemoryDB parameter group.
Inherited Members
Namespace: Amazon.CDK.AWS.MemoryDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnParameterGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnParameterGroup Inherits CfnResource Implements IInspectable, ITaggable
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
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.MemoryDB;
var parameters;
var cfnParameterGroup = new CfnParameterGroup(this, "MyCfnParameterGroup", new CfnParameterGroupProps {
Family = "family",
ParameterGroupName = "parameterGroupName",
// the properties below are optional
Description = "description",
Parameters = parameters,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnParameterGroup(Construct, string, ICfnParameterGroupProps) | Specifies a new MemoryDB parameter group. |
Properties
AttrArn | When you pass the logical ID of this resource to the intrinsic |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | Specifies a new MemoryDB parameter group. |
Description | A description of the parameter group. |
Family | The name of the parameter group family that this parameter group is compatible with. |
ParameterGroupName | The name of the parameter group. |
Parameters | Returns the detailed parameter list for the parameter group. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<string, object>) | Specifies a new MemoryDB parameter group. |
Constructors
CfnParameterGroup(Construct, string, ICfnParameterGroupProps)
Specifies a new MemoryDB parameter group.
public CfnParameterGroup(Construct scope, string id, ICfnParameterGroupProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnParameterGroupProps
Resource properties.
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
Properties
AttrArn
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref returns the ARN of the parameter group, such as arn:aws:memorydb:us-east-1:123456789012:parametergroup/my-parameter-group
.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: ARN
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
CfnProperties
Specifies a new MemoryDB parameter group.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
Description
A description of the parameter group.
public virtual string? Description { get; set; }
Property Value
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
Family
The name of the parameter group family that this parameter group is compatible with.
public virtual string Family { get; set; }
Property Value
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
ParameterGroupName
The name of the parameter group.
public virtual string ParameterGroupName { get; set; }
Property Value
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
Parameters
Returns the detailed parameter list for the parameter group.
public virtual object? Parameters { get; set; }
Property Value
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
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
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Specifies a new MemoryDB parameter group.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .
CloudformationResource: AWS::MemoryDB::ParameterGroup
ExampleMetadata: fixture=_generated