Class CfnParameterGroup

The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnParameterGroup

Implements

IInspectable

IParameterGroupRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnParameterGroup : CfnResource, IInspectable, IParameterGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnParameterGroup Inherits CfnResource Implements IInspectable, IParameterGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

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 AWS::ElastiCache::ParameterGroup.

Properties

AttrCacheParameterGroupName	A user-specified name for the cache parameter group.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CacheParameterGroupFamily	The name of the cache parameter group family that this cache parameter group is compatible with.
CfnProperties	The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.
CfnPropertyNames	The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.
Description	The description for this cache parameter group.
ParameterGroupRef	A reference to a ParameterGroup resource.
Properties	A comma-delimited list of parameter name/value pairs.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A tag that can be added to an ElastiCache parameter group.

Methods

ArnForParameterGroup(IParameterGroupRef)	The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.
FromCacheParameterGroupName(Construct, string, string)	Creates a new IParameterGroupRef from a cacheParameterGroupName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnParameterGroup(object)	Checks whether the given object is a CfnParameterGroup.
RenderProperties(IDictionary<string, object>)	The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnParameterGroupProps

Resource properties.

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

Properties

AttrCacheParameterGroupName

A user-specified name for the cache parameter group.

public virtual string AttrCacheParameterGroupName { get; }

Property Value

string

Remarks

CloudformationAttribute: CacheParameterGroupName

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

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

string

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

Description

The description for this cache parameter group.

public virtual string Description { get; set; }

Property Value

string

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

ParameterGroupRef

A reference to a ParameterGroup resource.

public virtual IParameterGroupReference ParameterGroupRef { get; }

Property Value

IParameterGroupReference

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

Properties

A comma-delimited list of parameter name/value pairs.

public virtual object? Properties { get; set; }

Property Value

object

Remarks

Type union: either Dictionary<string, string> or IResolvable

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

TagsRaw

A tag that can be added to an ElastiCache parameter group.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

Methods

ArnForParameterGroup(IParameterGroupRef)

The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.

public static string ArnForParameterGroup(IParameterGroupRef resource)

Parameters

resource IParameterGroupRef

Returns

string

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

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"
                 } }
             });

FromCacheParameterGroupName(Construct, string, string)

Creates a new IParameterGroupRef from a cacheParameterGroupName.

public static IParameterGroupRef FromCacheParameterGroupName(Construct scope, string id, string cacheParameterGroupName)

Parameters

scope Construct

id string

cacheParameterGroupName string

Returns

IParameterGroupRef

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

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

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

IsCfnParameterGroup(object)

Checks whether the given object is a CfnParameterGroup.

public static bool IsCfnParameterGroup(object x)

Parameters

x object

Returns

bool

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Cache parameter groups control the parameters for a cache cluster.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

CloudformationResource: AWS::ElastiCache::ParameterGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

IParameterGroupRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable