aws logo
AWS Classic v5.29.0, Feb 1 23

aws.elasticache.getReplicationGroup

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

Example Usage

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

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

});
package main

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

    }
}
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 = aws.elasticache.getReplicationGroup({
    replicationGroupId: "example",
});
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(replication_group_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetReplicationGroupResult
def get_replication_group_output(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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws:elasticache/getReplicationGroup:getReplicationGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

ReplicationGroupId string

Identifier for the replication group.

ReplicationGroupId string

Identifier for the replication group.

replicationGroupId String

Identifier for the replication group.

replicationGroupId string

Identifier for the replication group.

replication_group_id str

Identifier for the replication group.

replicationGroupId String

Identifier for the replication group.

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

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.

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.

NodeType string

The cluster node type.

NumCacheClusters int

The number of cache clusters that the replication group has.

NumNodeGroups int

Number of node groups (shards) for the replication group.

NumberCacheClusters int

(Deprecated use num_cache_clusters instead) Number of cache clusters that the replication group has.

Deprecated:

Use num_cache_clusters instead

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

ReaderEndpointAddress string

The endpoint of the reader node in this node group (shard).

ReplicasPerNodeGroup int

Number of replica nodes in each node group.

ReplicationGroupDescription string

(Deprecated use description instead) Description of the replication group.

Deprecated:

Use description instead

ReplicationGroupId string
SnapshotRetentionLimit int

The 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

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.

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.

NodeType string

The cluster node type.

NumCacheClusters int

The number of cache clusters that the replication group has.

NumNodeGroups int

Number of node groups (shards) for the replication group.

NumberCacheClusters int

(Deprecated use num_cache_clusters instead) Number of cache clusters that the replication group has.

Deprecated:

Use num_cache_clusters instead

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

ReaderEndpointAddress string

The endpoint of the reader node in this node group (shard).

ReplicasPerNodeGroup int

Number of replica nodes in each node group.

ReplicationGroupDescription string

(Deprecated use description instead) Description of the replication group.

Deprecated:

Use description instead

ReplicationGroupId string
SnapshotRetentionLimit int

The 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

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.

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.

nodeType String

The cluster node type.

numCacheClusters Integer

The number of cache clusters that the replication group has.

numNodeGroups Integer

Number of node groups (shards) for the replication group.

numberCacheClusters Integer

(Deprecated use num_cache_clusters instead) Number of cache clusters that the replication group has.

Deprecated:

Use num_cache_clusters instead

port Integer

The port number on which the configuration endpoint will accept connections.

primaryEndpointAddress String

The endpoint of the primary node in this node group (shard).

readerEndpointAddress String

The endpoint of the reader node in this node group (shard).

replicasPerNodeGroup Integer

Number of replica nodes in each node group.

replicationGroupDescription String

(Deprecated use description instead) Description of the replication group.

Deprecated:

Use description instead

replicationGroupId String
snapshotRetentionLimit Integer

The 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

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.

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.

nodeType string

The cluster node type.

numCacheClusters number

The number of cache clusters that the replication group has.

numNodeGroups number

Number of node groups (shards) for the replication group.

numberCacheClusters number

(Deprecated use num_cache_clusters instead) Number of cache clusters that the replication group has.

Deprecated:

Use num_cache_clusters instead

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

readerEndpointAddress string

The endpoint of the reader node in this node group (shard).

replicasPerNodeGroup number

Number of replica nodes in each node group.

replicationGroupDescription string

(Deprecated use description instead) Description of the replication group.

Deprecated:

Use description instead

replicationGroupId string
snapshotRetentionLimit number

The 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

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.

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_type str

The cluster node type.

num_cache_clusters int

The number of cache clusters that the replication group has.

num_node_groups int

Number of node groups (shards) for the replication group.

number_cache_clusters int

(Deprecated use num_cache_clusters instead) Number of cache clusters that the replication group has.

Deprecated:

Use num_cache_clusters instead

port int

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

reader_endpoint_address str

The endpoint of the reader node in this node group (shard).

replicas_per_node_group int

Number of replica nodes in each node group.

replication_group_description str

(Deprecated use description instead) Description of the replication group.

Deprecated:

Use description instead

replication_group_id str
snapshot_retention_limit int

The 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

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.

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.

nodeType String

The cluster node type.

numCacheClusters Number

The number of cache clusters that the replication group has.

numNodeGroups Number

Number of node groups (shards) for the replication group.

numberCacheClusters Number

(Deprecated use num_cache_clusters instead) Number of cache clusters that the replication group has.

Deprecated:

Use num_cache_clusters instead

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

readerEndpointAddress String

The endpoint of the reader node in this node group (shard).

replicasPerNodeGroup Number

Number of replica nodes in each node group.

replicationGroupDescription String

(Deprecated use description instead) Description of the replication group.

Deprecated:

Use description instead

replicationGroupId String
snapshotRetentionLimit Number

The 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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.