1. Packages
  2. AWS
  3. API Docs
  4. elasticache
  5. getReplicationGroup
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.elasticache.getReplicationGroup

aws logo
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Use this data source to get information about an ElastiCache Replication Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const bar = aws.elasticache.getReplicationGroup({
    replicationGroupId: "example",
});

    import pulumi
import pulumi_aws as aws

bar = aws.elasticache.get_replication_group(replication_group_id="example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/elasticache"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticache.LookupReplicationGroup(ctx, &elasticache.LookupReplicationGroupArgs{
			ReplicationGroupId: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var bar = Aws.ElastiCache.GetReplicationGroup.Invoke(new()
    {
        ReplicationGroupId = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticache.ElasticacheFunctions;
import com.pulumi.aws.elasticache.inputs.GetReplicationGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var bar = ElasticacheFunctions.getReplicationGroup(GetReplicationGroupArgs.builder()
            .replicationGroupId("example")
            .build());

    }
}

    variables:
  bar:
    fn::invoke:
      function: aws:elasticache:getReplicationGroup
      arguments:
        replicationGroupId: example

    Using getReplicationGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReplicationGroup(args: GetReplicationGroupArgs, opts?: InvokeOptions): Promise<GetReplicationGroupResult>
function getReplicationGroupOutput(args: GetReplicationGroupOutputArgs, opts?: InvokeOptions): Output<GetReplicationGroupResult>
    def get_replication_group(region: Optional[str] = None,
                          replication_group_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetReplicationGroupResult
def get_replication_group_output(region: Optional[pulumi.Input[str]] = None,
                          replication_group_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetReplicationGroupResult]
    func LookupReplicationGroup(ctx *Context, args *LookupReplicationGroupArgs, opts ...InvokeOption) (*LookupReplicationGroupResult, error)
func LookupReplicationGroupOutput(ctx *Context, args *LookupReplicationGroupOutputArgs, opts ...InvokeOption) LookupReplicationGroupResultOutput

    > Note: This function is named LookupReplicationGroup in the Go SDK.

    public static class GetReplicationGroup 
{
    public static Task<GetReplicationGroupResult> InvokeAsync(GetReplicationGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicationGroupResult> Invoke(GetReplicationGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetReplicationGroupResult> getReplicationGroup(GetReplicationGroupArgs args, InvokeOptions options)
public static Output<GetReplicationGroupResult> getReplicationGroup(GetReplicationGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:elasticache/getReplicationGroup:getReplicationGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ReplicationGroupId string
    Identifier for the replication group.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ReplicationGroupId string
    Identifier for the replication group.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    replicationGroupId String
    Identifier for the replication group.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    replicationGroupId string
    Identifier for the replication group.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    replication_group_id str
    Identifier for the replication group.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    replicationGroupId String
    Identifier for the replication group.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    getReplicationGroup Result

    The following output properties are available:

    Arn string
    ARN of the created ElastiCache Replication Group.
    AuthTokenEnabled bool
    Whether an AuthToken (password) is enabled.
    AutomaticFailoverEnabled bool
    Whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
    ClusterMode string
    Whether cluster mode is enabled or disabled.
    ConfigurationEndpointAddress string
    Configuration endpoint address to allow host discovery.
    Description string
    Description of the replication group.
    Id string
    The provider-assigned unique ID for this managed resource.
    LogDeliveryConfigurations List<GetReplicationGroupLogDeliveryConfiguration>
    Redis SLOWLOG or Redis Engine Log delivery settings.
    MemberClusters List<string>
    Identifiers of all the nodes that are part of this replication group.
    MultiAzEnabled bool
    Whether Multi-AZ Support is enabled for the replication group.
    NodeGroupConfigurations List<GetReplicationGroupNodeGroupConfiguration>
    Configuration of the node groups (shards). See below.
    NodeType string
    Cluster node type.
    NumCacheClusters int
    Number of cache clusters that the replication group has.
    NumNodeGroups int
    Number of node groups (shards) for the replication group.
    Port int
    Port number on which the configuration endpoint will accept connections.
    PrimaryEndpointAddress string
    Endpoint of the primary node in this node group (shard).
    ReaderEndpointAddress string
    Endpoint of the reader node in this node group (shard).
    Region string
    ReplicasPerNodeGroup int
    Number of replica nodes in each node group.
    ReplicationGroupId string
    SnapshotRetentionLimit int
    Number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
    SnapshotWindow string
    Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    Arn string
    ARN of the created ElastiCache Replication Group.
    AuthTokenEnabled bool
    Whether an AuthToken (password) is enabled.
    AutomaticFailoverEnabled bool
    Whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
    ClusterMode string
    Whether cluster mode is enabled or disabled.
    ConfigurationEndpointAddress string
    Configuration endpoint address to allow host discovery.
    Description string
    Description of the replication group.
    Id string
    The provider-assigned unique ID for this managed resource.
    LogDeliveryConfigurations []GetReplicationGroupLogDeliveryConfiguration
    Redis SLOWLOG or Redis Engine Log delivery settings.
    MemberClusters []string
    Identifiers of all the nodes that are part of this replication group.
    MultiAzEnabled bool
    Whether Multi-AZ Support is enabled for the replication group.
    NodeGroupConfigurations []GetReplicationGroupNodeGroupConfiguration
    Configuration of the node groups (shards). See below.
    NodeType string
    Cluster node type.
    NumCacheClusters int
    Number of cache clusters that the replication group has.
    NumNodeGroups int
    Number of node groups (shards) for the replication group.
    Port int
    Port number on which the configuration endpoint will accept connections.
    PrimaryEndpointAddress string
    Endpoint of the primary node in this node group (shard).
    ReaderEndpointAddress string
    Endpoint of the reader node in this node group (shard).
    Region string
    ReplicasPerNodeGroup int
    Number of replica nodes in each node group.
    ReplicationGroupId string
    SnapshotRetentionLimit int
    Number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
    SnapshotWindow string
    Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    arn String
    ARN of the created ElastiCache Replication Group.
    authTokenEnabled Boolean
    Whether an AuthToken (password) is enabled.
    automaticFailoverEnabled Boolean
    Whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
    clusterMode String
    Whether cluster mode is enabled or disabled.
    configurationEndpointAddress String
    Configuration endpoint address to allow host discovery.
    description String
    Description of the replication group.
    id String
    The provider-assigned unique ID for this managed resource.
    logDeliveryConfigurations List<GetReplicationGroupLogDeliveryConfiguration>
    Redis SLOWLOG or Redis Engine Log delivery settings.
    memberClusters List<String>
    Identifiers of all the nodes that are part of this replication group.
    multiAzEnabled Boolean
    Whether Multi-AZ Support is enabled for the replication group.
    nodeGroupConfigurations List<GetReplicationGroupNodeGroupConfiguration>
    Configuration of the node groups (shards). See below.
    nodeType String
    Cluster node type.
    numCacheClusters Integer
    Number of cache clusters that the replication group has.
    numNodeGroups Integer
    Number of node groups (shards) for the replication group.
    port Integer
    Port number on which the configuration endpoint will accept connections.
    primaryEndpointAddress String
    Endpoint of the primary node in this node group (shard).
    readerEndpointAddress String
    Endpoint of the reader node in this node group (shard).
    region String
    replicasPerNodeGroup Integer
    Number of replica nodes in each node group.
    replicationGroupId String
    snapshotRetentionLimit Integer
    Number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
    snapshotWindow String
    Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    arn string
    ARN of the created ElastiCache Replication Group.
    authTokenEnabled boolean
    Whether an AuthToken (password) is enabled.
    automaticFailoverEnabled boolean
    Whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
    clusterMode string
    Whether cluster mode is enabled or disabled.
    configurationEndpointAddress string
    Configuration endpoint address to allow host discovery.
    description string
    Description of the replication group.
    id string
    The provider-assigned unique ID for this managed resource.
    logDeliveryConfigurations GetReplicationGroupLogDeliveryConfiguration[]
    Redis SLOWLOG or Redis Engine Log delivery settings.
    memberClusters string[]
    Identifiers of all the nodes that are part of this replication group.
    multiAzEnabled boolean
    Whether Multi-AZ Support is enabled for the replication group.
    nodeGroupConfigurations GetReplicationGroupNodeGroupConfiguration[]
    Configuration of the node groups (shards). See below.
    nodeType string
    Cluster node type.
    numCacheClusters number
    Number of cache clusters that the replication group has.
    numNodeGroups number
    Number of node groups (shards) for the replication group.
    port number
    Port number on which the configuration endpoint will accept connections.
    primaryEndpointAddress string
    Endpoint of the primary node in this node group (shard).
    readerEndpointAddress string
    Endpoint of the reader node in this node group (shard).
    region string
    replicasPerNodeGroup number
    Number of replica nodes in each node group.
    replicationGroupId string
    snapshotRetentionLimit number
    Number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
    snapshotWindow string
    Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    arn str
    ARN of the created ElastiCache Replication Group.
    auth_token_enabled bool
    Whether an AuthToken (password) is enabled.
    automatic_failover_enabled bool
    Whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
    cluster_mode str
    Whether cluster mode is enabled or disabled.
    configuration_endpoint_address str
    Configuration endpoint address to allow host discovery.
    description str
    Description of the replication group.
    id str
    The provider-assigned unique ID for this managed resource.
    log_delivery_configurations Sequence[GetReplicationGroupLogDeliveryConfiguration]
    Redis SLOWLOG or Redis Engine Log delivery settings.
    member_clusters Sequence[str]
    Identifiers of all the nodes that are part of this replication group.
    multi_az_enabled bool
    Whether Multi-AZ Support is enabled for the replication group.
    node_group_configurations Sequence[GetReplicationGroupNodeGroupConfiguration]
    Configuration of the node groups (shards). See below.
    node_type str
    Cluster node type.
    num_cache_clusters int
    Number of cache clusters that the replication group has.
    num_node_groups int
    Number of node groups (shards) for the replication group.
    port int
    Port number on which the configuration endpoint will accept connections.
    primary_endpoint_address str
    Endpoint of the primary node in this node group (shard).
    reader_endpoint_address str
    Endpoint of the reader node in this node group (shard).
    region str
    replicas_per_node_group int
    Number of replica nodes in each node group.
    replication_group_id str
    snapshot_retention_limit int
    Number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
    snapshot_window str
    Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    arn String
    ARN of the created ElastiCache Replication Group.
    authTokenEnabled Boolean
    Whether an AuthToken (password) is enabled.
    automaticFailoverEnabled Boolean
    Whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
    clusterMode String
    Whether cluster mode is enabled or disabled.
    configurationEndpointAddress String
    Configuration endpoint address to allow host discovery.
    description String
    Description of the replication group.
    id String
    The provider-assigned unique ID for this managed resource.
    logDeliveryConfigurations List<Property Map>
    Redis SLOWLOG or Redis Engine Log delivery settings.
    memberClusters List<String>
    Identifiers of all the nodes that are part of this replication group.
    multiAzEnabled Boolean
    Whether Multi-AZ Support is enabled for the replication group.
    nodeGroupConfigurations List<Property Map>
    Configuration of the node groups (shards). See below.
    nodeType String
    Cluster node type.
    numCacheClusters Number
    Number of cache clusters that the replication group has.
    numNodeGroups Number
    Number of node groups (shards) for the replication group.
    port Number
    Port number on which the configuration endpoint will accept connections.
    primaryEndpointAddress String
    Endpoint of the primary node in this node group (shard).
    readerEndpointAddress String
    Endpoint of the reader node in this node group (shard).
    region String
    replicasPerNodeGroup Number
    Number of replica nodes in each node group.
    replicationGroupId String
    snapshotRetentionLimit Number
    Number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
    snapshotWindow String
    Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Supporting Types

    GetReplicationGroupLogDeliveryConfiguration

    Destination string
    DestinationType string
    LogFormat string
    LogType string
    Destination string
    DestinationType string
    LogFormat string
    LogType string
    destination String
    destinationType String
    logFormat String
    logType String
    destination string
    destinationType string
    logFormat string
    logType string
    destination String
    destinationType String
    logFormat String
    logType String

    GetReplicationGroupNodeGroupConfiguration

    NodeGroupId string
    ID of the node group.
    PrimaryAvailabilityZone string
    Availability Zone for the primary node.
    PrimaryOutpostArn string
    Outpost ARN of the primary node.
    ReplicaAvailabilityZones List<string>
    List of Availability Zones for the replica nodes.
    ReplicaCount int
    Number of replica nodes in this node group.
    ReplicaOutpostArns List<string>
    List of outpost ARNs for the replica nodes.
    Slots string
    Keyspace for this node group (shard).
    NodeGroupId string
    ID of the node group.
    PrimaryAvailabilityZone string
    Availability Zone for the primary node.
    PrimaryOutpostArn string
    Outpost ARN of the primary node.
    ReplicaAvailabilityZones []string
    List of Availability Zones for the replica nodes.
    ReplicaCount int
    Number of replica nodes in this node group.
    ReplicaOutpostArns []string
    List of outpost ARNs for the replica nodes.
    Slots string
    Keyspace for this node group (shard).
    nodeGroupId String
    ID of the node group.
    primaryAvailabilityZone String
    Availability Zone for the primary node.
    primaryOutpostArn String
    Outpost ARN of the primary node.
    replicaAvailabilityZones List<String>
    List of Availability Zones for the replica nodes.
    replicaCount Integer
    Number of replica nodes in this node group.
    replicaOutpostArns List<String>
    List of outpost ARNs for the replica nodes.
    slots String
    Keyspace for this node group (shard).
    nodeGroupId string
    ID of the node group.
    primaryAvailabilityZone string
    Availability Zone for the primary node.
    primaryOutpostArn string
    Outpost ARN of the primary node.
    replicaAvailabilityZones string[]
    List of Availability Zones for the replica nodes.
    replicaCount number
    Number of replica nodes in this node group.
    replicaOutpostArns string[]
    List of outpost ARNs for the replica nodes.
    slots string
    Keyspace for this node group (shard).
    node_group_id str
    ID of the node group.
    primary_availability_zone str
    Availability Zone for the primary node.
    primary_outpost_arn str
    Outpost ARN of the primary node.
    replica_availability_zones Sequence[str]
    List of Availability Zones for the replica nodes.
    replica_count int
    Number of replica nodes in this node group.
    replica_outpost_arns Sequence[str]
    List of outpost ARNs for the replica nodes.
    slots str
    Keyspace for this node group (shard).
    nodeGroupId String
    ID of the node group.
    primaryAvailabilityZone String
    Availability Zone for the primary node.
    primaryOutpostArn String
    Outpost ARN of the primary node.
    replicaAvailabilityZones List<String>
    List of Availability Zones for the replica nodes.
    replicaCount Number
    Number of replica nodes in this node group.
    replicaOutpostArns List<String>
    List of outpost ARNs for the replica nodes.
    slots String
    Keyspace for this node group (shard).

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.22.0
    published on Wednesday, Mar 11, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.