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

Interface ReplicationGroup.Builder

    • Method Detail

      • replicationGroupId

        ReplicationGroup.Builder replicationGroupId​(String replicationGroupId)

        The identifier for the replication group.

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

      • description

        ReplicationGroup.Builder description​(String description)

        The user supplied description of the replication group.

        Parameters:
        description - The user supplied description of the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • globalReplicationGroupInfo

        ReplicationGroup.Builder globalReplicationGroupInfo​(GlobalReplicationGroupInfo globalReplicationGroupInfo)

        The name of the Global datastore and role of this replication group in the Global datastore.

        Parameters:
        globalReplicationGroupInfo - The name of the Global datastore and role of this replication group in the Global datastore.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ReplicationGroup.Builder status​(String status)

        The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

        Parameters:
        status - The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pendingModifiedValues

        ReplicationGroup.Builder pendingModifiedValues​(ReplicationGroupPendingModifiedValues pendingModifiedValues)

        A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

        Parameters:
        pendingModifiedValues - A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • memberClusters

        ReplicationGroup.Builder memberClusters​(Collection<String> memberClusters)

        The names of all the cache clusters that are part of this replication group.

        Parameters:
        memberClusters - The names of all the cache clusters that are part of this replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • memberClusters

        ReplicationGroup.Builder memberClusters​(String... memberClusters)

        The names of all the cache clusters that are part of this replication group.

        Parameters:
        memberClusters - The names of all the cache clusters that are part of this replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nodeGroups

        ReplicationGroup.Builder nodeGroups​(Collection<NodeGroup> nodeGroups)

        A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

        Parameters:
        nodeGroups - A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nodeGroups

        ReplicationGroup.Builder nodeGroups​(NodeGroup... nodeGroups)

        A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

        Parameters:
        nodeGroups - A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nodeGroups

        ReplicationGroup.Builder nodeGroups​(Consumer<NodeGroup.Builder>... nodeGroups)

        A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

        This is a convenience method that creates an instance of the NodeGroup.Builder avoiding the need to create one manually via NodeGroup.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #nodeGroups(List).

        Parameters:
        nodeGroups - a consumer that will call methods on NodeGroup.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #nodeGroups(java.util.Collection)

      • snapshottingClusterId

        ReplicationGroup.Builder snapshottingClusterId​(String snapshottingClusterId)

        The cluster ID that is used as the daily snapshot source for the replication group.

        Parameters:
        snapshottingClusterId - The cluster ID that is used as the daily snapshot source for the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • automaticFailover

        ReplicationGroup.Builder automaticFailover​(String automaticFailover)

        Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

        Parameters:
        automaticFailover - Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutomaticFailoverStatus, AutomaticFailoverStatus

      • automaticFailover

        ReplicationGroup.Builder automaticFailover​(AutomaticFailoverStatus automaticFailover)

        Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

        Parameters:
        automaticFailover - Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutomaticFailoverStatus, AutomaticFailoverStatus

      • configurationEndpoint

        ReplicationGroup.Builder configurationEndpoint​(Endpoint configurationEndpoint)

        The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

        Parameters:
        configurationEndpoint - The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotRetentionLimit

        ReplicationGroup.Builder snapshotRetentionLimit​(Integer snapshotRetentionLimit)

        The number of days for which ElastiCache retains automatic cluster 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.

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

        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

        ReplicationGroup.Builder snapshotWindow​(String snapshotWindow)

        The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

        Example: 05:00-09:00

        If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

        This parameter is only valid if the Engine parameter is redis.

        Parameters:
        snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

        Example: 05:00-09:00

        If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

        This parameter is only valid if the Engine parameter is redis.

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

      • clusterEnabled

        ReplicationGroup.Builder clusterEnabled​(Boolean clusterEnabled)

        A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

        Valid values: true | false

        Parameters:
        clusterEnabled - A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

        Valid values: true | false

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

      • cacheNodeType

        ReplicationGroup.Builder cacheNodeType​(String cacheNodeType)

        The name of the compute and memory capacity node type for each node in the replication group.

        Parameters:
        cacheNodeType - The name of the compute and memory capacity node type for each node in the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authTokenEnabled

        ReplicationGroup.Builder authTokenEnabled​(Boolean authTokenEnabled)

        A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

        Default: false

        Parameters:
        authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

        Default: false

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

      • authTokenLastModifiedDate

        ReplicationGroup.Builder authTokenLastModifiedDate​(Instant authTokenLastModifiedDate)

        The date the auth token was last modified

        Parameters:
        authTokenLastModifiedDate - The date the auth token was last modified
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transitEncryptionEnabled

        ReplicationGroup.Builder transitEncryptionEnabled​(Boolean transitEncryptionEnabled)

        A flag that enables in-transit encryption when set to true.

        Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

        Default: false

        Parameters:
        transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.

        Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

        Default: false

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

      • atRestEncryptionEnabled

        ReplicationGroup.Builder atRestEncryptionEnabled​(Boolean atRestEncryptionEnabled)

        A flag that enables encryption at-rest when set to true.

        You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

        Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

        Default: false

        Parameters:
        atRestEncryptionEnabled - A flag that enables encryption at-rest when set to true.

        You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

        Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

        Default: false

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

      • memberClustersOutpostArns

        ReplicationGroup.Builder memberClustersOutpostArns​(Collection<String> memberClustersOutpostArns)

        The outpost ARNs of the replication group's member clusters.

        Parameters:
        memberClustersOutpostArns - The outpost ARNs of the replication group's member clusters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • memberClustersOutpostArns

        ReplicationGroup.Builder memberClustersOutpostArns​(String... memberClustersOutpostArns)

        The outpost ARNs of the replication group's member clusters.

        Parameters:
        memberClustersOutpostArns - The outpost ARNs of the replication group's member clusters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        ReplicationGroup.Builder kmsKeyId​(String kmsKeyId)

        The ID of the KMS key used to encrypt the disk in the cluster.

        Parameters:
        kmsKeyId - The ID of the KMS key used to encrypt the disk in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        ReplicationGroup.Builder arn​(String arn)

        The ARN (Amazon Resource Name) of the replication group.

        Parameters:
        arn - The ARN (Amazon Resource Name) of the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userGroupIds

        ReplicationGroup.Builder userGroupIds​(Collection<String> userGroupIds)

        The ID of the user group associated to the replication group.

        Parameters:
        userGroupIds - The ID of the user group associated to the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userGroupIds

        ReplicationGroup.Builder userGroupIds​(String... userGroupIds)

        The ID of the user group associated to the replication group.

        Parameters:
        userGroupIds - The ID of the user group associated to the replication group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logDeliveryConfigurations

        ReplicationGroup.Builder logDeliveryConfigurations​(Collection<LogDeliveryConfiguration> logDeliveryConfigurations)

        Returns the destination, format and type of the logs.

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

      • logDeliveryConfigurations

        ReplicationGroup.Builder logDeliveryConfigurations​(LogDeliveryConfiguration... logDeliveryConfigurations)

        Returns the destination, format and type of the logs.

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

      • replicationGroupCreateTime

        ReplicationGroup.Builder replicationGroupCreateTime​(Instant replicationGroupCreateTime)

        The date and time when the cluster was created.

        Parameters:
        replicationGroupCreateTime - The date and time when the cluster was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataTiering

        ReplicationGroup.Builder dataTiering​(String dataTiering)

        Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

        Parameters:
        dataTiering - Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataTieringStatus, DataTieringStatus

      • dataTiering

        ReplicationGroup.Builder dataTiering​(DataTieringStatus dataTiering)

        Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

        Parameters:
        dataTiering - Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataTieringStatus, DataTieringStatus

      • autoMinorVersionUpgrade

        ReplicationGroup.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, 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 Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, 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.

      • networkType

        ReplicationGroup.Builder networkType​(String networkType)

        Must be either ipv4 | ipv6 | dual_stack. 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.

        Parameters:
        networkType - Must be either ipv4 | ipv6 | dual_stack. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NetworkType, NetworkType

      • networkType

        ReplicationGroup.Builder networkType​(NetworkType networkType)

        Must be either ipv4 | ipv6 | dual_stack. 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.

        Parameters:
        networkType - Must be either ipv4 | ipv6 | dual_stack. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NetworkType, NetworkType

      • ipDiscovery

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

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

      • ipDiscovery

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

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

      • transitEncryptionMode

        ReplicationGroup.Builder transitEncryptionMode​(String transitEncryptionMode)

        A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

        Parameters:
        transitEncryptionMode - A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransitEncryptionMode, TransitEncryptionMode

      • transitEncryptionMode

        ReplicationGroup.Builder transitEncryptionMode​(TransitEncryptionMode transitEncryptionMode)

        A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

        Parameters:
        transitEncryptionMode - A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransitEncryptionMode, TransitEncryptionMode

      • clusterMode

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

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

      • clusterMode

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

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

      • engine

        ReplicationGroup.Builder engine​(String engine)

        The engine used in a replication group. The options are redis, memcached or valkey.

        Parameters:
        engine - The engine used in a replication group. The options are redis, memcached or valkey.
        Returns:
        Returns a reference to this object so that method calls can be chained together.