1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. docdbelastic
  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

aws-native.docdbelastic.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

The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a 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_arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_arn: 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:docdbelastic:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterArn This property is required. string
ClusterArn This property is required. string
clusterArn This property is required. String
clusterArn This property is required. string
cluster_arn This property is required. str
clusterArn This property is required. String

getCluster Result

The following output properties are available:

BackupRetentionPeriod int
The number of days for which automatic snapshots are retained.
ClusterArn string
ClusterEndpoint string
The URL used to connect to the elastic cluster.
PreferredBackupWindow string
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

ShardCapacity int
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
ShardCount int
The number of shards assigned to the elastic cluster. Maximum is 32.
ShardInstanceCount int
The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
SubnetIds List<string>
The Amazon EC2 subnet IDs for the new elastic cluster.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The tags to be assigned to the new elastic cluster.
VpcSecurityGroupIds List<string>
A list of EC2 VPC security groups to associate with the new elastic cluster.
BackupRetentionPeriod int
The number of days for which automatic snapshots are retained.
ClusterArn string
ClusterEndpoint string
The URL used to connect to the elastic cluster.
PreferredBackupWindow string
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

ShardCapacity int
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
ShardCount int
The number of shards assigned to the elastic cluster. Maximum is 32.
ShardInstanceCount int
The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
SubnetIds []string
The Amazon EC2 subnet IDs for the new elastic cluster.
Tags Tag
The tags to be assigned to the new elastic cluster.
VpcSecurityGroupIds []string
A list of EC2 VPC security groups to associate with the new elastic cluster.
backupRetentionPeriod Integer
The number of days for which automatic snapshots are retained.
clusterArn String
clusterEndpoint String
The URL used to connect to the elastic cluster.
preferredBackupWindow String
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
preferredMaintenanceWindow String

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

shardCapacity Integer
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
shardCount Integer
The number of shards assigned to the elastic cluster. Maximum is 32.
shardInstanceCount Integer
The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
subnetIds List<String>
The Amazon EC2 subnet IDs for the new elastic cluster.
tags List<Tag>
The tags to be assigned to the new elastic cluster.
vpcSecurityGroupIds List<String>
A list of EC2 VPC security groups to associate with the new elastic cluster.
backupRetentionPeriod number
The number of days for which automatic snapshots are retained.
clusterArn string
clusterEndpoint string
The URL used to connect to the elastic cluster.
preferredBackupWindow string
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
preferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

shardCapacity number
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
shardCount number
The number of shards assigned to the elastic cluster. Maximum is 32.
shardInstanceCount number
The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
subnetIds string[]
The Amazon EC2 subnet IDs for the new elastic cluster.
tags Tag[]
The tags to be assigned to the new elastic cluster.
vpcSecurityGroupIds string[]
A list of EC2 VPC security groups to associate with the new elastic cluster.
backup_retention_period int
The number of days for which automatic snapshots are retained.
cluster_arn str
cluster_endpoint str
The URL used to connect to the elastic cluster.
preferred_backup_window str
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
preferred_maintenance_window str

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

shard_capacity int
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
shard_count int
The number of shards assigned to the elastic cluster. Maximum is 32.
shard_instance_count int
The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
subnet_ids Sequence[str]
The Amazon EC2 subnet IDs for the new elastic cluster.
tags Sequence[root_Tag]
The tags to be assigned to the new elastic cluster.
vpc_security_group_ids Sequence[str]
A list of EC2 VPC security groups to associate with the new elastic cluster.
backupRetentionPeriod Number
The number of days for which automatic snapshots are retained.
clusterArn String
clusterEndpoint String
The URL used to connect to the elastic cluster.
preferredBackupWindow String
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
preferredMaintenanceWindow String

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

shardCapacity Number
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
shardCount Number
The number of shards assigned to the elastic cluster. Maximum is 32.
shardInstanceCount Number
The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
subnetIds List<String>
The Amazon EC2 subnet IDs for the new elastic cluster.
tags List<Property Map>
The tags to be assigned to the new elastic cluster.
vpcSecurityGroupIds List<String>
A list of EC2 VPC security groups to associate with the new elastic 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