Class CfnServerlessCache
The resource representing a serverless cache.
Inherited Members
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnServerlessCache : CfnResource, IInspectable, ITaggableV2Syntax (vb)
Public Class CfnServerlessCache
Inherits CfnResource
Implements IInspectable, ITaggableV2Remarks
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| CfnServerlessCache(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
| CfnServerlessCache(Construct, String, ICfnServerlessCacheProps) |
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. |
| CacheUsageLimits | The cache usage limit for the serverless cache. |
| CdkTagManager | Tag Manager which manages the tags for this resource. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | |
| 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>) |
Constructors
CfnServerlessCache(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnServerlessCache(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnServerlessCache(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnServerlessCache(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnServerlessCache(Construct, String, ICfnServerlessCacheProps)
public CfnServerlessCache(Construct scope, string id, ICfnServerlessCacheProps props)Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnServerlessCacheProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the serverless cache.
public virtual string AttrArn { get; }Property Value
System.String
Remarks
CloudformationAttribute: ARN
AttrCreateTime
When the serverless cache was created.
public virtual string AttrCreateTime { get; }Property Value
System.String
Remarks
CloudformationAttribute: CreateTime
AttrEndpointAddress
The DNS hostname of the cache node.
public virtual string AttrEndpointAddress { get; }Property Value
System.String
Remarks
CloudformationAttribute: Endpoint.Address
AttrEndpointPort
The port number that the cache engine is listening on.
public virtual string AttrEndpointPort { get; }Property Value
System.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
System.String
Remarks
CloudformationAttribute: FullEngineVersion
AttrReaderEndpointAddress
The DNS hostname of the cache node.
public virtual string AttrReaderEndpointAddress { get; }Property Value
System.String
Remarks
CloudformationAttribute: ReaderEndpoint.Address
AttrReaderEndpointPort
The port number that the cache engine is listening on.
public virtual string AttrReaderEndpointPort { get; }Property Value
System.String
Remarks
CloudformationAttribute: ReaderEndpoint.Port
AttrStatus
The current status of the serverless cache.
public virtual string AttrStatus { get; }Property Value
System.String
Remarks
The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
CloudformationAttribute: Status
CacheUsageLimits
The cache usage limit for the serverless cache.
public virtual object CacheUsageLimits { get; set; }Property Value
System.Object
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }Property Value
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
DailySnapshotTime
The daily time that a cache snapshot will be created.
public virtual string DailySnapshotTime { get; set; }Property Value
System.String
Description
A description of the serverless cache.
public virtual string Description { get; set; }Property Value
System.String
Endpoint
Represents the information required for client programs to connect to a cache node.
public virtual object Endpoint { get; set; }Property Value
System.Object
Engine
The engine the serverless cache is compatible with.
public virtual string Engine { get; set; }Property Value
System.String
FinalSnapshotName
The name of the final snapshot taken of a cache before the cache is deleted.
public virtual string FinalSnapshotName { get; set; }Property Value
System.String
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
System.String
MajorEngineVersion
The version number of the engine the serverless cache is compatible with.
public virtual string MajorEngineVersion { get; set; }Property Value
System.String
ReaderEndpoint
Represents the information required for client programs to connect to a cache node.
public virtual object ReaderEndpoint { get; set; }Property Value
System.Object
SecurityGroupIds
The IDs of the EC2 security groups associated with the serverless cache.
public virtual string[] SecurityGroupIds { get; set; }Property Value
System.String[]
ServerlessCacheName
The unique identifier of the serverless cache.
public virtual string ServerlessCacheName { get; set; }Property Value
System.String
SnapshotArnsToRestore
The ARN of the snapshot from which to restore data into the new cache.
public virtual string[] SnapshotArnsToRestore { get; set; }Property Value
System.String[]
SnapshotRetentionLimit
The current setting for the number of serverless cache snapshots the system will retain.
public virtual Nullable<double> SnapshotRetentionLimit { get; set; }Property Value
System.Nullable<System.Double>
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
System.String[]
Tags
A list of tags to be added to this resource.
public virtual ICfnTag[] Tags { get; set; }Property Value
ICfnTag[]
UserGroupId
The identifier of the user group associated with the serverless cache.
public virtual string UserGroupId { get; set; }Property Value
System.String
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>