Class CfnParameterGroup
A CloudFormation AWS::ElastiCache::ParameterGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.AWS.ElastiCache.dll
Syntax (csharp)
public class CfnParameterGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnParameterGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ElastiCache::ParameterGroup
type creates a new cache parameter group. Cache parameter groups control the parameters for a cache cluster.
CloudformationResource: AWS::ElastiCache::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.ElastiCache;
var cfnParameterGroup = new CfnParameterGroup(this, "MyCfnParameterGroup", new CfnParameterGroupProps {
CacheParameterGroupFamily = "cacheParameterGroupFamily",
Description = "description",
// the properties below are optional
Properties = new Dictionary<string, string> {
{ "propertiesKey", "properties" }
},
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
CacheParameterGroupFamily | The name of the cache parameter group family that this cache parameter group is compatible with. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description for this cache parameter group. |
Properties | A comma-delimited list of parameter name/value pairs. |
Tags | A tag that can be added to an ElastiCache parameter group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnParameterGroup(Construct, String, ICfnParameterGroupProps)
Create a new AWS::ElastiCache::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
CacheParameterGroupFamily
The name of the cache parameter group family that this cache parameter group is compatible with.
public virtual string CacheParameterGroupFamily { get; set; }
Property Value
System.String
Remarks
Valid values are: memcached1.4
| memcached1.5
| memcached1.6
| redis2.6
| redis2.8
| redis3.2
| redis4.0
| redis5.0
| redis6.x
| redis7
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
The description for this cache parameter group.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Properties
A comma-delimited list of parameter name/value pairs.
public virtual object Properties { get; set; }
Property Value
System.Object
Remarks
For example:
"Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02"
}
Tags
A tag that can be added to an ElastiCache parameter group.
public virtual TagManager Tags { get; }
Property Value
Remarks
Tags are composed of a Key/Value pair. You can use tags to categorize and track all your parameter groups. A tag with a null Value is permitted.
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>