Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. memorydb
  5. getCluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.memorydb.getCluster

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB 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>
Copy
def get_cluster(cluster_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
Copy
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:memorydb:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName This property is required. string
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
ClusterName This property is required. string
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
clusterName This property is required. String
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
clusterName This property is required. string
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
cluster_name This property is required. str
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
clusterName This property is required. String
The name of the cluster. This value must be unique as it also serves as the cluster identifier.

getCluster Result

The following output properties are available:

AclName string
The name of the Access Control List to associate with the cluster.
Arn string
The Amazon Resource Name (ARN) of the cluster.
AutoMinorVersionUpgrade bool

A flag that enables automatic minor version upgrade when set to true.

You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

ClusterEndpoint Pulumi.AwsNative.MemoryDb.Outputs.ClusterEndpoint
The cluster endpoint.
Description string
An optional description of the cluster.
Engine string
The engine type used by the cluster.
EngineVersion string
The Redis engine version used by the cluster.
IpDiscovery Pulumi.AwsNative.MemoryDb.ClusterSupportedIpDiscoveryTypes
For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as cluster info and cluster nodes which are used by clients to connect to the nodes in the cluster.
MaintenanceWindow string
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
NodeType string
The compute and memory capacity of the nodes in the cluster.
NumReplicasPerShard int
The number of replicas to apply to each shard. The limit is 5.
NumShards int
The number of shards the cluster will contain.
ParameterGroupName string
The name of the parameter group associated with the cluster.
ParameterGroupStatus string
The status of the parameter group used by the cluster.
SecurityGroupIds List<string>
One or more Amazon VPC security groups associated with this cluster.
SnapshotRetentionLimit int
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
SnapshotWindow string
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
SnsTopicArn string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
SnsTopicStatus string
The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
Status string
The status of the cluster. For example, Available, Updating, Creating.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this cluster.
AclName string
The name of the Access Control List to associate with the cluster.
Arn string
The Amazon Resource Name (ARN) of the cluster.
AutoMinorVersionUpgrade bool

A flag that enables automatic minor version upgrade when set to true.

You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

ClusterEndpoint ClusterEndpoint
The cluster endpoint.
Description string
An optional description of the cluster.
Engine string
The engine type used by the cluster.
EngineVersion string
The Redis engine version used by the cluster.
IpDiscovery ClusterSupportedIpDiscoveryTypes
For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as cluster info and cluster nodes which are used by clients to connect to the nodes in the cluster.
MaintenanceWindow string
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
NodeType string
The compute and memory capacity of the nodes in the cluster.
NumReplicasPerShard int
The number of replicas to apply to each shard. The limit is 5.
NumShards int
The number of shards the cluster will contain.
ParameterGroupName string
The name of the parameter group associated with the cluster.
ParameterGroupStatus string
The status of the parameter group used by the cluster.
SecurityGroupIds []string
One or more Amazon VPC security groups associated with this cluster.
SnapshotRetentionLimit int
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
SnapshotWindow string
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
SnsTopicArn string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
SnsTopicStatus string
The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
Status string
The status of the cluster. For example, Available, Updating, Creating.
Tags Tag
An array of key-value pairs to apply to this cluster.
aclName String
The name of the Access Control List to associate with the cluster.
arn String
The Amazon Resource Name (ARN) of the cluster.
autoMinorVersionUpgrade Boolean

A flag that enables automatic minor version upgrade when set to true.

You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

clusterEndpoint ClusterEndpoint
The cluster endpoint.
description String
An optional description of the cluster.
engine String
The engine type used by the cluster.
engineVersion String
The Redis engine version used by the cluster.
ipDiscovery ClusterSupportedIpDiscoveryTypes
For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as cluster info and cluster nodes which are used by clients to connect to the nodes in the cluster.
maintenanceWindow String
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
nodeType String
The compute and memory capacity of the nodes in the cluster.
numReplicasPerShard Integer
The number of replicas to apply to each shard. The limit is 5.
numShards Integer
The number of shards the cluster will contain.
parameterGroupName String
The name of the parameter group associated with the cluster.
parameterGroupStatus String
The status of the parameter group used by the cluster.
securityGroupIds List<String>
One or more Amazon VPC security groups associated with this cluster.
snapshotRetentionLimit Integer
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshotWindow String
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
snsTopicArn String
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
snsTopicStatus String
The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
status String
The status of the cluster. For example, Available, Updating, Creating.
tags List<Tag>
An array of key-value pairs to apply to this cluster.
aclName string
The name of the Access Control List to associate with the cluster.
arn string
The Amazon Resource Name (ARN) of the cluster.
autoMinorVersionUpgrade boolean

A flag that enables automatic minor version upgrade when set to true.

You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

clusterEndpoint ClusterEndpoint
The cluster endpoint.
description string
An optional description of the cluster.
engine string
The engine type used by the cluster.
engineVersion string
The Redis engine version used by the cluster.
ipDiscovery ClusterSupportedIpDiscoveryTypes
For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as cluster info and cluster nodes which are used by clients to connect to the nodes in the cluster.
maintenanceWindow string
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
nodeType string
The compute and memory capacity of the nodes in the cluster.
numReplicasPerShard number
The number of replicas to apply to each shard. The limit is 5.
numShards number
The number of shards the cluster will contain.
parameterGroupName string
The name of the parameter group associated with the cluster.
parameterGroupStatus string
The status of the parameter group used by the cluster.
securityGroupIds string[]
One or more Amazon VPC security groups associated with this cluster.
snapshotRetentionLimit number
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshotWindow string
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
snsTopicArn string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
snsTopicStatus string
The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
status string
The status of the cluster. For example, Available, Updating, Creating.
tags Tag[]
An array of key-value pairs to apply to this cluster.
acl_name str
The name of the Access Control List to associate with the cluster.
arn str
The Amazon Resource Name (ARN) of the cluster.
auto_minor_version_upgrade bool

A flag that enables automatic minor version upgrade when set to true.

You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

cluster_endpoint ClusterEndpoint
The cluster endpoint.
description str
An optional description of the cluster.
engine str
The engine type used by the cluster.
engine_version str
The Redis engine version used by the cluster.
ip_discovery ClusterSupportedIpDiscoveryTypes
For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as cluster info and cluster nodes which are used by clients to connect to the nodes in the cluster.
maintenance_window str
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
node_type str
The compute and memory capacity of the nodes in the cluster.
num_replicas_per_shard int
The number of replicas to apply to each shard. The limit is 5.
num_shards int
The number of shards the cluster will contain.
parameter_group_name str
The name of the parameter group associated with the cluster.
parameter_group_status str
The status of the parameter group used by the cluster.
security_group_ids Sequence[str]
One or more Amazon VPC security groups associated with this cluster.
snapshot_retention_limit int
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshot_window str
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
sns_topic_arn str
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
sns_topic_status str
The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
status str
The status of the cluster. For example, Available, Updating, Creating.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this cluster.
aclName String
The name of the Access Control List to associate with the cluster.
arn String
The Amazon Resource Name (ARN) of the cluster.
autoMinorVersionUpgrade Boolean

A flag that enables automatic minor version upgrade when set to true.

You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

clusterEndpoint Property Map
The cluster endpoint.
description String
An optional description of the cluster.
engine String
The engine type used by the cluster.
engineVersion String
The Redis engine version used by the cluster.
ipDiscovery "ipv4" | "ipv6"
For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as cluster info and cluster nodes which are used by clients to connect to the nodes in the cluster.
maintenanceWindow String
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
nodeType String
The compute and memory capacity of the nodes in the cluster.
numReplicasPerShard Number
The number of replicas to apply to each shard. The limit is 5.
numShards Number
The number of shards the cluster will contain.
parameterGroupName String
The name of the parameter group associated with the cluster.
parameterGroupStatus String
The status of the parameter group used by the cluster.
securityGroupIds List<String>
One or more Amazon VPC security groups associated with this cluster.
snapshotRetentionLimit Number
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshotWindow String
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
snsTopicArn String
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
snsTopicStatus String
The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
status String
The status of the cluster. For example, Available, Updating, Creating.
tags List<Property Map>
An array of key-value pairs to apply to this cluster.

Supporting Types

ClusterEndpoint

Address string
The DNS address of the primary read-write node.
Port int
The port number that the engine is listening on.
Address string
The DNS address of the primary read-write node.
Port int
The port number that the engine is listening on.
address String
The DNS address of the primary read-write node.
port Integer
The port number that the engine is listening on.
address string
The DNS address of the primary read-write node.
port number
The port number that the engine is listening on.
address str
The DNS address of the primary read-write node.
port int
The port number that the engine is listening on.
address String
The DNS address of the primary read-write node.
port Number
The port number that the engine is listening on.

ClusterSupportedIpDiscoveryTypes

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native