Try AWS Native preview for resources not in the classic version.
aws.memorydb.getCluster
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides information about a MemoryDB Cluster.
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.
- Dictionary<string, string>
Map of tags assigned to the cluster.
- Name string
Name of the cluster.
- map[string]string
Map of tags assigned to the cluster.
- name String
Name of the cluster.
- Map<String,String>
Map of tags assigned to the cluster.
- name string
Name of the cluster.
- {[key: string]: string}
Map of tags assigned to the cluster.
- name str
Name of the cluster.
- Mapping[str, str]
Map of tags assigned to the cluster.
- name String
Name of the cluster.
- Map<String>
Map of tags assigned to the cluster.
getCluster Result
The following output properties are available:
- Acl
Name string Name of the Access Control List associated with the cluster.
- Arn string
ARN of the cluster.
- Auto
Minor boolVersion Upgrade True when the cluster allows automatic minor version upgrades.
- Cluster
Endpoints List<GetCluster Cluster Endpoint> - Data
Tiering bool True when data tiering is enabled.
- Description string
Description for the cluster.
- Engine
Patch stringVersion Patch version number of the Redis engine used by the cluster.
- Engine
Version string Version number of the Redis engine used by the cluster.
- Final
Snapshot stringName 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.
- Kms
Key stringArn ARN of the KMS key used to encrypt the cluster at rest.
- Maintenance
Window 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.
- Node
Type string Compute and memory capacity of the nodes in the cluster.
- Num
Replicas intPer Shard The number of replicas to apply to each shard.
- Num
Shards int Number of shards in the cluster.
- Parameter
Group stringName The name of the parameter group associated with the cluster.
- Port int
Port number that this node is listening on.
- Security
Group List<string>Ids Set of VPC Security Group ID-s associated with this cluster.
- List<Get
Cluster Shard> Set of shards in this cluster.
- Snapshot
Retention intLimit The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to
0
, automatic backups are disabled.- Snapshot
Window string Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:
05:00-09:00
.- Sns
Topic stringArn ARN of the SNS topic to which cluster notifications are sent.
- Subnet
Group stringName The name of the subnet group used for the cluster.
- Dictionary<string, string>
Map of tags assigned to the cluster.
- Tls
Enabled bool When true, in-transit encryption is enabled for the cluster.
- Acl
Name string Name of the Access Control List associated with the cluster.
- Arn string
ARN of the cluster.
- Auto
Minor boolVersion Upgrade True when the cluster allows automatic minor version upgrades.
- Cluster
Endpoints []GetCluster Cluster Endpoint - Data
Tiering bool True when data tiering is enabled.
- Description string
Description for the cluster.
- Engine
Patch stringVersion Patch version number of the Redis engine used by the cluster.
- Engine
Version string Version number of the Redis engine used by the cluster.
- Final
Snapshot stringName 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.
- Kms
Key stringArn ARN of the KMS key used to encrypt the cluster at rest.
- Maintenance
Window 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.
- Node
Type string Compute and memory capacity of the nodes in the cluster.
- Num
Replicas intPer Shard The number of replicas to apply to each shard.
- Num
Shards int Number of shards in the cluster.
- Parameter
Group stringName The name of the parameter group associated with the cluster.
- Port int
Port number that this node is listening on.
- Security
Group []stringIds Set of VPC Security Group ID-s associated with this cluster.
- []Get
Cluster Shard Set of shards in this cluster.
- Snapshot
Retention intLimit The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to
0
, automatic backups are disabled.- Snapshot
Window string Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:
05:00-09:00
.- Sns
Topic stringArn ARN of the SNS topic to which cluster notifications are sent.
- Subnet
Group stringName The name of the subnet group used for the cluster.
- map[string]string
Map of tags assigned to the cluster.
- Tls
Enabled bool When true, in-transit encryption is enabled for the cluster.
- acl
Name String Name of the Access Control List associated with the cluster.
- arn String
ARN of the cluster.
- auto
Minor BooleanVersion Upgrade True when the cluster allows automatic minor version upgrades.
- cluster
Endpoints List<GetCluster Cluster Endpoint> - data
Tiering Boolean True when data tiering is enabled.
- description String
Description for the cluster.
- engine
Patch StringVersion Patch version number of the Redis engine used by the cluster.
- engine
Version String Version number of the Redis engine used by the cluster.
- final
Snapshot StringName 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.
- kms
Key StringArn ARN of the KMS key used to encrypt the cluster at rest.
- maintenance
Window 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.
- node
Type String Compute and memory capacity of the nodes in the cluster.
- num
Replicas IntegerPer Shard The number of replicas to apply to each shard.
- num
Shards Integer Number of shards in the cluster.
- parameter
Group StringName The name of the parameter group associated with the cluster.
- port Integer
Port number that this node is listening on.
- security
Group List<String>Ids Set of VPC Security Group ID-s associated with this cluster.
- List<Get
Cluster Shard> Set of shards in this cluster.
- snapshot
Retention IntegerLimit The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to
0
, automatic backups are disabled.- snapshot
Window String Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:
05:00-09:00
.- sns
Topic StringArn ARN of the SNS topic to which cluster notifications are sent.
- subnet
Group StringName The name of the subnet group used for the cluster.
- Map<String,String>
Map of tags assigned to the cluster.
- tls
Enabled Boolean When true, in-transit encryption is enabled for the cluster.
- acl
Name string Name of the Access Control List associated with the cluster.
- arn string
ARN of the cluster.
- auto
Minor booleanVersion Upgrade True when the cluster allows automatic minor version upgrades.
- cluster
Endpoints GetCluster Cluster Endpoint[] - data
Tiering boolean True when data tiering is enabled.
- description string
Description for the cluster.
- engine
Patch stringVersion Patch version number of the Redis engine used by the cluster.
- engine
Version string Version number of the Redis engine used by the cluster.
- final
Snapshot stringName 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.
- kms
Key stringArn ARN of the KMS key used to encrypt the cluster at rest.
- maintenance
Window 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.
- node
Type string Compute and memory capacity of the nodes in the cluster.
- num
Replicas numberPer Shard The number of replicas to apply to each shard.
- num
Shards number Number of shards in the cluster.
- parameter
Group stringName The name of the parameter group associated with the cluster.
- port number
Port number that this node is listening on.
- security
Group string[]Ids Set of VPC Security Group ID-s associated with this cluster.
- Get
Cluster Shard[] Set of shards in this cluster.
- snapshot
Retention numberLimit The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to
0
, automatic backups are disabled.- snapshot
Window string Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:
05:00-09:00
.- sns
Topic stringArn ARN of the SNS topic to which cluster notifications are sent.
- subnet
Group stringName The name of the subnet group used for the cluster.
- {[key: string]: string}
Map of tags assigned to the cluster.
- tls
Enabled 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_ boolversion_ upgrade True when the cluster allows automatic minor version upgrades.
- cluster_
endpoints Sequence[GetCluster Cluster Endpoint] - data_
tiering bool True when data tiering is enabled.
- description str
Description for the cluster.
- engine_
patch_ strversion 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_ strname 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_ strarn 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_ intper_ shard The number of replicas to apply to each shard.
- num_
shards int Number of shards in the cluster.
- parameter_
group_ strname The name of the parameter group associated with the cluster.
- port int
Port number that this node is listening on.
- security_
group_ Sequence[str]ids Set of VPC Security Group ID-s associated with this cluster.
- Sequence[Get
Cluster Shard] Set of shards in this cluster.
- snapshot_
retention_ intlimit 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_ strarn ARN of the SNS topic to which cluster notifications are sent.
- subnet_
group_ strname The name of the subnet group used for the cluster.
- Mapping[str, str]
Map of tags assigned to the cluster.
- tls_
enabled bool When true, in-transit encryption is enabled for the cluster.
- acl
Name String Name of the Access Control List associated with the cluster.
- arn String
ARN of the cluster.
- auto
Minor BooleanVersion Upgrade True when the cluster allows automatic minor version upgrades.
- cluster
Endpoints List<Property Map> - data
Tiering Boolean True when data tiering is enabled.
- description String
Description for the cluster.
- engine
Patch StringVersion Patch version number of the Redis engine used by the cluster.
- engine
Version String Version number of the Redis engine used by the cluster.
- final
Snapshot StringName 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.
- kms
Key StringArn ARN of the KMS key used to encrypt the cluster at rest.
- maintenance
Window 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.
- node
Type String Compute and memory capacity of the nodes in the cluster.
- num
Replicas NumberPer Shard The number of replicas to apply to each shard.
- num
Shards Number Number of shards in the cluster.
- parameter
Group StringName The name of the parameter group associated with the cluster.
- port Number
Port number that this node is listening on.
- security
Group List<String>Ids Set of VPC Security Group ID-s associated with this cluster.
- List<Property Map>
Set of shards in this cluster.
- snapshot
Retention NumberLimit The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to
0
, automatic backups are disabled.- snapshot
Window String Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:
05:00-09:00
.- sns
Topic StringArn ARN of the SNS topic to which cluster notifications are sent.
- subnet
Group StringName The name of the subnet group used for the cluster.
- Map<String>
Map of tags assigned to the cluster.
- tls
Enabled Boolean When true, in-transit encryption is enabled for the cluster.
Supporting Types
GetClusterClusterEndpoint
GetClusterShard
- Name string
Name of the cluster.
- Nodes
List<Get
Cluster Shard Node> Set of nodes in this shard.
- Num
Nodes int Number of individual nodes in this shard.
- Slots string
Keyspace for this shard. Example:
0-16383
.
- Name string
Name of the cluster.
- Nodes
[]Get
Cluster Shard Node Set of nodes in this shard.
- Num
Nodes 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<Get
Cluster Shard Node> Set of nodes in this shard.
- num
Nodes Integer Number of individual nodes in this shard.
- slots String
Keyspace for this shard. Example:
0-16383
.
- name string
Name of the cluster.
- nodes
Get
Cluster Shard Node[] Set of nodes in this shard.
- num
Nodes 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[Get
Cluster Shard Node] 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.
- num
Nodes Number Number of individual nodes in this shard.
- slots String
Keyspace for this shard. Example:
0-16383
.
GetClusterShardNode
- Availability
Zone string The Availability Zone in which the node resides.
- Create
Time string The date and time when the node was created. Example:
2022-01-01T21:00:00Z
.- Endpoints
List<Get
Cluster Shard Node Endpoint> - Name string
Name of the cluster.
- Availability
Zone string The Availability Zone in which the node resides.
- Create
Time string The date and time when the node was created. Example:
2022-01-01T21:00:00Z
.- Endpoints
[]Get
Cluster Shard Node Endpoint - Name string
Name of the cluster.
- availability
Zone String The Availability Zone in which the node resides.
- create
Time String The date and time when the node was created. Example:
2022-01-01T21:00:00Z
.- endpoints
List<Get
Cluster Shard Node Endpoint> - name String
Name of the cluster.
- availability
Zone string The Availability Zone in which the node resides.
- create
Time string The date and time when the node was created. Example:
2022-01-01T21:00:00Z
.- endpoints
Get
Cluster Shard Node Endpoint[] - 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[Get
Cluster Shard Node Endpoint] - name str
Name of the cluster.
- availability
Zone String The Availability Zone in which the node resides.
- create
Time 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
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.