Class ServerlessCache
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ServerlessCache.Builder,
ServerlessCache>
The resource representing a serverless cache.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the serverless cache.static ServerlessCache.Builder
builder()
final CacheUsageLimits
The cache usage limit for the serverless cache.final Instant
When the serverless cache was created.final String
The daily time that a cache snapshot will be created.final String
A description of the serverless cache.final Endpoint
endpoint()
Returns the value of the Endpoint property for this object.final String
engine()
The engine the serverless cache is compatible with.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name and version number of the engine the serverless cache is compatible with.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.final String
kmsKeyId()
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.final String
The version number of the engine the serverless cache is compatible with.final Endpoint
Returns the value of the ReaderEndpoint property for this object.The IDs of the EC2 security groups associated with the serverless cache.static Class
<? extends ServerlessCache.Builder> final String
The unique identifier of the serverless cache.final Integer
The current setting for the number of serverless cache snapshots the system will retain.final String
status()
The current status of the serverless cache.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.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The identifier of the user group associated with the serverless cache.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
serverlessCacheName
The unique identifier of the serverless cache.
- Returns:
- The unique identifier of the serverless cache.
-
description
A description of the serverless cache.
- Returns:
- A description of the serverless cache.
-
createTime
When the serverless cache was created.
- Returns:
- When the serverless cache was created.
-
status
The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Returns:
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
-
engine
The engine the serverless cache is compatible with.
- Returns:
- The engine the serverless cache is compatible with.
-
majorEngineVersion
The version number of the engine the serverless cache is compatible with.
- Returns:
- The version number of the engine the serverless cache is compatible with.
-
fullEngineVersion
The name and version number of the engine the serverless cache is compatible with.
- Returns:
- The name and version number of the engine the serverless cache is compatible with.
-
cacheUsageLimits
The cache usage limit for the serverless cache.
- Returns:
- The cache usage limit for the serverless cache.
-
kmsKeyId
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
- Returns:
- The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
securityGroupIds
The IDs of the EC2 security groups associated with the serverless cache.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecurityGroupIds()
method.- Returns:
- The IDs of the EC2 security groups associated with the serverless cache.
-
endpoint
Returns the value of the Endpoint property for this object.- Returns:
- The value of the Endpoint property for this object.
-
readerEndpoint
Returns the value of the ReaderEndpoint property for this object.- Returns:
- The value of the ReaderEndpoint property for this object.
-
arn
The Amazon Resource Name (ARN) of the serverless cache.
- Returns:
- The Amazon Resource Name (ARN) of the serverless cache.
-
userGroupId
The identifier of the user group associated with the serverless cache. Available for Redis only. Default is NULL.
- Returns:
- The identifier of the user group associated with the serverless cache. Available for Redis only. Default is NULL.
-
hasSubnetIds
public final boolean hasSubnetIds()For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubnetIds()
method.- Returns:
- 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. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
-
snapshotRetentionLimit
The current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
- Returns:
- The current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
-
dailySnapshotTime
The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis only.
- Returns:
- The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis only.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ServerlessCache.Builder,
ServerlessCache> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-