Class ModifyCacheClusterRequest
- 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.ModifyCacheClusterRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ModifyCacheClusterRequest.Builder,ModifyCacheClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyCacheClusterRequest extends ElastiCacheRequest implements ToCopyableBuilder<ModifyCacheClusterRequest.Builder,ModifyCacheClusterRequest>
Represents the input of a
ModifyCacheClusteroperation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceModifyCacheClusterRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanapplyImmediately()Iftrue, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of thePreferredMaintenanceWindowsetting for the cluster.StringauthToken()Reserved parameter.AuthTokenUpdateStrategyTypeauthTokenUpdateStrategy()Specifies the strategy to use to update the AUTH token.StringauthTokenUpdateStrategyAsString()Specifies the strategy to use to update the AUTH token.BooleanautoMinorVersionUpgrade()If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign.AZModeazMode()Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.StringazModeAsString()Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.static ModifyCacheClusterRequest.Builderbuilder()StringcacheClusterId()The cluster identifier.List<String>cacheNodeIdsToRemove()A list of cache node IDs to be removed.StringcacheNodeType()A valid cache node type that you want to scale this cluster up to.StringcacheParameterGroupName()The name of the cache parameter group to apply to this cluster.List<String>cacheSecurityGroupNames()A list of cache security group names to authorize on this cluster.Stringengine()The engine type used by the cache cluster.StringengineVersion()The upgraded version of the cache engine to be run on the cache nodes.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCacheNodeIdsToRemove()For responses, this returns true if the service returned a value for the CacheNodeIdsToRemove property.booleanhasCacheSecurityGroupNames()For responses, this returns true if the service returned a value for the CacheSecurityGroupNames property.inthashCode()booleanhasLogDeliveryConfigurations()For responses, this returns true if the service returned a value for the LogDeliveryConfigurations property.booleanhasNewAvailabilityZones()For responses, this returns true if the service returned a value for the NewAvailabilityZones property.booleanhasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property.IpDiscoveryipDiscovery()The network type you choose when modifying a cluster, eitheripv4|ipv6.StringipDiscoveryAsString()The network type you choose when modifying a cluster, eitheripv4|ipv6.List<LogDeliveryConfigurationRequest>logDeliveryConfigurations()Specifies the destination, format and type of the logs.List<String>newAvailabilityZones()StringnotificationTopicArn()The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.StringnotificationTopicStatus()The status of the Amazon SNS notification topic.IntegernumCacheNodes()The number of cache nodes that the cluster should have.StringpreferredMaintenanceWindow()Specifies the weekly time range during which maintenance on the cluster is performed.ScaleConfigscaleConfig()Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<String>securityGroupIds()Specifies the VPC Security Groups associated with the cluster.static Class<? extends ModifyCacheClusterRequest.Builder>serializableBuilderClass()IntegersnapshotRetentionLimit()The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.StringsnapshotWindow()The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.ModifyCacheClusterRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
cacheClusterId
public final String cacheClusterId()
The cluster identifier. This value is stored as a lowercase string.
- Returns:
- The cluster identifier. This value is stored as a lowercase string.
-
numCacheNodes
public final Integer numCacheNodes()
The number of cache nodes that the cluster should have. If the value for
NumCacheNodesis greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.If you are removing cache nodes, you must use the
CacheNodeIdsToRemoveparameter to provide the IDs of the specific cache nodes to remove.For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately).A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the
ModifyCacheClusterrequest and setNumCacheNodesequal to the number of cache nodes currently in the cluster.- Returns:
- The number of cache nodes that the cluster should have. If the value for
NumCacheNodesis greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.If you are removing cache nodes, you must use the
CacheNodeIdsToRemoveparameter to provide the IDs of the specific cache nodes to remove.For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately).A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the
ModifyCacheClusterrequest and setNumCacheNodesequal to the number of cache nodes currently in the cluster.
-
hasCacheNodeIdsToRemove
public final boolean hasCacheNodeIdsToRemove()
For responses, this returns true if the service returned a value for the CacheNodeIdsToRemove 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.
-
cacheNodeIdsToRemove
public final List<String> cacheNodeIdsToRemove()
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when
NumCacheNodesis less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value ofNumCacheNodesin the request.For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this
ModifyCacheClustercall is 5, you must list 2 (7 - 5) cache node IDs to remove.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
hasCacheNodeIdsToRemove()method.- Returns:
- A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This
parameter is only valid when
NumCacheNodesis less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value ofNumCacheNodesin the request.For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this
ModifyCacheClustercall is 5, you must list 2 (7 - 5) cache node IDs to remove.
-
azMode
public final AZMode azMode()
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.
Valid values:
single-az|cross-az.This option is only supported for Memcached clusters.
You cannot specify
single-azif the Memcached cluster already has cache nodes in different Availability Zones. Ifcross-azis specified, existing Memcached nodes remain in their current Availability Zone.Only newly created nodes are located in different Availability Zones.
If the service returns an enum value that is not available in the current SDK version,
azModewill returnAZMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromazModeAsString().- Returns:
- Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone
or created across multiple Availability Zones.
Valid values:
single-az|cross-az.This option is only supported for Memcached clusters.
You cannot specify
single-azif the Memcached cluster already has cache nodes in different Availability Zones. Ifcross-azis specified, existing Memcached nodes remain in their current Availability Zone.Only newly created nodes are located in different Availability Zones.
- See Also:
AZMode
-
azModeAsString
public final String azModeAsString()
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.
Valid values:
single-az|cross-az.This option is only supported for Memcached clusters.
You cannot specify
single-azif the Memcached cluster already has cache nodes in different Availability Zones. Ifcross-azis specified, existing Memcached nodes remain in their current Availability Zone.Only newly created nodes are located in different Availability Zones.
If the service returns an enum value that is not available in the current SDK version,
azModewill returnAZMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromazModeAsString().- Returns:
- Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone
or created across multiple Availability Zones.
Valid values:
single-az|cross-az.This option is only supported for Memcached clusters.
You cannot specify
single-azif the Memcached cluster already has cache nodes in different Availability Zones. Ifcross-azis specified, existing Memcached nodes remain in their current Availability Zone.Only newly created nodes are located in different Availability Zones.
- See Also:
AZMode
-
hasNewAvailabilityZones
public final boolean hasNewAvailabilityZones()
For responses, this returns true if the service returned a value for the NewAvailabilityZones 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.
-
newAvailabilityZones
public final List<String> newAvailabilityZones()
This option is only supported on Memcached clusters.
The list of Availability Zones where the new Memcached cache nodes are created.
This parameter is only valid when
NumCacheNodesin the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.Scenarios:
-
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify
NumCacheNodes=5(3 + 2) and optionally specify two Availability Zones for the two new nodes. -
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify
NumCacheNodes=6((3 + 2) + 1) and optionally specify an Availability Zone for the new node. -
Scenario 3: You want to cancel all pending operations. Specify
NumCacheNodes=3to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting
NumCacheNodesto the number of current nodes.If
cross-azis specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.Impact of new add/remove requests upon pending requests
-
Scenario-1
-
Pending Action: Delete
-
New Request: Delete
-
Result: The new delete, pending or immediate, replaces the pending delete.
-
-
Scenario-2
-
Pending Action: Delete
-
New Request: Create
-
Result: The new create, pending or immediate, replaces the pending delete.
-
-
Scenario-3
-
Pending Action: Create
-
New Request: Delete
-
Result: The new delete, pending or immediate, replaces the pending create.
-
-
Scenario-4
-
Pending Action: Create
-
New Request: Create
-
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
-
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
hasNewAvailabilityZones()method.- Returns:
This option is only supported on Memcached clusters.
The list of Availability Zones where the new Memcached cache nodes are created.
This parameter is only valid when
NumCacheNodesin the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.Scenarios:
-
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify
NumCacheNodes=5(3 + 2) and optionally specify two Availability Zones for the two new nodes. -
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify
NumCacheNodes=6((3 + 2) + 1) and optionally specify an Availability Zone for the new node. -
Scenario 3: You want to cancel all pending operations. Specify
NumCacheNodes=3to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting
NumCacheNodesto the number of current nodes.If
cross-azis specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.Impact of new add/remove requests upon pending requests
-
Scenario-1
-
Pending Action: Delete
-
New Request: Delete
-
Result: The new delete, pending or immediate, replaces the pending delete.
-
-
Scenario-2
-
Pending Action: Delete
-
New Request: Create
-
Result: The new create, pending or immediate, replaces the pending delete.
-
-
Scenario-3
-
Pending Action: Create
-
New Request: Delete
-
Result: The new delete, pending or immediate, replaces the pending create.
-
-
Scenario-4
-
Pending Action: Create
-
New Request: Create
-
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
-
-
-
-
hasCacheSecurityGroupNames
public final boolean hasCacheSecurityGroupNames()
For responses, this returns true if the service returned a value for the CacheSecurityGroupNames 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.
-
cacheSecurityGroupNames
public final List<String> cacheSecurityGroupNames()
A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
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
hasCacheSecurityGroupNames()method.- Returns:
- A list of cache security group names to authorize on this cluster. This change is asynchronously applied
as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
-
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()
Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon 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
hasSecurityGroupIds()method.- Returns:
- Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
-
preferredMaintenanceWindow
public final String preferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for
dddare:-
sun -
mon -
tue -
wed -
thu -
fri -
sat
Example:
sun:23:00-mon:01:30- Returns:
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as
a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60
minute period.
Valid values for
dddare:-
sun -
mon -
tue -
wed -
thu -
fri -
sat
Example:
sun:23:00-mon:01:30 -
-
-
notificationTopicArn
public final String notificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
-
cacheParameterGroupName
public final String cacheParameterGroupName()
The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the
ApplyImmediatelyparameter is specified astruefor this request.- Returns:
- The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as
soon as possible for parameters when the
ApplyImmediatelyparameter is specified astruefor this request.
-
notificationTopicStatus
public final String notificationTopicStatus()
The status of the Amazon SNS notification topic. Notifications are sent only if the status is
active.Valid values:
active|inactive- Returns:
- The status of the Amazon SNS notification topic. Notifications are sent only if the status is
active.Valid values:
active|inactive
-
applyImmediately
public final Boolean applyImmediately()
If
true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of thePreferredMaintenanceWindowsetting for the cluster.If
false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.If you perform a
ModifyCacheClusterbefore a pending modification is applied, the pending modification is replaced by the newer modification.Valid values:
true|falseDefault:
false- Returns:
- If
true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of thePreferredMaintenanceWindowsetting for the cluster.If
false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.If you perform a
ModifyCacheClusterbefore a pending modification is applied, the pending modification is replaced by the newer modification.Valid values:
true|falseDefault:
false
-
engine
public final String engine()
The engine type used by the cache cluster. The options are valkey, memcached or redis.
- Returns:
- The engine type used by the cache cluster. The options are valkey, memcached or redis.
-
engineVersion
public final String engineVersion()
The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
- Returns:
- The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
-
autoMinorVersionUpgrade
public final Boolean autoMinorVersionUpgrade()
If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
- Returns:
- If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
-
snapshotRetentionLimit
public final Integer snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set
SnapshotRetentionLimitto 5, a snapshot that was taken today is retained for 5 days before being deleted.If the value of
SnapshotRetentionLimitis set to zero (0), backups are turned off.- Returns:
- The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For
example, if you set
SnapshotRetentionLimitto 5, a snapshot that was taken today is retained for 5 days before being deleted.If the value of
SnapshotRetentionLimitis set to zero (0), backups are turned off.
-
snapshotWindow
public final String snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
- Returns:
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
-
cacheNodeType
public final String cacheNodeType()
A valid cache node type that you want to scale this cluster up to.
- Returns:
- A valid cache node type that you want to scale this cluster up to.
-
authToken
public final String authToken()
Reserved parameter. The password used to access a password protected server. This parameter must be specified with the
auth-token-updateparameter. Password constraints:-
Must be only printable ASCII characters
-
Must be at least 16 characters and no more than 128 characters in length
-
Cannot contain any of the following characters: '/', '"', or '@', '%'
For more information, see AUTH password at AUTH.
- Returns:
- Reserved parameter. The password used to access a password protected server. This parameter must be
specified with the
auth-token-updateparameter. Password constraints:-
Must be only printable ASCII characters
-
Must be at least 16 characters and no more than 128 characters in length
-
Cannot contain any of the following characters: '/', '"', or '@', '%'
For more information, see AUTH password at AUTH.
-
-
-
authTokenUpdateStrategy
public final AuthTokenUpdateStrategyType authTokenUpdateStrategy()
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-tokenparameter. Possible values:-
ROTATE - default, if no update strategy is provided
-
SET - allowed only after ROTATE
-
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with AUTH
If the service returns an enum value that is not available in the current SDK version,
authTokenUpdateStrategywill returnAuthTokenUpdateStrategyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthTokenUpdateStrategyAsString().- Returns:
- Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-tokenparameter. Possible values:-
ROTATE - default, if no update strategy is provided
-
SET - allowed only after ROTATE
-
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with AUTH
-
- See Also:
AuthTokenUpdateStrategyType
-
-
authTokenUpdateStrategyAsString
public final String authTokenUpdateStrategyAsString()
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-tokenparameter. Possible values:-
ROTATE - default, if no update strategy is provided
-
SET - allowed only after ROTATE
-
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with AUTH
If the service returns an enum value that is not available in the current SDK version,
authTokenUpdateStrategywill returnAuthTokenUpdateStrategyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthTokenUpdateStrategyAsString().- Returns:
- Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-tokenparameter. Possible values:-
ROTATE - default, if no update strategy is provided
-
SET - allowed only after ROTATE
-
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with AUTH
-
- See Also:
AuthTokenUpdateStrategyType
-
-
hasLogDeliveryConfigurations
public final boolean hasLogDeliveryConfigurations()
For responses, this returns true if the service returned a value for the LogDeliveryConfigurations 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.
-
logDeliveryConfigurations
public final List<LogDeliveryConfigurationRequest> logDeliveryConfigurations()
Specifies the destination, format and type of the logs.
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
hasLogDeliveryConfigurations()method.- Returns:
- Specifies the destination, format and type of the logs.
-
ipDiscovery
public final IpDiscovery ipDiscovery()
The network type you choose when modifying a cluster, either
ipv4|ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.If the service returns an enum value that is not available in the current SDK version,
ipDiscoverywill returnIpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipDiscoveryAsString().- Returns:
- The network type you choose when modifying a cluster, either
ipv4|ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system. - See Also:
IpDiscovery
-
ipDiscoveryAsString
public final String ipDiscoveryAsString()
The network type you choose when modifying a cluster, either
ipv4|ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.If the service returns an enum value that is not available in the current SDK version,
ipDiscoverywill returnIpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipDiscoveryAsString().- Returns:
- The network type you choose when modifying a cluster, either
ipv4|ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system. - See Also:
IpDiscovery
-
scaleConfig
public final ScaleConfig scaleConfig()
Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.
- Returns:
- Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.
-
toBuilder
public ModifyCacheClusterRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModifyCacheClusterRequest.Builder,ModifyCacheClusterRequest>- Specified by:
toBuilderin classElastiCacheRequest
-
builder
public static ModifyCacheClusterRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyCacheClusterRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-