AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

getCluster

Use this data source to get information about an Elasticache Cluster

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var myCluster = Output.Create(Aws.ElastiCache.GetCluster.InvokeAsync(new Aws.ElastiCache.GetClusterArgs
        {
            ClusterId = "my-cluster-id",
        }));
    }

}
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.LookupCluster(ctx, &elasticache.LookupClusterArgs{
			ClusterId: "my-cluster-id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        final var myCluster = Output.of(ElasticacheFunctions.getCluster(GetClusterArgs.builder()
            .clusterId("my-cluster-id")
            .build()));

        }
}
import pulumi
import pulumi_aws as aws

my_cluster = aws.elasticache.get_cluster(cluster_id="my-cluster-id")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const myCluster = pulumi.output(aws.elasticache.getCluster({
    clusterId: "my-cluster-id",
}));
variables:
  myCluster:
    Fn::Invoke:
      Function: aws:elasticache:getCluster
      Arguments:
        clusterId: my-cluster-id

Using getCluster

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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:elasticache/getCluster:getCluster
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterId string

Group identifier.

Tags Dictionary<string, string>

The tags assigned to the resource

ClusterId string

Group identifier.

Tags map[string]string

The tags assigned to the resource

clusterId String

Group identifier.

tags Map

The tags assigned to the resource

clusterId string

Group identifier.

tags {[key: string]: string}

The tags assigned to the resource

cluster_id str

Group identifier.

tags Mapping[str, str]

The tags assigned to the resource

clusterId String

Group identifier.

tags Map

The tags assigned to the resource

getCluster Result

The following output properties are available:

Arn string
AvailabilityZone string

The Availability Zone for the cache cluster.

CacheNodes List<GetClusterCacheNode>

List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${data.aws_elasticache_cluster.bar.cache_nodes.0.address}

ClusterAddress string

(Memcached only) The DNS name of the cache cluster without the port appended.

ClusterId string
ConfigurationEndpoint string

(Memcached only) The configuration endpoint to allow host discovery.

Engine string

Name of the cache engine.

EngineVersion string

Version number of the cache engine.

Id string

The provider-assigned unique ID for this managed resource.

LogDeliveryConfigurations List<GetClusterLogDeliveryConfiguration>

Redis SLOWLOG or Redis Engine Log delivery settings.

MaintenanceWindow string

Specifies the weekly time range for when maintenance on the cache cluster is performed.

NodeType string

The cluster node type.

NotificationTopicArn string

An Amazon Resource Name (ARN) of an SNS topic that ElastiCache notifications get sent to.

NumCacheNodes int

The number of cache nodes that the cache cluster has.

ParameterGroupName string

Name of the parameter group associated with this cache cluster.

Port int

The port number on which each of the cache nodes will accept connections.

ReplicationGroupId string

The replication group to which this cache cluster belongs.

SecurityGroupIds List<string>

List VPC security groups associated with the cache cluster.

SecurityGroupNames List<string>

List of security group names associated with this cache cluster.

SnapshotRetentionLimit int

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.

SnapshotWindow string

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster.

SubnetGroupName string

Name of the subnet group associated to the cache cluster.

Tags Dictionary<string, string>

The tags assigned to the resource

Arn string
AvailabilityZone string

The Availability Zone for the cache cluster.

CacheNodes []GetClusterCacheNode

List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${data.aws_elasticache_cluster.bar.cache_nodes.0.address}

ClusterAddress string

(Memcached only) The DNS name of the cache cluster without the port appended.

ClusterId string
ConfigurationEndpoint string

(Memcached only) The configuration endpoint to allow host discovery.

Engine string

Name of the cache engine.

EngineVersion string

Version number of the cache engine.

Id string

The provider-assigned unique ID for this managed resource.

LogDeliveryConfigurations []GetClusterLogDeliveryConfiguration

Redis SLOWLOG or Redis Engine Log delivery settings.

MaintenanceWindow string

Specifies the weekly time range for when maintenance on the cache cluster is performed.

NodeType string

The cluster node type.

NotificationTopicArn string

An Amazon Resource Name (ARN) of an SNS topic that ElastiCache notifications get sent to.

NumCacheNodes int

The number of cache nodes that the cache cluster has.

ParameterGroupName string

Name of the parameter group associated with this cache cluster.

Port int

The port number on which each of the cache nodes will accept connections.

ReplicationGroupId string

The replication group to which this cache cluster belongs.

SecurityGroupIds []string

List VPC security groups associated with the cache cluster.

SecurityGroupNames []string

List of security group names associated with this cache cluster.

SnapshotRetentionLimit int

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.

SnapshotWindow string

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster.

SubnetGroupName string

Name of the subnet group associated to the cache cluster.

Tags map[string]string

The tags assigned to the resource

arn String
availabilityZone String

The Availability Zone for the cache cluster.

cacheNodes ListClusterCacheNode>

List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${data.aws_elasticache_cluster.bar.cache_nodes.0.address}

clusterAddress String

(Memcached only) The DNS name of the cache cluster without the port appended.

clusterId String
configurationEndpoint String

(Memcached only) The configuration endpoint to allow host discovery.

engine String

Name of the cache engine.

engineVersion String

Version number of the cache engine.

id String

The provider-assigned unique ID for this managed resource.

logDeliveryConfigurations ListClusterLogDeliveryConfiguration>

Redis SLOWLOG or Redis Engine Log delivery settings.

maintenanceWindow String

Specifies the weekly time range for when maintenance on the cache cluster is performed.

nodeType String

The cluster node type.

notificationTopicArn String

An Amazon Resource Name (ARN) of an SNS topic that ElastiCache notifications get sent to.

numCacheNodes Integer

The number of cache nodes that the cache cluster has.

parameterGroupName String

Name of the parameter group associated with this cache cluster.

port Integer

The port number on which each of the cache nodes will accept connections.

replicationGroupId String

The replication group to which this cache cluster belongs.

securityGroupIds List

List VPC security groups associated with the cache cluster.

securityGroupNames List

List of security group names associated with this cache cluster.

snapshotRetentionLimit Integer

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.

snapshotWindow String

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster.

subnetGroupName String

Name of the subnet group associated to the cache cluster.

tags Map

The tags assigned to the resource

arn string
availabilityZone string

The Availability Zone for the cache cluster.

cacheNodes GetClusterCacheNode[]

List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${data.aws_elasticache_cluster.bar.cache_nodes.0.address}

clusterAddress string

(Memcached only) The DNS name of the cache cluster without the port appended.

clusterId string
configurationEndpoint string

(Memcached only) The configuration endpoint to allow host discovery.

engine string

Name of the cache engine.

engineVersion string

Version number of the cache engine.

id string

The provider-assigned unique ID for this managed resource.

logDeliveryConfigurations GetClusterLogDeliveryConfiguration[]

Redis SLOWLOG or Redis Engine Log delivery settings.

maintenanceWindow string

Specifies the weekly time range for when maintenance on the cache cluster is performed.

nodeType string

The cluster node type.

notificationTopicArn string

An Amazon Resource Name (ARN) of an SNS topic that ElastiCache notifications get sent to.

numCacheNodes number

The number of cache nodes that the cache cluster has.

parameterGroupName string

Name of the parameter group associated with this cache cluster.

port number

The port number on which each of the cache nodes will accept connections.

replicationGroupId string

The replication group to which this cache cluster belongs.

securityGroupIds string[]

List VPC security groups associated with the cache cluster.

securityGroupNames string[]

List of security group names associated with this cache cluster.

snapshotRetentionLimit number

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.

snapshotWindow string

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster.

subnetGroupName string

Name of the subnet group associated to the cache cluster.

tags {[key: string]: string}

The tags assigned to the resource

arn str
availability_zone str

The Availability Zone for the cache cluster.

cache_nodes Sequence[GetClusterCacheNode]

List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${data.aws_elasticache_cluster.bar.cache_nodes.0.address}

cluster_address str

(Memcached only) The DNS name of the cache cluster without the port appended.

cluster_id str
configuration_endpoint str

(Memcached only) The configuration endpoint to allow host discovery.

engine str

Name of the cache engine.

engine_version str

Version number of the cache engine.

id str

The provider-assigned unique ID for this managed resource.

log_delivery_configurations Sequence[GetClusterLogDeliveryConfiguration]

Redis SLOWLOG or Redis Engine Log delivery settings.

maintenance_window str

Specifies the weekly time range for when maintenance on the cache cluster is performed.

node_type str

The cluster node type.

notification_topic_arn str

An Amazon Resource Name (ARN) of an SNS topic that ElastiCache notifications get sent to.

num_cache_nodes int

The number of cache nodes that the cache cluster has.

parameter_group_name str

Name of the parameter group associated with this cache cluster.

port int

The port number on which each of the cache nodes will accept connections.

replication_group_id str

The replication group to which this cache cluster belongs.

security_group_ids Sequence[str]

List VPC security groups associated with the cache cluster.

security_group_names Sequence[str]

List of security group names associated with this cache cluster.

snapshot_retention_limit int

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.

snapshot_window str

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster.

subnet_group_name str

Name of the subnet group associated to the cache cluster.

tags Mapping[str, str]

The tags assigned to the resource

arn String
availabilityZone String

The Availability Zone for the cache cluster.

cacheNodes List

List of node objects including id, address, port and availability_zone. Referenceable e.g., as ${data.aws_elasticache_cluster.bar.cache_nodes.0.address}

clusterAddress String

(Memcached only) The DNS name of the cache cluster without the port appended.

clusterId String
configurationEndpoint String

(Memcached only) The configuration endpoint to allow host discovery.

engine String

Name of the cache engine.

engineVersion String

Version number of the cache engine.

id String

The provider-assigned unique ID for this managed resource.

logDeliveryConfigurations List

Redis SLOWLOG or Redis Engine Log delivery settings.

maintenanceWindow String

Specifies the weekly time range for when maintenance on the cache cluster is performed.

nodeType String

The cluster node type.

notificationTopicArn String

An Amazon Resource Name (ARN) of an SNS topic that ElastiCache notifications get sent to.

numCacheNodes Number

The number of cache nodes that the cache cluster has.

parameterGroupName String

Name of the parameter group associated with this cache cluster.

port Number

The port number on which each of the cache nodes will accept connections.

replicationGroupId String

The replication group to which this cache cluster belongs.

securityGroupIds List

List VPC security groups associated with the cache cluster.

securityGroupNames List

List of security group names associated with this cache cluster.

snapshotRetentionLimit Number

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.

snapshotWindow String

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster.

subnetGroupName String

Name of the subnet group associated to the cache cluster.

tags Map

The tags assigned to the resource

Supporting Types

GetClusterCacheNode

Address string
AvailabilityZone string

The Availability Zone for the cache cluster.

Id string
Port int

The port number on which each of the cache nodes will accept connections.

Address string
AvailabilityZone string

The Availability Zone for the cache cluster.

Id string
Port int

The port number on which each of the cache nodes will accept connections.

address String
availabilityZone String

The Availability Zone for the cache cluster.

id String
port Integer

The port number on which each of the cache nodes will accept connections.

address string
availabilityZone string

The Availability Zone for the cache cluster.

id string
port number

The port number on which each of the cache nodes will accept connections.

address str
availability_zone str

The Availability Zone for the cache cluster.

id str
port int

The port number on which each of the cache nodes will accept connections.

address String
availabilityZone String

The Availability Zone for the cache cluster.

id String
port Number

The port number on which each of the cache nodes will accept connections.

GetClusterLogDeliveryConfiguration

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
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.