Class CreateServerlessCacheRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateServerlessCacheRequest.Builder,
CreateServerlessCacheRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final CacheUsageLimits
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.final String
The daily time that snapshots will be created from the new serverless cache.final String
User-provided description for the serverless cache.final String
engine()
The name of the cache engine to be used for creating the serverless cache.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.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 SnapshotArnsToRestore property.final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
ARN of the customer managed key for encrypting the data at rest.final String
The version of the cache engine that will be used to create the serverless cache.A list of the one or more VPC security groups to be associated with the serverless cache.static Class
<? extends CreateServerlessCacheRequest.Builder> final String
User-provided identifier for the serverless cache.The ARN(s) of the snapshot that the new serverless cache will be created from.final Integer
The number of snapshots that will be retained for the serverless cache that is being created.A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed.tags()
The list of tags (key, value) pairs to be added to the serverless cache resource.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 UserGroup to be associated with the serverless cache.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
serverlessCacheName
User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
- Returns:
- User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
-
description
User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.
- Returns:
- User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.
-
engine
The name of the cache engine to be used for creating the serverless cache.
- Returns:
- The name of the cache engine to be used for creating the serverless cache.
-
majorEngineVersion
The version of the cache engine that will be used to create the serverless cache.
- Returns:
- The version of the cache engine that will be used to create the serverless cache.
-
cacheUsageLimits
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
- Returns:
- Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
-
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.
- Returns:
- ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
-
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
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.
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:
- 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.
-
hasSnapshotArnsToRestore
public final boolean hasSnapshotArnsToRestore()For responses, this returns true if the service returned a value for the SnapshotArnsToRestore 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. -
snapshotArnsToRestore
The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
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
hasSnapshotArnsToRestore()
method.- Returns:
- The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
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
hasTags()
method.- Returns:
- The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
-
userGroupId
The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
- Returns:
- The identifier of the UserGroup to be 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
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.
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:
- 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.
-
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. Available for Redis only.
- Returns:
- 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. Available for Redis only.
-
dailySnapshotTime
The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Redis only.
- Returns:
- The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic 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<CreateServerlessCacheRequest.Builder,
CreateServerlessCacheRequest> - Specified by:
toBuilder
in classElastiCacheRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-