Docs Packages
  1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. memorydb
  5. getCluster
aws-native logo
AWS Native v0.63.0, May 25 23

aws-native.memorydb.getCluster

Explore with Pulumi AI

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>
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]
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-native:memorydb:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

ClusterName string

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

clusterName String

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

clusterName string

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

cluster_name str

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

clusterName 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.

EngineVersion string

The Redis engine version used by 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.MemoryDB.Outputs.ClusterTag>

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.

EngineVersion string

The Redis engine version used by 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 []ClusterTag

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.

engineVersion String

The Redis engine version used by 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<ClusterTag>

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.

engineVersion string

The Redis engine version used by 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 ClusterTag[]

An array of key-value pairs to apply to this cluster.

a_cl_name str

The name of the Access Control List to associate with the cluster.

a_rn 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_version str

The Redis engine version used by 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[ClusterTag]

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.

engineVersion String

The Redis engine version used by 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.

ClusterTag

Key string

The key for the tag. May not be null.

Value string

The tag's value. May be null.

Key string

The key for the tag. May not be null.

Value string

The tag's value. May be null.

key String

The key for the tag. May not be null.

value String

The tag's value. May be null.

key string

The key for the tag. May not be null.

value string

The tag's value. May be null.

key str

The key for the tag. May not be null.

value str

The tag's value. May be null.

key String

The key for the tag. May not be null.

value String

The tag's value. May be null.

Package Details

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