GetReplicationGroup

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var bar = Output.Create(Aws.ElastiCache.GetReplicationGroup.InvokeAsync(new Aws.ElastiCache.GetReplicationGroupArgs
        {
            ReplicationGroupId = "example",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/elasticache"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}

import pulumi
import pulumi_aws as aws

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

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

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

Using GetReplicationGroup

function getReplicationGroup(args: GetReplicationGroupArgs, opts?: InvokeOptions): Promise<GetReplicationGroupResult>

function  get_replication_group(replication_group_id=None, opts=None)

func LookupReplicationGroup(ctx *Context, args *LookupReplicationGroupArgs, opts ...InvokeOption) (*LookupReplicationGroupResult, error)

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

public static class GetReplicationGroup {
    public static Task<GetReplicationGroupResult> InvokeAsync(GetReplicationGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ReplicationGroupId string: The identifier for the replication group.

ReplicationGroupId string: The identifier for the replication group.

replicationGroupId string: The identifier for the replication group.

replication_group_id str: The identifier for the replication group.

GetReplicationGroup Result

The following output properties are available:

AuthTokenEnabled bool: A flag that enables using an AuthToken (password) when issuing Redis commands.
AutomaticFailoverEnabled bool: A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
ConfigurationEndpointAddress string: The configuration endpoint address to allow host discovery.
Id string: The provider-assigned unique ID for this managed resource.
MemberClusters List<string>: The identifiers of all the nodes that are part of this replication group.
NodeType string: The cluster node type.
NumberCacheClusters int: The number of cache clusters that the replication group has.
Port int: The port number on which the configuration endpoint will accept connections.
PrimaryEndpointAddress string: The endpoint of the primary node in this node group (shard).
ReplicationGroupDescription string: The description of the replication group.
ReplicationGroupId string: The identifier for the replication group.
SnapshotRetentionLimit int: The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
SnapshotWindow string: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

AuthTokenEnabled bool: A flag that enables using an AuthToken (password) when issuing Redis commands.
AutomaticFailoverEnabled bool: A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
ConfigurationEndpointAddress string: The configuration endpoint address to allow host discovery.
Id string: The provider-assigned unique ID for this managed resource.
MemberClusters []string: The identifiers of all the nodes that are part of this replication group.
NodeType string: The cluster node type.
NumberCacheClusters int: The number of cache clusters that the replication group has.
Port int: The port number on which the configuration endpoint will accept connections.
PrimaryEndpointAddress string: The endpoint of the primary node in this node group (shard).
ReplicationGroupDescription string: The description of the replication group.
ReplicationGroupId string: The identifier for the replication group.
SnapshotRetentionLimit int: The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
SnapshotWindow string: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

authTokenEnabled boolean: A flag that enables using an AuthToken (password) when issuing Redis commands.
automaticFailoverEnabled boolean: A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
configurationEndpointAddress string: The configuration endpoint address to allow host discovery.
id string: The provider-assigned unique ID for this managed resource.
memberClusters string[]: The identifiers of all the nodes that are part of this replication group.
nodeType string: The cluster node type.
numberCacheClusters number: The number of cache clusters that the replication group has.
port number: The port number on which the configuration endpoint will accept connections.
primaryEndpointAddress string: The endpoint of the primary node in this node group (shard).
replicationGroupDescription string: The description of the replication group.
replicationGroupId string: The identifier for the replication group.
snapshotRetentionLimit number: The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
snapshotWindow string: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

auth_token_enabled bool: A flag that enables using an AuthToken (password) when issuing Redis commands.
automatic_failover_enabled bool: A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
configuration_endpoint_address str: The configuration endpoint address to allow host discovery.
id str: The provider-assigned unique ID for this managed resource.
member_clusters List[str]: The identifiers of all the nodes that are part of this replication group.
node_type str: The cluster node type.
number_cache_clusters float: The number of cache clusters that the replication group has.
port float: The port number on which the configuration endpoint will accept connections.
primary_endpoint_address str: The endpoint of the primary node in this node group (shard).
replication_group_description str: The description of the replication group.
replication_group_id str: The identifier for the replication group.
snapshot_retention_limit float: The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
snapshot_window str: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetReplicationGroup

Example Usage

Using GetReplicationGroup

GetReplicationGroup Result

Package Details

On This Page