AWS Classic v6.2.1, Sep 22 23

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

aws.memorydb.getCluster

Explore with Pulumi AI

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.MemoryDb.GetCluster.Invoke(new()
    {
        Name = "my-cluster",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/memorydb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := memorydb.LookupCluster(ctx, &memorydb.LookupClusterArgs{
			Name: "my-cluster",
		}, 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.memorydb.MemorydbFunctions;
import com.pulumi.aws.memorydb.inputs.GetClusterArgs;
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 example = MemorydbFunctions.getCluster(GetClusterArgs.builder()
            .name("my-cluster")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.memorydb.get_cluster(name="my-cluster")

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

const example = aws.memorydb.getCluster({
    name: "my-cluster",
});

variables:
  example:
    fn::invoke:
      Function: aws:memorydb:getCluster
      Arguments:
        name: my-cluster

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(name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: 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:memorydb/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the cluster.
Tags Dictionary<string, string>: Map of tags assigned to the cluster.

Name string: Name of the cluster.
Tags map[string]string: Map of tags assigned to the cluster.

name String: Name of the cluster.
tags Map<String,String>: Map of tags assigned to the cluster.

name string: Name of the cluster.
tags {[key: string]: string}: Map of tags assigned to the cluster.

name str: Name of the cluster.
tags Mapping[str, str]: Map of tags assigned to the cluster.

name String: Name of the cluster.
tags Map<String>: Map of tags assigned to the cluster.

getCluster Result

The following output properties are available:

AclName string: Name of the Access Control List associated with the cluster.
Arn string: ARN of the cluster.
AutoMinorVersionUpgrade bool: True when the cluster allows automatic minor version upgrades.
ClusterEndpoints List<GetClusterClusterEndpoint>
DataTiering bool: True when data tiering is enabled.
Description string: Description for the cluster.
EnginePatchVersion string: Patch version number of the Redis engine used by the cluster.
EngineVersion string: Version number of the Redis engine used by the cluster.
FinalSnapshotName string: Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyArn string: ARN of the KMS key used to encrypt the cluster at rest.
MaintenanceWindow string: Weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: sun:23:00-mon:01:30.
Name string: Name of this node.
NodeType string: Compute and memory capacity of the nodes in the cluster.
NumReplicasPerShard int: The number of replicas to apply to each shard.
NumShards int: Number of shards in the cluster.
ParameterGroupName string: The name of the parameter group associated with the cluster.
Port int: Port number that this node is listening on.
SecurityGroupIds List<string>: Set of VPC Security Group ID-s associated with this cluster.
Shards List<GetClusterShard>: Set of shards in this cluster.
SnapshotRetentionLimit int: The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled.
SnapshotWindow string: Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
SnsTopicArn string: ARN of the SNS topic to which cluster notifications are sent.
SubnetGroupName string: The name of the subnet group used for the cluster.
Tags Dictionary<string, string>: Map of tags assigned to the cluster.
TlsEnabled bool: When true, in-transit encryption is enabled for the cluster.

AclName string: Name of the Access Control List associated with the cluster.
Arn string: ARN of the cluster.
AutoMinorVersionUpgrade bool: True when the cluster allows automatic minor version upgrades.
ClusterEndpoints []GetClusterClusterEndpoint
DataTiering bool: True when data tiering is enabled.
Description string: Description for the cluster.
EnginePatchVersion string: Patch version number of the Redis engine used by the cluster.
EngineVersion string: Version number of the Redis engine used by the cluster.
FinalSnapshotName string: Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyArn string: ARN of the KMS key used to encrypt the cluster at rest.
MaintenanceWindow string: Weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: sun:23:00-mon:01:30.
Name string: Name of this node.
NodeType string: Compute and memory capacity of the nodes in the cluster.
NumReplicasPerShard int: The number of replicas to apply to each shard.
NumShards int: Number of shards in the cluster.
ParameterGroupName string: The name of the parameter group associated with the cluster.
Port int: Port number that this node is listening on.
SecurityGroupIds []string: Set of VPC Security Group ID-s associated with this cluster.
Shards []GetClusterShard: Set of shards in this cluster.
SnapshotRetentionLimit int: The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled.
SnapshotWindow string: Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
SnsTopicArn string: ARN of the SNS topic to which cluster notifications are sent.
SubnetGroupName string: The name of the subnet group used for the cluster.
Tags map[string]string: Map of tags assigned to the cluster.
TlsEnabled bool: When true, in-transit encryption is enabled for the cluster.

aclName String: Name of the Access Control List associated with the cluster.
arn String: ARN of the cluster.
autoMinorVersionUpgrade Boolean: True when the cluster allows automatic minor version upgrades.
clusterEndpoints List<GetClusterClusterEndpoint>
dataTiering Boolean: True when data tiering is enabled.
description String: Description for the cluster.
enginePatchVersion String: Patch version number of the Redis engine used by the cluster.
engineVersion String: Version number of the Redis engine used by the cluster.
finalSnapshotName String: Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
id String: The provider-assigned unique ID for this managed resource.
kmsKeyArn String: ARN of the KMS key used to encrypt the cluster at rest.
maintenanceWindow String: Weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: sun:23:00-mon:01:30.
name String: Name of this node.
nodeType String: Compute and memory capacity of the nodes in the cluster.
numReplicasPerShard Integer: The number of replicas to apply to each shard.
numShards Integer: Number of shards in the cluster.
parameterGroupName String: The name of the parameter group associated with the cluster.
port Integer: Port number that this node is listening on.
securityGroupIds List<String>: Set of VPC Security Group ID-s associated with this cluster.
shards List<GetClusterShard>: Set of shards in this cluster.
snapshotRetentionLimit Integer: The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled.
snapshotWindow String: Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
snsTopicArn String: ARN of the SNS topic to which cluster notifications are sent.
subnetGroupName String: The name of the subnet group used for the cluster.
tags Map<String,String>: Map of tags assigned to the cluster.
tlsEnabled Boolean: When true, in-transit encryption is enabled for the cluster.

aclName string: Name of the Access Control List associated with the cluster.
arn string: ARN of the cluster.
autoMinorVersionUpgrade boolean: True when the cluster allows automatic minor version upgrades.
clusterEndpoints GetClusterClusterEndpoint[]
dataTiering boolean: True when data tiering is enabled.
description string: Description for the cluster.
enginePatchVersion string: Patch version number of the Redis engine used by the cluster.
engineVersion string: Version number of the Redis engine used by the cluster.
finalSnapshotName string: Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
id string: The provider-assigned unique ID for this managed resource.
kmsKeyArn string: ARN of the KMS key used to encrypt the cluster at rest.
maintenanceWindow string: Weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: sun:23:00-mon:01:30.
name string: Name of this node.
nodeType string: Compute and memory capacity of the nodes in the cluster.
numReplicasPerShard number: The number of replicas to apply to each shard.
numShards number: Number of shards in the cluster.
parameterGroupName string: The name of the parameter group associated with the cluster.
port number: Port number that this node is listening on.
securityGroupIds string[]: Set of VPC Security Group ID-s associated with this cluster.
shards GetClusterShard[]: Set of shards in this cluster.
snapshotRetentionLimit number: The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled.
snapshotWindow string: Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
snsTopicArn string: ARN of the SNS topic to which cluster notifications are sent.
subnetGroupName string: The name of the subnet group used for the cluster.
tags {[key: string]: string}: Map of tags assigned to the cluster.
tlsEnabled boolean: When true, in-transit encryption is enabled for the cluster.

acl_name str: Name of the Access Control List associated with the cluster.
arn str: ARN of the cluster.
auto_minor_version_upgrade bool: True when the cluster allows automatic minor version upgrades.
cluster_endpoints Sequence[GetClusterClusterEndpoint]
data_tiering bool: True when data tiering is enabled.
description str: Description for the cluster.
engine_patch_version str: Patch version number of the Redis engine used by the cluster.
engine_version str: Version number of the Redis engine used by the cluster.
final_snapshot_name str: Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
id str: The provider-assigned unique ID for this managed resource.
kms_key_arn str: ARN of the KMS key used to encrypt the cluster at rest.
maintenance_window str: Weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: sun:23:00-mon:01:30.
name str: Name of this node.
node_type str: Compute and memory capacity of the nodes in the cluster.
num_replicas_per_shard int: The number of replicas to apply to each shard.
num_shards int: Number of shards in the cluster.
parameter_group_name str: The name of the parameter group associated with the cluster.
port int: Port number that this node is listening on.
security_group_ids Sequence[str]: Set of VPC Security Group ID-s associated with this cluster.
shards Sequence[GetClusterShard]: Set of shards in this cluster.
snapshot_retention_limit int: The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled.
snapshot_window str: Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
sns_topic_arn str: ARN of the SNS topic to which cluster notifications are sent.
subnet_group_name str: The name of the subnet group used for the cluster.
tags Mapping[str, str]: Map of tags assigned to the cluster.
tls_enabled bool: When true, in-transit encryption is enabled for the cluster.

aclName String: Name of the Access Control List associated with the cluster.
arn String: ARN of the cluster.
autoMinorVersionUpgrade Boolean: True when the cluster allows automatic minor version upgrades.
clusterEndpoints List<Property Map>
dataTiering Boolean: True when data tiering is enabled.
description String: Description for the cluster.
enginePatchVersion String: Patch version number of the Redis engine used by the cluster.
engineVersion String: Version number of the Redis engine used by the cluster.
finalSnapshotName String: Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.
id String: The provider-assigned unique ID for this managed resource.
kmsKeyArn String: ARN of the KMS key used to encrypt the cluster at rest.
maintenanceWindow String: Weekly time range during which maintenance on the cluster is performed. Specify as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: sun:23:00-mon:01:30.
name String: Name of this node.
nodeType String: Compute and memory capacity of the nodes in the cluster.
numReplicasPerShard Number: The number of replicas to apply to each shard.
numShards Number: Number of shards in the cluster.
parameterGroupName String: The name of the parameter group associated with the cluster.
port Number: Port number that this node is listening on.
securityGroupIds List<String>: Set of VPC Security Group ID-s associated with this cluster.
shards List<Property Map>: Set of shards in this cluster.
snapshotRetentionLimit Number: The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled.
snapshotWindow String: Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.
snsTopicArn String: ARN of the SNS topic to which cluster notifications are sent.
subnetGroupName String: The name of the subnet group used for the cluster.
tags Map<String>: Map of tags assigned to the cluster.
tlsEnabled Boolean: When true, in-transit encryption is enabled for the cluster.

Supporting Types

GetClusterClusterEndpoint

Address string: DNS hostname of the node.
Port int: Port number that this node is listening on.

Address string: DNS hostname of the node.
Port int: Port number that this node is listening on.

address String: DNS hostname of the node.
port Integer: Port number that this node is listening on.

address string: DNS hostname of the node.
port number: Port number that this node is listening on.

address str: DNS hostname of the node.
port int: Port number that this node is listening on.

address String: DNS hostname of the node.
port Number: Port number that this node is listening on.

GetClusterShard

Name string: Name of the cluster.
Nodes List<GetClusterShardNode>: Set of nodes in this shard.
NumNodes int: Number of individual nodes in this shard.
Slots string: Keyspace for this shard. Example: 0-16383.

Name string: Name of the cluster.
Nodes []GetClusterShardNode: Set of nodes in this shard.
NumNodes int: Number of individual nodes in this shard.
Slots string: Keyspace for this shard. Example: 0-16383.

name String: Name of the cluster.
nodes List<GetClusterShardNode>: Set of nodes in this shard.
numNodes Integer: Number of individual nodes in this shard.
slots String: Keyspace for this shard. Example: 0-16383.

name string: Name of the cluster.
nodes GetClusterShardNode[]: Set of nodes in this shard.
numNodes number: Number of individual nodes in this shard.
slots string: Keyspace for this shard. Example: 0-16383.

name str: Name of the cluster.
nodes Sequence[GetClusterShardNode]: Set of nodes in this shard.
num_nodes int: Number of individual nodes in this shard.
slots str: Keyspace for this shard. Example: 0-16383.

name String: Name of the cluster.
nodes List<Property Map>: Set of nodes in this shard.
numNodes Number: Number of individual nodes in this shard.
slots String: Keyspace for this shard. Example: 0-16383.

GetClusterShardNode

AvailabilityZone string: The Availability Zone in which the node resides.
CreateTime string: The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
Endpoints List<GetClusterShardNodeEndpoint>
Name string: Name of the cluster.

AvailabilityZone string: The Availability Zone in which the node resides.
CreateTime string: The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
Endpoints []GetClusterShardNodeEndpoint
Name string: Name of the cluster.

availabilityZone String: The Availability Zone in which the node resides.
createTime String: The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
endpoints List<GetClusterShardNodeEndpoint>
name String: Name of the cluster.

availabilityZone string: The Availability Zone in which the node resides.
createTime string: The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
endpoints GetClusterShardNodeEndpoint[]
name string: Name of the cluster.

availability_zone str: The Availability Zone in which the node resides.
create_time str: The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
endpoints Sequence[GetClusterShardNodeEndpoint]
name str: Name of the cluster.

availabilityZone String: The Availability Zone in which the node resides.
createTime String: The date and time when the node was created. Example: 2022-01-01T21:00:00Z.
endpoints List<Property Map>
name String: Name of the cluster.

GetClusterShardNodeEndpoint

Address string: DNS hostname of the node.
Port int: Port number that this node is listening on.

Address string: DNS hostname of the node.
Port int: Port number that this node is listening on.

address String: DNS hostname of the node.
port Integer: Port number that this node is listening on.

address string: DNS hostname of the node.
port number: Port number that this node is listening on.

address str: DNS hostname of the node.
port int: Port number that this node is listening on.

address String: DNS hostname of the node.
port Number: Port number that this node is listening on.

Package Details

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

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

aws.memorydb.getCluster

On this page

On this page

Example Usage

Using getCluster

getCluster Result

Supporting Types

GetClusterClusterEndpoint

GetClusterShard

GetClusterShardNode

GetClusterShardNodeEndpoint

Package Details

On this page

On this page