ServerlessCacheState class

Input properties used for looking up and filtering ServerlessCache resources.

Constructors

ServerlessCacheState({Input<String?>? arn, Input<ServerlessCacheCacheUsageLimits?>? cacheUsageLimits, Input<String?>? createTime, Input<String?>? dailySnapshotTime, Input<String?>? description, Input<List<ServerlessCacheEndpoint>?>? endpoints, Input<String?>? engine, Input<String?>? fullEngineVersion, Input<String?>? kmsKeyId, Input<String?>? majorEngineVersion, Input<String?>? name, Input<String?>? networkType, Input<List<ServerlessCacheReaderEndpoint>?>? readerEndpoints, Input<String?>? region, Input<List<String>?>? securityGroupIds, Input<List<String>?>? snapshotArnsToRestores, Input<int?>? snapshotRetentionLimit, Input<String?>? status, Input<List<String>?>? subnetIds, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<ServerlessCacheTimeouts?>? timeouts, Input<String?>? userGroupId})
Creates a new ServerlessCacheState. arn ARN of the serverless cache. cacheUsageLimits Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See cacheUsageLimits Block for details. createTime Timestamp of when the serverless cache was created. dailySnapshotTime The daily time that snapshots will be created from the new serverless cache. Only supported for engine types "redis" or "valkey". Defaults to 0. description User-provided description for the serverless cache. The default is NULL. endpoints Represents the information required for client programs to connect to a cache node. See endpoint Block for details. engine Name of the cache engine to be used for this cache cluster. Valid values are memcached, redis or valkey. fullEngineVersion The name and version number of the engine the serverless cache is compatible with. kmsKeyId ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used. majorEngineVersion The version of the cache engine that will be used to create the serverless cache. name The Cluster name which serves as a unique identifier to the serverless cache networkType IP protocol version used by the serverless cache. Valid values are ipv4, ipv6, or dualStack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6. readerEndpoints Represents the information required for client programs to connect to a cache node. See readerEndpoint Block for details. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. securityGroupIds A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point. snapshotArnsToRestores The list of ARN(s) of the snapshot that the new serverless cache will be created from. Only supported for engine types "redis" or "valkey". snapshotRetentionLimit The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Only supported for engine types "redis" or "valkey". status The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING. subnetIds A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC. tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Optional. timeouts Optional. userGroupId The identifier of the UserGroup to be associated with the serverless cache. Available for Redis and Valkey. Default is NULL.
const
ServerlessCacheState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the serverless cache.
final
cacheUsageLimits → Input<ServerlessCacheCacheUsageLimits?>?
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See cacheUsageLimits Block for details.
final
createTime → Input<String?>?
Timestamp of when the serverless cache was created.
final
dailySnapshotTime → Input<String?>?
The daily time that snapshots will be created from the new serverless cache. Only supported for engine types "redis" or "valkey". Defaults to 0.
final
description → Input<String?>?
User-provided description for the serverless cache. The default is NULL.
final
endpoints → Input<List<ServerlessCacheEndpoint>?>?
Represents the information required for client programs to connect to a cache node. See endpoint Block for details.
final
engine → Input<String?>?
Name of the cache engine to be used for this cache cluster. Valid values are memcached, redis or valkey.
final
fullEngineVersion → Input<String?>?
The name and version number of the engine the serverless cache is compatible with.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
final
majorEngineVersion → Input<String?>?
The version of the cache engine that will be used to create the serverless cache. See Describe Cache Engine Versions in the AWS Documentation for supported versions.
final
name → Input<String?>?
The Cluster name which serves as a unique identifier to the serverless cache
final
networkType → Input<String?>?
IP protocol version used by the serverless cache. Valid values are ipv4, ipv6, or dualStack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.
final
readerEndpoints → Input<List<ServerlessCacheReaderEndpoint>?>?
Represents the information required for client programs to connect to a cache node. See readerEndpoint Block for details.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds → Input<List<String>?>?
A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
final
snapshotArnsToRestores → Input<List<String>?>?
The list of ARN(s) of the snapshot that the new serverless cache will be created from. Only supported for engine types "redis" or "valkey".
final
snapshotRetentionLimit → Input<int?>?
The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Only supported for engine types "redis" or "valkey".
final
status → Input<String?>?
The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
final
subnetIds → Input<List<String>?>?
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
final
timeouts → Input<ServerlessCacheTimeouts?>?
final
userGroupId → Input<String?>?
The identifier of the UserGroup to be associated with the serverless cache. Available for Redis and Valkey. Default is NULL.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited