Class CreateServerlessCacheRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest
-
- software.amazon.awssdk.services.elasticache.model.CreateServerlessCacheRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateServerlessCacheRequest.Builder,CreateServerlessCacheRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateServerlessCacheRequest extends ElastiCacheRequest implements ToCopyableBuilder<CreateServerlessCacheRequest.Builder,CreateServerlessCacheRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateServerlessCacheRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateServerlessCacheRequest.Builder
builder()
CacheUsageLimits
cacheUsageLimits()
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.String
dailySnapshotTime()
The daily time that snapshots will be created from the new serverless cache.String
description()
User-provided description for the serverless cache.String
engine()
The name of the cache engine to be used for creating the serverless cache.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasSecurityGroupIds()
For responses, this returns true if the service returned a value for the SecurityGroupIds property.boolean
hasSnapshotArnsToRestore()
For responses, this returns true if the service returned a value for the SnapshotArnsToRestore property.boolean
hasSubnetIds()
For responses, this returns true if the service returned a value for the SubnetIds property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
kmsKeyId()
ARN of the customer managed key for encrypting the data at rest.String
majorEngineVersion()
The version of the cache engine that will be used to create the serverless cache.List<SdkField<?>>
sdkFields()
List<String>
securityGroupIds()
A list of the one or more VPC security groups to be associated with the serverless cache.static Class<? extends CreateServerlessCacheRequest.Builder>
serializableBuilderClass()
String
serverlessCacheName()
User-provided identifier for the serverless cache.List<String>
snapshotArnsToRestore()
The ARN(s) of the snapshot that the new serverless cache will be created from.Integer
snapshotRetentionLimit()
The number of snapshots that will be retained for the serverless cache that is being created.List<String>
subnetIds()
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed.List<Tag>
tags()
The list of tags (key, value) pairs to be added to the serverless cache resource.CreateServerlessCacheRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
userGroupId()
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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
serverlessCacheName
public final String 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
public final 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
public final String 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
public final String 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
public final CacheUsageLimits 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
public final String 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
public final List<String> 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
public final List<String> 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
public final List<Tag> 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
public final String 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
public final List<String> 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
public final Integer 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
public final String 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
public CreateServerlessCacheRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateServerlessCacheRequest.Builder,CreateServerlessCacheRequest>
- Specified by:
toBuilder
in classElastiCacheRequest
-
builder
public static CreateServerlessCacheRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateServerlessCacheRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-