Class CfnServerlessCache

The resource representing a serverless cache.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnServerlessCache

Implements

IInspectable

ITaggableV2

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.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.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnServerlessCache : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnServerlessCache Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

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 cfnServerlessCache = new CfnServerlessCache(this, "MyCfnServerlessCache", new CfnServerlessCacheProps {
                 Engine = "engine",
                 ServerlessCacheName = "serverlessCacheName",

                 // the properties below are optional
                 CacheUsageLimits = new CacheUsageLimitsProperty {
                     DataStorage = new DataStorageProperty {
                         Unit = "unit",

                         // the properties below are optional
                         Maximum = 123,
                         Minimum = 123
                     },
                     EcpuPerSecond = new ECPUPerSecondProperty {
                         Maximum = 123,
                         Minimum = 123
                     }
                 },
                 DailySnapshotTime = "dailySnapshotTime",
                 Description = "description",
                 Endpoint = new EndpointProperty {
                     Address = "address",
                     Port = "port"
                 },
                 FinalSnapshotName = "finalSnapshotName",
                 KmsKeyId = "kmsKeyId",
                 MajorEngineVersion = "majorEngineVersion",
                 ReaderEndpoint = new EndpointProperty {
                     Address = "address",
                     Port = "port"
                 },
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SnapshotArnsToRestore = new [] { "snapshotArnsToRestore" },
                 SnapshotRetentionLimit = 123,
                 SubnetIds = new [] { "subnetIds" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UserGroupId = "userGroupId"
             });

Synopsis

Constructors

CfnServerlessCache(Construct, string, ICfnServerlessCacheProps)

The resource representing a serverless cache.

Properties

AttrArn	The Amazon Resource Name (ARN) of the serverless cache.
AttrCreateTime	When the serverless cache was created.
AttrEndpointAddress	The DNS hostname of the cache node.
AttrEndpointPort	The port number that the cache engine is listening on.
AttrFullEngineVersion	The name and version number of the engine the serverless cache is compatible with.
AttrReaderEndpointAddress	The DNS hostname of the cache node.
AttrReaderEndpointPort	The port number that the cache engine is listening on.
AttrStatus	The current status of the serverless cache.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CacheUsageLimits	The cache usage limit for the serverless cache.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The resource representing a serverless cache.
DailySnapshotTime	The daily time that a cache snapshot will be created.
Description	A description of the serverless cache.
Endpoint	Represents the information required for client programs to connect to a cache node.
Engine	The engine the serverless cache is compatible with.
FinalSnapshotName	The name of the final snapshot taken of a cache before the cache is deleted.
KmsKeyId	The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
MajorEngineVersion	The version number of the engine the serverless cache is compatible with.
ReaderEndpoint	Represents the information required for client programs to connect to a cache node.
SecurityGroupIds	The IDs of the EC2 security groups associated with the serverless cache.
ServerlessCacheName	The unique identifier of the serverless cache.
SnapshotArnsToRestore	The ARN of the snapshot from which to restore data into the new cache.
SnapshotRetentionLimit	The current setting for the number of serverless cache snapshots the system will retain.
SubnetIds	If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.
Tags	A list of tags to be added to this resource.
UserGroupId	The identifier of the user group associated with the serverless cache.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The resource representing a serverless cache.

Constructors

CfnServerlessCache(Construct, string, ICfnServerlessCacheProps)

The resource representing a serverless cache.

public CfnServerlessCache(Construct scope, string id, ICfnServerlessCacheProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnServerlessCacheProps

Resource properties.

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the serverless cache.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ARN

AttrCreateTime

When the serverless cache was created.

public virtual string AttrCreateTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreateTime

AttrEndpointAddress

The DNS hostname of the cache node.

public virtual string AttrEndpointAddress { get; }

Property Value

string

Remarks

CloudformationAttribute: Endpoint.Address

AttrEndpointPort

The port number that the cache engine is listening on.

public virtual string AttrEndpointPort { get; }

Property Value

string

Remarks

CloudformationAttribute: Endpoint.Port

AttrFullEngineVersion

The name and version number of the engine the serverless cache is compatible with.

public virtual string AttrFullEngineVersion { get; }

Property Value

string

Remarks

CloudformationAttribute: FullEngineVersion

AttrReaderEndpointAddress

The DNS hostname of the cache node.

public virtual string AttrReaderEndpointAddress { get; }

Property Value

string

Remarks

CloudformationAttribute: ReaderEndpoint.Address

AttrReaderEndpointPort

The port number that the cache engine is listening on.

public virtual string AttrReaderEndpointPort { get; }

Property Value

string

Remarks

CloudformationAttribute: ReaderEndpoint.Port

AttrStatus

The current status of the serverless cache.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

CloudformationAttribute: Status

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

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

CacheUsageLimits

The cache usage limit for the serverless cache.

public virtual object? CacheUsageLimits { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

CfnProperties

The resource representing a serverless cache.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

DailySnapshotTime

The daily time that a cache snapshot will be created.

public virtual string? DailySnapshotTime { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

Description

A description of the serverless cache.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

Endpoint

Represents the information required for client programs to connect to a cache node.

public virtual object? Endpoint { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

Engine

The engine the serverless cache is compatible with.

public virtual string Engine { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

FinalSnapshotName

The name of the final snapshot taken of a cache before the cache is deleted.

public virtual string? FinalSnapshotName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

KmsKeyId

The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

public virtual string? KmsKeyId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

MajorEngineVersion

The version number of the engine the serverless cache is compatible with.

public virtual string? MajorEngineVersion { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

ReaderEndpoint

Represents the information required for client programs to connect to a cache node.

public virtual object? ReaderEndpoint { get; set; }

Property Value

object

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

SecurityGroupIds

The IDs of the EC2 security groups associated with the serverless cache.

public virtual string[]? SecurityGroupIds { get; set; }

Property Value

string[]

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

ServerlessCacheName

The unique identifier of the serverless cache.

public virtual string ServerlessCacheName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

SnapshotArnsToRestore

The ARN of the snapshot from which to restore data into the new cache.

public virtual string[]? SnapshotArnsToRestore { get; set; }

Property Value

string[]

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

SnapshotRetentionLimit

The current setting for the number of serverless cache snapshots the system will retain.

public virtual double? SnapshotRetentionLimit { get; set; }

Property Value

double?

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

SubnetIds

If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.

public virtual string[]? SubnetIds { get; set; }

Property Value

string[]

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

Tags

A list of tags to be added to this resource.

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

Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

UserGroupId

The identifier of the user group associated with the serverless cache.

public virtual string? UserGroupId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

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

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The resource representing a serverless cache.

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

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

CloudformationResource: AWS::ElastiCache::ServerlessCache

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggableV2