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:
- Replication
Group stringId Identifier for the replication group.
- Replication
Group stringId Identifier for the replication group.
- replication
Group StringId Identifier for the replication group.
- replication
Group stringId Identifier for the replication group.
- replication_
group_ strid Identifier for the replication group.
- replication
Group StringId Identifier for the replication group.
getReplicationGroup Result
The following output properties are available:
- Arn string
ARN of the created ElastiCache Replication Group.
- Auth
Token boolEnabled Whether an AuthToken (password) is enabled.
- Automatic
Failover boolEnabled A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
- Configuration
Endpoint stringAddress 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.
- Log
Delivery List<GetConfigurations Replication Group Log Delivery Configuration> Redis SLOWLOG or Redis Engine Log delivery settings.
- Member
Clusters List<string> Identifiers of all the nodes that are part of this replication group.
- Multi
Az boolEnabled Whether Multi-AZ Support is enabled for the replication group.
- Node
Type string The cluster node type.
- Num
Cache intClusters The number of cache clusters that the replication group has.
- Num
Node intGroups Number of node groups (shards) for the replication group.
- Number
Cache intClusters (Deprecated use
num_cache_clusters
instead) Number of cache clusters that the replication group has.Use num_cache_clusters instead
- Port int
The port number on which the configuration endpoint will accept connections.
- Primary
Endpoint stringAddress The endpoint of the primary node in this node group (shard).
- Reader
Endpoint stringAddress The endpoint of the reader node in this node group (shard).
- Replicas
Per intNode Group Number of replica nodes in each node group.
- Replication
Group stringDescription (Deprecated use
description
instead) Description of the replication group.Use description instead
- Replication
Group stringId - Snapshot
Retention intLimit The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
- Snapshot
Window 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.
- Auth
Token boolEnabled Whether an AuthToken (password) is enabled.
- Automatic
Failover boolEnabled A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
- Configuration
Endpoint stringAddress 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.
- Log
Delivery []GetConfigurations Replication Group Log Delivery Configuration Redis SLOWLOG or Redis Engine Log delivery settings.
- Member
Clusters []string Identifiers of all the nodes that are part of this replication group.
- Multi
Az boolEnabled Whether Multi-AZ Support is enabled for the replication group.
- Node
Type string The cluster node type.
- Num
Cache intClusters The number of cache clusters that the replication group has.
- Num
Node intGroups Number of node groups (shards) for the replication group.
- Number
Cache intClusters (Deprecated use
num_cache_clusters
instead) Number of cache clusters that the replication group has.Use num_cache_clusters instead
- Port int
The port number on which the configuration endpoint will accept connections.
- Primary
Endpoint stringAddress The endpoint of the primary node in this node group (shard).
- Reader
Endpoint stringAddress The endpoint of the reader node in this node group (shard).
- Replicas
Per intNode Group Number of replica nodes in each node group.
- Replication
Group stringDescription (Deprecated use
description
instead) Description of the replication group.Use description instead
- Replication
Group stringId - Snapshot
Retention intLimit The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
- Snapshot
Window 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.
- auth
Token BooleanEnabled Whether an AuthToken (password) is enabled.
- automatic
Failover BooleanEnabled A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
- configuration
Endpoint StringAddress 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.
- log
Delivery List<GetConfigurations Replication Group Log Delivery Configuration> Redis SLOWLOG or Redis Engine Log delivery settings.
- member
Clusters List<String> Identifiers of all the nodes that are part of this replication group.
- multi
Az BooleanEnabled Whether Multi-AZ Support is enabled for the replication group.
- node
Type String The cluster node type.
- num
Cache IntegerClusters The number of cache clusters that the replication group has.
- num
Node IntegerGroups Number of node groups (shards) for the replication group.
- number
Cache IntegerClusters (Deprecated use
num_cache_clusters
instead) Number of cache clusters that the replication group has.Use num_cache_clusters instead
- port Integer
The port number on which the configuration endpoint will accept connections.
- primary
Endpoint StringAddress The endpoint of the primary node in this node group (shard).
- reader
Endpoint StringAddress The endpoint of the reader node in this node group (shard).
- replicas
Per IntegerNode Group Number of replica nodes in each node group.
- replication
Group StringDescription (Deprecated use
description
instead) Description of the replication group.Use description instead
- replication
Group StringId - snapshot
Retention IntegerLimit The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
- snapshot
Window 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.
- auth
Token booleanEnabled Whether an AuthToken (password) is enabled.
- automatic
Failover booleanEnabled A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
- configuration
Endpoint stringAddress 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.
- log
Delivery GetConfigurations Replication Group Log Delivery Configuration[] Redis SLOWLOG or Redis Engine Log delivery settings.
- member
Clusters string[] Identifiers of all the nodes that are part of this replication group.
- multi
Az booleanEnabled Whether Multi-AZ Support is enabled for the replication group.
- node
Type string The cluster node type.
- num
Cache numberClusters The number of cache clusters that the replication group has.
- num
Node numberGroups Number of node groups (shards) for the replication group.
- number
Cache numberClusters (Deprecated use
num_cache_clusters
instead) Number of cache clusters that the replication group has.Use num_cache_clusters instead
- port number
The port number on which the configuration endpoint will accept connections.
- primary
Endpoint stringAddress The endpoint of the primary node in this node group (shard).
- reader
Endpoint stringAddress The endpoint of the reader node in this node group (shard).
- replicas
Per numberNode Group Number of replica nodes in each node group.
- replication
Group stringDescription (Deprecated use
description
instead) Description of the replication group.Use description instead
- replication
Group stringId - snapshot
Retention numberLimit The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
- snapshot
Window 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_ boolenabled Whether an AuthToken (password) is enabled.
- automatic_
failover_ boolenabled A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
- configuration_
endpoint_ straddress 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_ Sequence[Getconfigurations Replication Group Log Delivery Configuration] 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_ boolenabled Whether Multi-AZ Support is enabled for the replication group.
- node_
type str The cluster node type.
- num_
cache_ intclusters The number of cache clusters that the replication group has.
- num_
node_ intgroups Number of node groups (shards) for the replication group.
- number_
cache_ intclusters (Deprecated use
num_cache_clusters
instead) Number of cache clusters that the replication group has.Use num_cache_clusters instead
- port int
The port number on which the configuration endpoint will accept connections.
- primary_
endpoint_ straddress The endpoint of the primary node in this node group (shard).
- reader_
endpoint_ straddress The endpoint of the reader node in this node group (shard).
- replicas_
per_ intnode_ group Number of replica nodes in each node group.
- replication_
group_ strdescription (Deprecated use
description
instead) Description of the replication group.Use description instead
- replication_
group_ strid - snapshot_
retention_ intlimit 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.
- auth
Token BooleanEnabled Whether an AuthToken (password) is enabled.
- automatic
Failover BooleanEnabled A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
- configuration
Endpoint StringAddress 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.
- log
Delivery List<Property Map>Configurations Redis SLOWLOG or Redis Engine Log delivery settings.
- member
Clusters List<String> Identifiers of all the nodes that are part of this replication group.
- multi
Az BooleanEnabled Whether Multi-AZ Support is enabled for the replication group.
- node
Type String The cluster node type.
- num
Cache NumberClusters The number of cache clusters that the replication group has.
- num
Node NumberGroups Number of node groups (shards) for the replication group.
- number
Cache NumberClusters (Deprecated use
num_cache_clusters
instead) Number of cache clusters that the replication group has.Use num_cache_clusters instead
- port Number
The port number on which the configuration endpoint will accept connections.
- primary
Endpoint StringAddress The endpoint of the primary node in this node group (shard).
- reader
Endpoint StringAddress The endpoint of the reader node in this node group (shard).
- replicas
Per NumberNode Group Number of replica nodes in each node group.
- replication
Group StringDescription (Deprecated use
description
instead) Description of the replication group.Use description instead
- replication
Group StringId - snapshot
Retention NumberLimit The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
- snapshot
Window String Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Supporting Types
GetReplicationGroupLogDeliveryConfiguration
- Destination string
- Destination
Type string - Log
Format string - Log
Type string
- Destination string
- Destination
Type string - Log
Format string - Log
Type string
- destination String
- destination
Type String - log
Format String - log
Type String
- destination string
- destination
Type string - log
Format string - log
Type string
- destination str
- destination_
type str - log_
format str - log_
type str
- destination String
- destination
Type String - log
Format String - log
Type String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.