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

Class ModifyReplicationGroupRequest

    • 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 Valkey or Redis OSS (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 Valkey or Redis OSS (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 flag to indicate MultiAZ is enabled.

        Returns:
        A flag to indicate MultiAZ is enabled.

      • nodeGroupId

        @Deprecated
public final String nodeGroupId()
        Deprecated.

        Deprecated. This parameter is not used.

        Returns:
        Deprecated. This parameter is not used.

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

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

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

        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.

        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

      • engine

        public final String engine()

        Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.

        Returns:
        Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.

      • 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()

         If you are running Valkey or Redis OSS 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. 

        Returns:
         If you are running Valkey or Redis OSS 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. 

      • 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 - 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, 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 - 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-token parameter. 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, 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 - 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

      • hasUserGroupIdsToAdd

        public final boolean hasUserGroupIdsToAdd()
        For responses, this returns true if the service returned a value for the UserGroupIdsToAdd 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.

      • userGroupIdsToAdd

        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.

        Returns:
        The ID of the user group you are associating with the replication group.

      • hasUserGroupIdsToRemove

        public final boolean hasUserGroupIdsToRemove()
        For responses, this returns true if the service returned a value for the UserGroupIdsToRemove 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.

      • userGroupIdsToRemove

        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.

        Returns:
        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.

      • removeUserGroups

        public final Boolean removeUserGroups()

        Removes the user group associated with this replication group.

        Returns:
        Removes the user group associated with this replication group.

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

      • 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 and above 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, ipDiscovery will return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipDiscoveryAsString().

        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 and above 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 and above 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, ipDiscovery will return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipDiscoveryAsString().

        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 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
        See Also:
        IpDiscovery

      • transitEncryptionEnabled

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

        Returns:
        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

        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 Valkey or Redis OSS 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().

        Returns:
        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 Valkey or Redis OSS 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.

        See Also:
        TransitEncryptionMode

      • transitEncryptionModeAsString

        public 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 Valkey or Redis OSS 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().

        Returns:
        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 Valkey or Redis OSS 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.

        See Also:
        TransitEncryptionMode

      • clusterMode

        public 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 Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS 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().

        Returns:
        Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
        See Also:
        ClusterMode

      • clusterModeAsString

        public 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 Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS 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().

        Returns:
        Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
        See Also:
        ClusterMode

      • 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