Package software.amazon.awssdk.services.elasticache.model

Class ModifyServerlessCacheRequest

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.ModifyServerlessCacheRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyServerlessCacheRequest.Builder,ModifyServerlessCacheRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ModifyServerlessCacheRequest
extends ElastiCacheRequest
implements ToCopyableBuilder<ModifyServerlessCacheRequest.Builder,ModifyServerlessCacheRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyServerlessCacheRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ModifyServerlessCacheRequest.Builder	builder()
CacheUsageLimits	cacheUsageLimits()	Modify the cache usage limit for the serverless cache.
String	dailySnapshotTime()	The daily time during which Elasticache begins taking a daily snapshot of the serverless cache.
String	description()	User provided description for 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	removeUserGroup()	The identifier of the UserGroup to be removed from association with the Redis OSS serverless cache.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds()	The new list of VPC security groups to be associated with the serverless cache.
static Class<? extends ModifyServerlessCacheRequest.Builder>	serializableBuilderClass()
String	serverlessCacheName()	User-provided identifier for the serverless cache to be modified.
Integer	snapshotRetentionLimit()	The number of days for which Elasticache retains automatic snapshots before deleting them.
ModifyServerlessCacheRequest.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 to be modified.

Returns:

User-provided identifier for the serverless cache to be modified.

description

public final String description()

User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.

Returns:

User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.

cacheUsageLimits

public final CacheUsageLimits cacheUsageLimits()

Modify the cache usage limit for the serverless cache.

Returns:

Modify the cache usage limit for the serverless cache.

removeUserGroup

public final Boolean removeUserGroup()

The identifier of the UserGroup to be removed from association with the Redis OSS serverless cache. Available for Redis OSS only. Default is NULL.

Returns:

The identifier of the UserGroup to be removed from association with the Redis OSS serverless cache. Available for Redis OSS only. Default is NULL.

userGroupId

public final String userGroupId()

The identifier of the UserGroup to be associated with the serverless cache. Available for Redis OSS only. Default is NULL - the existing UserGroup is not removed.

Returns:

The identifier of the UserGroup to be associated with the serverless cache. Available for Redis OSS only. Default is NULL - the existing UserGroup is not removed.

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 the isEmpty() 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()

The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.

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 new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.

snapshotRetentionLimit

public final Integer snapshotRetentionLimit()

The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.

Returns:

The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.

dailySnapshotTime

public final String dailySnapshotTime()

The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

Returns:

The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

toBuilder

public ModifyServerlessCacheRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyServerlessCacheRequest.Builder,ModifyServerlessCacheRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static ModifyServerlessCacheRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyServerlessCacheRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo