Class CfnParameterGroup
A CloudFormation AWS::MemoryDB::ParameterGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.MemoryDB
Assembly: Amazon.CDK.AWS.MemoryDB.dll
Syntax (csharp)
public class CfnParameterGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnParameterGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a new MemoryDB parameter group. 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) | Create a new |
CfnParameterGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnParameterGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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 | |
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 | 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>) |
Constructors
CfnParameterGroup(Construct, String, ICfnParameterGroupProps)
Create a new AWS::MemoryDB::ParameterGroup
.
public CfnParameterGroup(Construct scope, string id, ICfnParameterGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnParameterGroupProps
- resource properties.
CfnParameterGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnParameterGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnParameterGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnParameterGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
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
System.String
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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the parameter group.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Family
The name of the parameter group family that this parameter group is compatible with.
public virtual string Family { get; set; }
Property Value
System.String
Remarks
ParameterGroupName
The name of the parameter group.
public virtual string ParameterGroupName { get; set; }
Property Value
System.String
Remarks
Parameters
Returns the detailed parameter list for the parameter group.
public virtual object Parameters { get; set; }
Property Value
System.Object
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
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>