@Generated(value="software.amazon.awssdk:codegen") public final class ModifyReplicationGroupRequest extends ElastiCacheRequest implements ToCopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>
Represents the input of a ModifyReplicationGroups operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ModifyReplicationGroupRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
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 the PreferredMaintenanceWindow
setting for the replication group. |
String |
authToken()
Reserved parameter.
|
AuthTokenUpdateStrategyType |
authTokenUpdateStrategy()
Specifies the strategy to use to update the AUTH token.
|
String |
authTokenUpdateStrategyAsString()
Specifies the strategy to use to update the AUTH token.
|
Boolean |
automaticFailoverEnabled()
Determines whether a read replica is automatically promoted to read/write primary if the existing primary
encounters a failure.
|
Boolean |
autoMinorVersionUpgrade()
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the
next auto minor version upgrade campaign.
|
static ModifyReplicationGroupRequest.Builder |
builder() |
String |
cacheNodeType()
A valid cache node type that you want to scale this replication group to.
|
String |
cacheParameterGroupName()
The name of the cache parameter group to apply to all of the clusters in this replication group.
|
List<String> |
cacheSecurityGroupNames()
A list of cache security group names to authorize for the clusters in this replication group.
|
ClusterMode |
clusterMode()
Enabled or Disabled.
|
String |
clusterModeAsString()
Enabled or Disabled.
|
String |
engineVersion()
The upgraded version of the cache engine to be run on the clusters in the replication group.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCacheSecurityGroupNames()
For responses, this returns true if the service returned a value for the CacheSecurityGroupNames property.
|
int |
hashCode() |
boolean |
hasLogDeliveryConfigurations()
For responses, this returns true if the service returned a value for the LogDeliveryConfigurations property.
|
boolean |
hasSecurityGroupIds()
For responses, this returns true if the service returned a value for the SecurityGroupIds property.
|
boolean |
hasUserGroupIdsToAdd()
For responses, this returns true if the service returned a value for the UserGroupIdsToAdd property.
|
boolean |
hasUserGroupIdsToRemove()
For responses, this returns true if the service returned a value for the UserGroupIdsToRemove property.
|
IpDiscovery |
ipDiscovery()
The network type you choose when modifying a cluster, either
ipv4 | ipv6. |
String |
ipDiscoveryAsString()
The network type you choose when modifying a cluster, either
ipv4 | ipv6. |
List<LogDeliveryConfigurationRequest> |
logDeliveryConfigurations()
Specifies the destination, format and type of the logs.
|
Boolean |
multiAZEnabled()
A flag to indicate MultiAZ is enabled.
|
String |
nodeGroupId()
Deprecated.
|
String |
notificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
|
String |
notificationTopicStatus()
The status of the Amazon SNS notification topic for the replication group.
|
String |
preferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
primaryClusterId()
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified
cluster in the specified replication group to the primary role.
|
Boolean |
removeUserGroups()
Removes the user group associated with this replication group.
|
String |
replicationGroupDescription()
A description for the replication group.
|
String |
replicationGroupId()
The identifier of the replication group to modify.
|
List<SdkField<?>> |
sdkFields() |
List<String> |
securityGroupIds()
Specifies the VPC Security Groups associated with the clusters in the replication group.
|
static Class<? extends ModifyReplicationGroupRequest.Builder> |
serializableBuilderClass() |
Integer |
snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.
|
String |
snapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group.
|
String |
snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard)
specified by
SnapshottingClusterId. |
ModifyReplicationGroupRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
transitEncryptionEnabled()
A flag that enables in-transit encryption when set to true.
|
TransitEncryptionMode |
transitEncryptionMode()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
|
String |
transitEncryptionModeAsString()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
|
List<String> |
userGroupIdsToAdd()
The ID of the user group you are associating with the replication group.
|
List<String> |
userGroupIdsToRemove()
The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can
access the replication group.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String replicationGroupId()
The identifier of the replication group to modify.
public final String replicationGroupDescription()
A description for the replication group. Maximum length is 255 characters.
public final String primaryClusterId()
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
public final String snapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
public final Boolean automaticFailoverEnabled()
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
Valid values: true | false
public final Boolean multiAZEnabled()
A flag to indicate MultiAZ is enabled.
@Deprecated public final String nodeGroupId()
Deprecated. This parameter is not used.
public final boolean hasCacheSecurityGroupNames()
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.public final List<String> cacheSecurityGroupNames()
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing clusters running 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.
This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
public final boolean hasSecurityGroupIds()
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.public final List<String> securityGroupIds()
Specifies the VPC Security Groups associated with the clusters in the replication group.
This parameter can be used only with replication group containing clusters running 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.
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
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 ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
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 replication group owner.
The Amazon SNS topic owner must be same as the replication group owner.
public final String cacheParameterGroupName()
The name of the cache parameter group to apply to all of the clusters in this replication group. This change is
asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is
specified as true for this request.
ApplyImmediately parameter is specified as true for this request.public final String notificationTopicStatus()
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the
status is active.
Valid values: active | inactive
active.
Valid values: active | inactive
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 the PreferredMaintenanceWindow
setting for the replication group.
If false, changes to the nodes in the replication group are applied on the next maintenance reboot,
or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
true, this parameter causes the modifications in this request and any pending
modifications to be applied, asynchronously and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group.
If false, changes to the nodes in the replication group are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
public final String engineVersion()
The upgraded version of the cache engine to be run on the clusters in the replication group.
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 replication group and create it anew with the earlier engine version.
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 replication group and create it anew with the earlier engine version.
public final Boolean autoMinorVersionUpgrade()
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
public final Integer snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For
example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5
days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotRetentionLimit to 5, a snapshot that was taken today
is retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public final String snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard)
specified by SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
public final String cacheNodeType()
A valid cache node type that you want to scale this replication group to.
public final String authToken()
Reserved parameter. The password used to access a password protected server. This parameter must be specified
with the auth-token-update-strategy parameter. 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.
auth-token-update-strategy parameter. 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.
public final AuthTokenUpdateStrategyType authTokenUpdateStrategy()
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
If the service returns an enum value that is not available in the current SDK version,
authTokenUpdateStrategy will return AuthTokenUpdateStrategyType.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from authTokenUpdateStrategyAsString().
auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
AuthTokenUpdateStrategyTypepublic final String authTokenUpdateStrategyAsString()
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
If the service returns an enum value that is not available in the current SDK version,
authTokenUpdateStrategy will return AuthTokenUpdateStrategyType.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from authTokenUpdateStrategyAsString().
auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
AuthTokenUpdateStrategyTypepublic final boolean hasUserGroupIdsToAdd()
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.public final List<String> userGroupIdsToAdd()
The ID of the user group you are associating with the replication group.
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 hasUserGroupIdsToAdd() method.
public final boolean hasUserGroupIdsToRemove()
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.public final List<String> userGroupIdsToRemove()
The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.
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 hasUserGroupIdsToRemove() method.
public final Boolean removeUserGroups()
Removes the user group associated with this replication group.
public final boolean hasLogDeliveryConfigurations()
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.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.
public final IpDiscovery ipDiscovery()
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is
supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances
built on the Nitro system.
If the service returns an enum value that is not available in the current SDK version, ipDiscovery will
return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
ipDiscoveryAsString().
ipv4 | ipv6. IPv6
is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all
instances built on the Nitro system.IpDiscoverypublic final String ipDiscoveryAsString()
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is
supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances
built on the Nitro system.
If the service returns an enum value that is not available in the current SDK version, ipDiscovery will
return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
ipDiscoveryAsString().
ipv4 | ipv6. IPv6
is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all
instances built on the Nitro system.IpDiscoverypublic final Boolean transitEncryptionEnabled()
A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an
existing cluster, you must also set TransitEncryptionMode to preferred.
TransitEncryptionMode to preferred.public final TransitEncryptionMode transitEncryptionMode()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
You must set TransitEncryptionEnabled to true, for your existing cluster, and set
TransitEncryptionMode to preferred in the same request to allow both encrypted and
unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections
you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to
first set the TransitEncryptionMode to preferred, after that you can set
TransitEncryptionMode to required.
If the service returns an enum value that is not available in the current SDK version,
transitEncryptionMode will return TransitEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from transitEncryptionModeAsString().
You must set TransitEncryptionEnabled to true, for your existing cluster, and
set TransitEncryptionMode to preferred in the same request to allow both
encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use
encrypted connections you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires
you to first set the TransitEncryptionMode to preferred, after that you can set
TransitEncryptionMode to required.
TransitEncryptionModepublic final String transitEncryptionModeAsString()
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
You must set TransitEncryptionEnabled to true, for your existing cluster, and set
TransitEncryptionMode to preferred in the same request to allow both encrypted and
unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections
you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to
first set the TransitEncryptionMode to preferred, after that you can set
TransitEncryptionMode to required.
If the service returns an enum value that is not available in the current SDK version,
transitEncryptionMode will return TransitEncryptionMode.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from transitEncryptionModeAsString().
You must set TransitEncryptionEnabled to true, for your existing cluster, and
set TransitEncryptionMode to preferred in the same request to allow both
encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use
encrypted connections you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires
you to first set the TransitEncryptionMode to preferred, after that you can set
TransitEncryptionMode to required.
TransitEncryptionModepublic final ClusterMode clusterMode()
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
If the service returns an enum value that is not available in the current SDK version, clusterMode will
return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
clusterModeAsString().
ClusterModepublic final String clusterModeAsString()
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
If the service returns an enum value that is not available in the current SDK version, clusterMode will
return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
clusterModeAsString().
ClusterModepublic ModifyReplicationGroupRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>toBuilder in class ElastiCacheRequestpublic static ModifyReplicationGroupRequest.Builder builder()
public static Class<? extends ModifyReplicationGroupRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.