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

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

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::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.

Using getMultiRegionCluster

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 getMultiRegionCluster(args: GetMultiRegionClusterArgs, opts?: InvokeOptions): Promise<GetMultiRegionClusterResult>
function getMultiRegionClusterOutput(args: GetMultiRegionClusterOutputArgs, opts?: InvokeOptions): Output<GetMultiRegionClusterResult>
Copy
def get_multi_region_cluster(multi_region_cluster_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetMultiRegionClusterResult
def get_multi_region_cluster_output(multi_region_cluster_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetMultiRegionClusterResult]
Copy
func LookupMultiRegionCluster(ctx *Context, args *LookupMultiRegionClusterArgs, opts ...InvokeOption) (*LookupMultiRegionClusterResult, error)
func LookupMultiRegionClusterOutput(ctx *Context, args *LookupMultiRegionClusterOutputArgs, opts ...InvokeOption) LookupMultiRegionClusterResultOutput
Copy

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

public static class GetMultiRegionCluster 
{
    public static Task<GetMultiRegionClusterResult> InvokeAsync(GetMultiRegionClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMultiRegionClusterResult> Invoke(GetMultiRegionClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMultiRegionClusterResult> getMultiRegionCluster(GetMultiRegionClusterArgs args, InvokeOptions options)
public static Output<GetMultiRegionClusterResult> getMultiRegionCluster(GetMultiRegionClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:memorydb:getMultiRegionCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MultiRegionClusterName This property is required. string
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
MultiRegionClusterName This property is required. string
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
multiRegionClusterName This property is required. String
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
multiRegionClusterName This property is required. string
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
multi_region_cluster_name This property is required. str
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
multiRegionClusterName This property is required. String
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.

getMultiRegionCluster Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) of the multi region cluster.
Description string
Description of the multi region cluster.
Engine string
The engine type used by the multi region cluster.
MultiRegionClusterName string
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
NodeType string
The compute and memory capacity of the nodes in the multi region cluster.
NumShards int
The number of shards the multi region cluster will contain.
Status string
The status of the multi region cluster. For example, Available, Updating, Creating.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this multi region cluster.
Arn string
The Amazon Resource Name (ARN) of the multi region cluster.
Description string
Description of the multi region cluster.
Engine string
The engine type used by the multi region cluster.
MultiRegionClusterName string
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
NodeType string
The compute and memory capacity of the nodes in the multi region cluster.
NumShards int
The number of shards the multi region cluster will contain.
Status string
The status of the multi region cluster. For example, Available, Updating, Creating.
Tags Tag
An array of key-value pairs to apply to this multi region cluster.
arn String
The Amazon Resource Name (ARN) of the multi region cluster.
description String
Description of the multi region cluster.
engine String
The engine type used by the multi region cluster.
multiRegionClusterName String
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
nodeType String
The compute and memory capacity of the nodes in the multi region cluster.
numShards Integer
The number of shards the multi region cluster will contain.
status String
The status of the multi region cluster. For example, Available, Updating, Creating.
tags List<Tag>
An array of key-value pairs to apply to this multi region cluster.
arn string
The Amazon Resource Name (ARN) of the multi region cluster.
description string
Description of the multi region cluster.
engine string
The engine type used by the multi region cluster.
multiRegionClusterName string
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
nodeType string
The compute and memory capacity of the nodes in the multi region cluster.
numShards number
The number of shards the multi region cluster will contain.
status string
The status of the multi region cluster. For example, Available, Updating, Creating.
tags Tag[]
An array of key-value pairs to apply to this multi region cluster.
arn str
The Amazon Resource Name (ARN) of the multi region cluster.
description str
Description of the multi region cluster.
engine str
The engine type used by the multi region cluster.
multi_region_cluster_name str
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
node_type str
The compute and memory capacity of the nodes in the multi region cluster.
num_shards int
The number of shards the multi region cluster will contain.
status str
The status of the multi region cluster. For example, Available, Updating, Creating.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this multi region cluster.
arn String
The Amazon Resource Name (ARN) of the multi region cluster.
description String
Description of the multi region cluster.
engine String
The engine type used by the multi region cluster.
multiRegionClusterName String
The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
nodeType String
The compute and memory capacity of the nodes in the multi region cluster.
numShards Number
The number of shards the multi region cluster will contain.
status String
The status of the multi region cluster. For example, Available, Updating, Creating.
tags List<Property Map>
An array of key-value pairs to apply to this multi region cluster.

Supporting Types

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