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< ? endpoints, Input<ServerlessCacheEndpoint> ?>String?> ? engine, Input<String?> ? fullEngineVersion, Input<String?> ? kmsKeyId, Input<String?> ? majorEngineVersion, Input<String?> ? name, Input<String?> ? networkType, Input<List< ? readerEndpoints, Input<ServerlessCacheReaderEndpoint> ?>String?> ? region, Input<List< ? securityGroupIds, Input<String> ?>List< ? snapshotArnsToRestores, Input<String> ?>int?> ? snapshotRetentionLimit, Input<String?> ? status, Input<List< ? subnetIds, Input<String> ?>Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>ServerlessCacheTimeouts?> ? timeouts, Input<String?> ? userGroupId}) -
Creates a new ServerlessCacheState.
arnARN of the serverless cache.cacheUsageLimitsSets the cache usage limits for storage and ElastiCache Processing Units for the cache. SeecacheUsageLimitsBlock for details.createTimeTimestamp of when the serverless cache was created.dailySnapshotTimeThe daily time that snapshots will be created from the new serverless cache. Only supported for engine types"redis"or"valkey". Defaults to0.descriptionUser-provided description for the serverless cache. The default is NULL.endpointsRepresents the information required for client programs to connect to a cache node. SeeendpointBlock for details.engineName of the cache engine to be used for this cache cluster. Valid values arememcached,redisorvalkey.fullEngineVersionThe name and version number of the engine the serverless cache is compatible with.kmsKeyIdARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.majorEngineVersionThe version of the cache engine that will be used to create the serverless cache.nameThe Cluster name which serves as a unique identifier to the serverless cachenetworkTypeIP protocol version used by the serverless cache. Valid values areipv4,ipv6, ordualStack.ipv6is only supported with IPv6-only subnets. If not specified, defaults toipv4, unless all provided subnets are IPv6-only, in which case it defaults toipv6.readerEndpointsRepresents the information required for client programs to connect to a cache node. SeereaderEndpointBlock for details.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.securityGroupIdsA 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.snapshotArnsToRestoresThe list of ARN(s) of the snapshot that the new serverless cache will be created from. Only supported for engine types"redis"or"valkey".snapshotRetentionLimitThe 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".statusThe current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.subnetIdsA 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.tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllOptional.timeoutsOptional.userGroupIdThe 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
cacheUsageLimitsBlock 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 to0.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
endpointBlock for details.final -
engine
→ Input<
String?> ? -
Name of the cache engine to be used for this cache cluster. Valid values are
memcached,redisorvalkey.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, ordualStack.ipv6is only supported with IPv6-only subnets. If not specified, defaults toipv4, unless all provided subnets are IPv6-only, in which case it defaults toipv6.final -
readerEndpoints
→ Input<
List< ?ServerlessCacheReaderEndpoint> ?> -
Represents the information required for client programs to connect to a cache node. See
readerEndpointBlock 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
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
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