@pulumi/aws/elasticache/getReplicationGroup.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get information about an ElastiCache Replication Group.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const bar = aws.elasticache.getReplicationGroup({
 *     replicationGroupId: "example",
 * });
 * ```
 */
export declare function getReplicationGroup(args: GetReplicationGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetReplicationGroupResult>;
/**
 * A collection of arguments for invoking getReplicationGroup.
 */
export interface GetReplicationGroupArgs {
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Identifier for the replication group.
     */
    replicationGroupId: string;
}
/**
 * A collection of values returned by getReplicationGroup.
 */
export interface GetReplicationGroupResult {
    /**
     * ARN of the created ElastiCache Replication Group.
     */
    readonly arn: string;
    /**
     * Whether an AuthToken (password) is enabled.
     */
    readonly authTokenEnabled: boolean;
    /**
     * Whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
     */
    readonly automaticFailoverEnabled: boolean;
    /**
     * Whether cluster mode is enabled or disabled.
     */
    readonly clusterMode: string;
    /**
     * Configuration endpoint address to allow host discovery.
     */
    readonly configurationEndpointAddress: string;
    /**
     * Description of the replication group.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log) delivery settings.
     */
    readonly logDeliveryConfigurations: outputs.elasticache.GetReplicationGroupLogDeliveryConfiguration[];
    /**
     * Identifiers of all the nodes that are part of this replication group.
     */
    readonly memberClusters: string[];
    /**
     * Whether Multi-AZ Support is enabled for the replication group.
     */
    readonly multiAzEnabled: boolean;
    /**
     * Configuration of the node groups (shards). See below.
     */
    readonly nodeGroupConfigurations: outputs.elasticache.GetReplicationGroupNodeGroupConfiguration[];
    /**
     * Cluster node type.
     */
    readonly nodeType: string;
    /**
     * Number of cache clusters that the replication group has.
     */
    readonly numCacheClusters: number;
    /**
     * Number of node groups (shards) for the replication group.
     */
    readonly numNodeGroups: number;
    /**
     * Port number on which the configuration endpoint will accept connections.
     */
    readonly port: number;
    /**
     * Endpoint of the primary node in this node group (shard).
     */
    readonly primaryEndpointAddress: string;
    /**
     * Endpoint of the reader node in this node group (shard).
     */
    readonly readerEndpointAddress: string;
    readonly region: string;
    /**
     * Number of replica nodes in each node group.
     */
    readonly replicasPerNodeGroup: number;
    readonly replicationGroupId: string;
    /**
     * Number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
     */
    readonly snapshotRetentionLimit: number;
    /**
     * Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
     */
    readonly snapshotWindow: string;
}
/**
 * Use this data source to get information about an ElastiCache Replication Group.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const bar = aws.elasticache.getReplicationGroup({
 *     replicationGroupId: "example",
 * });
 * ```
 */
export declare function getReplicationGroupOutput(args: GetReplicationGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetReplicationGroupResult>;
/**
 * A collection of arguments for invoking getReplicationGroup.
 */
export interface GetReplicationGroupOutputArgs {
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Identifier for the replication group.
     */
    replicationGroupId: pulumi.Input<string>;
}