Interface ICfnServerlessCacheProps
Properties for defining a CfnServerlessCache
.
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnServerlessCacheProps
Syntax (vb)
Public Interface ICfnServerlessCacheProps
Remarks
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 cfnServerlessCacheProps = 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
Properties
CacheUsageLimits | The cache usage limit for the 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. |
Properties
CacheUsageLimits
The cache usage limit for the serverless cache.
virtual object CacheUsageLimits { get; }
Property Value
System.Object
Remarks
DailySnapshotTime
The daily time that a cache snapshot will be created.
virtual string DailySnapshotTime { get; }
Property Value
System.String
Remarks
Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis only.
Description
A description of the serverless cache.
virtual string Description { get; }
Property Value
System.String
Remarks
Endpoint
Represents the information required for client programs to connect to a cache node.
virtual object Endpoint { get; }
Property Value
System.Object
Remarks
Engine
The engine the serverless cache is compatible with.
string Engine { get; }
Property Value
System.String
Remarks
FinalSnapshotName
The name of the final snapshot taken of a cache before the cache is deleted.
virtual string FinalSnapshotName { get; }
Property Value
System.String
Remarks
KmsKeyId
The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
virtual string KmsKeyId { get; }
Property Value
System.String
Remarks
MajorEngineVersion
The version number of the engine the serverless cache is compatible with.
virtual string MajorEngineVersion { get; }
Property Value
System.String
Remarks
ReaderEndpoint
Represents the information required for client programs to connect to a cache node.
virtual object ReaderEndpoint { get; }
Property Value
System.Object
Remarks
SecurityGroupIds
The IDs of the EC2 security groups associated with the serverless cache.
virtual string[] SecurityGroupIds { get; }
Property Value
System.String[]
Remarks
ServerlessCacheName
The unique identifier of the serverless cache.
string ServerlessCacheName { get; }
Property Value
System.String
Remarks
SnapshotArnsToRestore
The ARN of the snapshot from which to restore data into the new cache.
virtual string[] SnapshotArnsToRestore { get; }
Property Value
System.String[]
Remarks
SnapshotRetentionLimit
The current setting for the number of serverless cache snapshots the system will retain.
virtual Nullable<double> SnapshotRetentionLimit { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
virtual string[] SubnetIds { get; }
Property Value
System.String[]
Remarks
For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
Tags
A list of tags to be added to this resource.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
UserGroupId
The identifier of the user group associated with the serverless cache.
virtual string UserGroupId { get; }
Property Value
System.String
Remarks
Available for Redis only. Default is NULL.