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

Interface ModifyReplicationGroupRequest.Builder

    • Method Detail

      • replicationGroupId

        ModifyReplicationGroupRequest.Builder replicationGroupId​(String replicationGroupId)

        The identifier of the replication group to modify.

        Parameters:
        replicationGroupId - The identifier of the replication group to modify.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationGroupDescription

        ModifyReplicationGroupRequest.Builder replicationGroupDescription​(String replicationGroupDescription)

        A description for the replication group. Maximum length is 255 characters.

        Parameters:
        replicationGroupDescription - A description for the replication group. Maximum length is 255 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • primaryClusterId

        ModifyReplicationGroupRequest.Builder primaryClusterId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • snapshottingClusterId

        ModifyReplicationGroupRequest.Builder snapshottingClusterId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • automaticFailoverEnabled

        ModifyReplicationGroupRequest.Builder automaticFailoverEnabled​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • multiAZEnabled

        ModifyReplicationGroupRequest.Builder multiAZEnabled​(Boolean multiAZEnabled)

        A flag to indicate MultiAZ is enabled.

        Parameters:
        multiAZEnabled - A flag to indicate MultiAZ is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nodeGroupId

        @Deprecated
ModifyReplicationGroupRequest.Builder nodeGroupId​(String nodeGroupId)
        Deprecated.

        Deprecated. This parameter is not used.

        Parameters:
        nodeGroupId - Deprecated. This parameter is not used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cacheSecurityGroupNames

        ModifyReplicationGroupRequest.Builder cacheSecurityGroupNames​(Collection<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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cacheSecurityGroupNames

        ModifyReplicationGroupRequest.Builder cacheSecurityGroupNames​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        ModifyReplicationGroupRequest.Builder securityGroupIds​(Collection<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).

        Parameters:
        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).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        ModifyReplicationGroupRequest.Builder securityGroupIds​(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).

        Parameters:
        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).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        ModifyReplicationGroupRequest.Builder preferredMaintenanceWindow​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • notificationTopicArn

        ModifyReplicationGroupRequest.Builder notificationTopicArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • cacheParameterGroupName

        ModifyReplicationGroupRequest.Builder cacheParameterGroupName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • notificationTopicStatus

        ModifyReplicationGroupRequest.Builder notificationTopicStatus​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • applyImmediately

        ModifyReplicationGroupRequest.Builder applyImmediately​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        ModifyReplicationGroupRequest.Builder engineVersion​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • autoMinorVersionUpgrade

        ModifyReplicationGroupRequest.Builder autoMinorVersionUpgrade​(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. 

        Parameters:
        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. 
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotRetentionLimit

        ModifyReplicationGroupRequest.Builder snapshotRetentionLimit​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotWindow

        ModifyReplicationGroupRequest.Builder snapshotWindow​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • cacheNodeType

        ModifyReplicationGroupRequest.Builder cacheNodeType​(String cacheNodeType)

        A valid cache node type that you want to scale this replication group to.

        Parameters:
        cacheNodeType - A valid cache node type that you want to scale this replication group to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authToken

        ModifyReplicationGroupRequest.Builder authToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • userGroupIdsToAdd

        ModifyReplicationGroupRequest.Builder userGroupIdsToAdd​(Collection<String> userGroupIdsToAdd)

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

        Parameters:
        userGroupIdsToAdd - The ID of the user group you are associating with the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userGroupIdsToAdd

        ModifyReplicationGroupRequest.Builder userGroupIdsToAdd​(String... userGroupIdsToAdd)

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

        Parameters:
        userGroupIdsToAdd - The ID of the user group you are associating with the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userGroupIdsToRemove

        ModifyReplicationGroupRequest.Builder userGroupIdsToRemove​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userGroupIdsToRemove

        ModifyReplicationGroupRequest.Builder userGroupIdsToRemove​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • removeUserGroups

        ModifyReplicationGroupRequest.Builder removeUserGroups​(Boolean removeUserGroups)

        Removes the user group associated with this replication group.

        Parameters:
        removeUserGroups - Removes the user group associated with this replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logDeliveryConfigurations

        ModifyReplicationGroupRequest.Builder logDeliveryConfigurations​(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)

        Specifies the destination, format and type of the logs.

        Parameters:
        logDeliveryConfigurations - Specifies the destination, format and type of the logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logDeliveryConfigurations

        ModifyReplicationGroupRequest.Builder logDeliveryConfigurations​(LogDeliveryConfigurationRequest... logDeliveryConfigurations)

        Specifies the destination, format and type of the logs.

        Parameters:
        logDeliveryConfigurations - Specifies the destination, format and type of the logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipDiscovery

        ModifyReplicationGroupRequest.Builder ipDiscovery​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpDiscovery, IpDiscovery

      • ipDiscovery

        ModifyReplicationGroupRequest.Builder ipDiscovery​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IpDiscovery, IpDiscovery

      • transitEncryptionEnabled

        ModifyReplicationGroupRequest.Builder transitEncryptionEnabled​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • transitEncryptionMode

        ModifyReplicationGroupRequest.Builder transitEncryptionMode​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransitEncryptionMode, TransitEncryptionMode

      • transitEncryptionMode

        ModifyReplicationGroupRequest.Builder transitEncryptionMode​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransitEncryptionMode, TransitEncryptionMode

      • clusterMode

        ModifyReplicationGroupRequest.Builder clusterMode​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterMode, ClusterMode

      • clusterMode

        ModifyReplicationGroupRequest.Builder clusterMode​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterMode, ClusterMode