ModifyReplicationGroupRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>

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

Represents the input of a ModifyReplicationGroups operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifyReplicationGroupRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModifyReplicationGroupRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` This parameter is currently disabled.
`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.
`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()` Returns true if the CacheSecurityGroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLogDeliveryConfigurations()` Returns true if the LogDeliveryConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSecurityGroupIds()` Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserGroupIdsToAdd()` Returns true if the UserGroupIdsToAdd property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserGroupIdsToRemove()` Returns true if the UserGroupIdsToRemove property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<LogDeliveryConfigurationRequest>`	`logDeliveryConfigurations()` Specifies the destination, format and type of the logs.
`Boolean`	`multiAZEnabled()` A list of tags to be added to this resource.
`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 groups that can access 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.
`List<String>`	`userGroupIdsToAdd()` The user group you are associating with the replication group.
`List<String>`	`userGroupIdsToRemove()` The user group to remove, meaning the users in the group no longer can access the replication group.

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
  - replicationGroupId
```
public final String replicationGroupId()
```
    The identifier of the replication group to modify.
    
    Returns:
    
    The identifier of the replication group to modify.
  - replicationGroupDescription
```
public final String replicationGroupDescription()
```
    A description for the replication group. Maximum length is 255 characters.
    
    Returns:
    
    A description for the replication group. Maximum length is 255 characters.
  - primaryClusterId
```
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.
    
    Returns:
    
    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.
  - snapshottingClusterId
```
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.
    
    Returns:
    
    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.
  - automaticFailoverEnabled
```
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
    
    Returns:
    
    Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
    
    Valid values: true | false
  - multiAZEnabled
```
public final Boolean multiAZEnabled()
```
    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
    
    Returns:
    
    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
  - nodeGroupId
```
public final String nodeGroupId()
```
    Deprecated. This parameter is not used.
    
    Returns:
    
    Deprecated. This parameter is not used.
  - hasCacheSecurityGroupNames
```
public final boolean hasCacheSecurityGroupNames()
```
    Returns true if the CacheSecurityGroupNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - cacheSecurityGroupNames
```
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.
    
    You can use hasCacheSecurityGroupNames() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroupIds
```
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.
    
    You can use hasSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    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).
  - 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 ddd are:
    - 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 ddd are:
    
    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 replication group 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 replication group owner.
  - cacheParameterGroupName
```
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.
    
    Returns:
    
    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.
  - notificationTopicStatus
```
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
    
    Returns:
    
    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
  - 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 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
    
    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 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
  - engineVersion
```
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.
    
    Returns:
    
    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.
  - autoMinorVersionUpgrade
```
public final Boolean autoMinorVersionUpgrade()
```
    This parameter is currently disabled.
    
    Returns:
    
    This parameter is currently disabled.
  - snapshotRetentionLimit
```
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.
    
    Returns:
    
    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.
  - snapshotWindow
```
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.
    
    Returns:
    
    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.
  - cacheNodeType
```
public final String cacheNodeType()
```
    A valid cache node type that you want to scale this replication group to.
    
    Returns:
    
    A valid cache node type that you want to scale this replication group 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-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.
    Returns:
    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.
  - authTokenUpdateStrategy
```
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().
    Returns:
    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
    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-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().
    Returns:
    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
    See Also:
    
    AuthTokenUpdateStrategyType
  - hasUserGroupIdsToAdd
```
public final boolean hasUserGroupIdsToAdd()
```
    Returns true if the UserGroupIdsToAdd property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userGroupIdsToAdd
```
public final List<String> userGroupIdsToAdd()
```
    The user group you are associating with the replication group.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserGroupIdsToAdd() to see if a value was sent in this field.
    
    Returns:
    
    The user group you are associating with the replication group.
  - hasUserGroupIdsToRemove
```
public final boolean hasUserGroupIdsToRemove()
```
    Returns true if the UserGroupIdsToRemove property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userGroupIdsToRemove
```
public final List<String> userGroupIdsToRemove()
```
    The user group to remove, 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.
    
    You can use hasUserGroupIdsToRemove() to see if a value was sent in this field.
    
    Returns:
    
    The user group to remove, meaning the users in the group no longer can access the replication group.
  - removeUserGroups
```
public final Boolean removeUserGroups()
```
    Removes the user groups that can access this replication group.
    
    Returns:
    
    Removes the user groups that can access this replication group.
  - hasLogDeliveryConfigurations
```
public final boolean hasLogDeliveryConfigurations()
```
    Returns true if the LogDeliveryConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasLogDeliveryConfigurations() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the destination, format and type of the logs.
  - toBuilder
```
public ModifyReplicationGroupRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>
    
    Specified by:
    
    toBuilder in class ElastiCacheRequest
  - builder
```
public static ModifyReplicationGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyReplicationGroupRequest.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

Class ModifyReplicationGroupRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

replicationGroupId

replicationGroupDescription

primaryClusterId

snapshottingClusterId

automaticFailoverEnabled

multiAZEnabled

nodeGroupId

hasCacheSecurityGroupNames

cacheSecurityGroupNames

hasSecurityGroupIds

securityGroupIds

preferredMaintenanceWindow

notificationTopicArn

cacheParameterGroupName

notificationTopicStatus

applyImmediately

engineVersion

autoMinorVersionUpgrade

snapshotRetentionLimit

snapshotWindow

cacheNodeType

authToken

authTokenUpdateStrategy

authTokenUpdateStrategyAsString

hasUserGroupIdsToAdd

userGroupIdsToAdd

hasUserGroupIdsToRemove

userGroupIdsToRemove

removeUserGroups

hasLogDeliveryConfigurations

logDeliveryConfigurations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields