Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. docdb
  5. ElasticCluster
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.docdb.ElasticCluster

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Manages an AWS DocDB (DocumentDB) Elastic Cluster.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.docdb.ElasticCluster("example", {
    name: "my-docdb-cluster",
    adminUserName: "foo",
    adminUserPassword: "mustbeeightchars",
    authType: "PLAIN_TEXT",
    shardCapacity: 2,
    shardCount: 1,
});

    import pulumi
import pulumi_aws as aws

example = aws.docdb.ElasticCluster("example",
    name="my-docdb-cluster",
    admin_user_name="foo",
    admin_user_password="mustbeeightchars",
    auth_type="PLAIN_TEXT",
    shard_capacity=2,
    shard_count=1)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/docdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docdb.NewElasticCluster(ctx, "example", &docdb.ElasticClusterArgs{
			Name:              pulumi.String("my-docdb-cluster"),
			AdminUserName:     pulumi.String("foo"),
			AdminUserPassword: pulumi.String("mustbeeightchars"),
			AuthType:          pulumi.String("PLAIN_TEXT"),
			ShardCapacity:     pulumi.Int(2),
			ShardCount:        pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DocDB.ElasticCluster("example", new()
    {
        Name = "my-docdb-cluster",
        AdminUserName = "foo",
        AdminUserPassword = "mustbeeightchars",
        AuthType = "PLAIN_TEXT",
        ShardCapacity = 2,
        ShardCount = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.ElasticCluster;
import com.pulumi.aws.docdb.ElasticClusterArgs;
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) {
        var example = new ElasticCluster("example", ElasticClusterArgs.builder()
            .name("my-docdb-cluster")
            .adminUserName("foo")
            .adminUserPassword("mustbeeightchars")
            .authType("PLAIN_TEXT")
            .shardCapacity(2)
            .shardCount(1)
            .build());

    }
}

    resources:
  example:
    type: aws:docdb:ElasticCluster
    properties:
      name: my-docdb-cluster
      adminUserName: foo
      adminUserPassword: mustbeeightchars
      authType: PLAIN_TEXT
      shardCapacity: 2
      shardCount: 1

    Create ElasticCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ElasticCluster(name: string, args: ElasticClusterArgs, opts?: CustomResourceOptions);
    @overload
def ElasticCluster(resource_name: str,
                   args: ElasticClusterArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ElasticCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   shard_capacity: Optional[int] = None,
                   admin_user_password: Optional[str] = None,
                   auth_type: Optional[str] = None,
                   admin_user_name: Optional[str] = None,
                   shard_count: Optional[int] = None,
                   backup_retention_period: Optional[float] = None,
                   preferred_backup_window: Optional[str] = None,
                   preferred_maintenance_window: Optional[str] = None,
                   name: Optional[str] = None,
                   kms_key_id: Optional[str] = None,
                   subnet_ids: Optional[Sequence[str]] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   timeouts: Optional[ElasticClusterTimeoutsArgs] = None,
                   vpc_security_group_ids: Optional[Sequence[str]] = None)
    func NewElasticCluster(ctx *Context, name string, args ElasticClusterArgs, opts ...ResourceOption) (*ElasticCluster, error)
    public ElasticCluster(string name, ElasticClusterArgs args, CustomResourceOptions? opts = null)
    public ElasticCluster(String name, ElasticClusterArgs args)
public ElasticCluster(String name, ElasticClusterArgs args, CustomResourceOptions options)

    type: aws:docdb:ElasticCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ElasticClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ElasticClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ElasticClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ElasticClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ElasticClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var elasticClusterResource = new Aws.DocDB.ElasticCluster("elasticClusterResource", new()
{
    ShardCapacity = 0,
    AdminUserPassword = "string",
    AuthType = "string",
    AdminUserName = "string",
    ShardCount = 0,
    BackupRetentionPeriod = 0,
    PreferredBackupWindow = "string",
    PreferredMaintenanceWindow = "string",
    Name = "string",
    KmsKeyId = "string",
    SubnetIds = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.DocDB.Inputs.ElasticClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
});

    example, err := docdb.NewElasticCluster(ctx, "elasticClusterResource", &docdb.ElasticClusterArgs{
	ShardCapacity:              pulumi.Int(0),
	AdminUserPassword:          pulumi.String("string"),
	AuthType:                   pulumi.String("string"),
	AdminUserName:              pulumi.String("string"),
	ShardCount:                 pulumi.Int(0),
	BackupRetentionPeriod:      pulumi.Float64(0),
	PreferredBackupWindow:      pulumi.String("string"),
	PreferredMaintenanceWindow: pulumi.String("string"),
	Name:                       pulumi.String("string"),
	KmsKeyId:                   pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &docdb.ElasticClusterTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var elasticClusterResource = new ElasticCluster("elasticClusterResource", ElasticClusterArgs.builder()
    .shardCapacity(0)
    .adminUserPassword("string")
    .authType("string")
    .adminUserName("string")
    .shardCount(0)
    .backupRetentionPeriod(0)
    .preferredBackupWindow("string")
    .preferredMaintenanceWindow("string")
    .name("string")
    .kmsKeyId("string")
    .subnetIds("string")
    .tags(Map.of("string", "string"))
    .timeouts(ElasticClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .vpcSecurityGroupIds("string")
    .build());

    elastic_cluster_resource = aws.docdb.ElasticCluster("elasticClusterResource",
    shard_capacity=0,
    admin_user_password="string",
    auth_type="string",
    admin_user_name="string",
    shard_count=0,
    backup_retention_period=0,
    preferred_backup_window="string",
    preferred_maintenance_window="string",
    name="string",
    kms_key_id="string",
    subnet_ids=["string"],
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    vpc_security_group_ids=["string"])

    const elasticClusterResource = new aws.docdb.ElasticCluster("elasticClusterResource", {
    shardCapacity: 0,
    adminUserPassword: "string",
    authType: "string",
    adminUserName: "string",
    shardCount: 0,
    backupRetentionPeriod: 0,
    preferredBackupWindow: "string",
    preferredMaintenanceWindow: "string",
    name: "string",
    kmsKeyId: "string",
    subnetIds: ["string"],
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    vpcSecurityGroupIds: ["string"],
});

    type: aws:docdb:ElasticCluster
properties:
    adminUserName: string
    adminUserPassword: string
    authType: string
    backupRetentionPeriod: 0
    kmsKeyId: string
    name: string
    preferredBackupWindow: string
    preferredMaintenanceWindow: string
    shardCapacity: 0
    shardCount: 0
    subnetIds:
        - string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    vpcSecurityGroupIds:
        - string

    ElasticCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ElasticCluster resource accepts the following input properties:

    AdminUserName string
    Name of the Elastic DocumentDB cluster administrator
    AdminUserPassword string
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    AuthType string
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    ShardCapacity int
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    ShardCount int

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    BackupRetentionPeriod double
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    KmsKeyId string
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    Name string
    Name of the Elastic DocumentDB cluster
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    PreferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    SubnetIds List<string>
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    Tags Dictionary<string, string>
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts ElasticClusterTimeouts
    VpcSecurityGroupIds List<string>
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    AdminUserName string
    Name of the Elastic DocumentDB cluster administrator
    AdminUserPassword string
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    AuthType string
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    ShardCapacity int
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    ShardCount int

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    BackupRetentionPeriod float64
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    KmsKeyId string
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    Name string
    Name of the Elastic DocumentDB cluster
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    PreferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    SubnetIds []string
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    Tags map[string]string
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts ElasticClusterTimeoutsArgs
    VpcSecurityGroupIds []string
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    adminUserName String
    Name of the Elastic DocumentDB cluster administrator
    adminUserPassword String
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    authType String
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    shardCapacity Integer
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shardCount Integer

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    backupRetentionPeriod Double
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    kmsKeyId String
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name String
    Name of the Elastic DocumentDB cluster
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferredMaintenanceWindow String
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    subnetIds List<String>
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags Map<String,String>
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ElasticClusterTimeouts
    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    adminUserName string
    Name of the Elastic DocumentDB cluster administrator
    adminUserPassword string
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    authType string
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    shardCapacity number
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shardCount number

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    backupRetentionPeriod number
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    kmsKeyId string
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name string
    Name of the Elastic DocumentDB cluster
    preferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    subnetIds string[]
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags {[key: string]: string}
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ElasticClusterTimeouts
    vpcSecurityGroupIds string[]
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    admin_user_name str
    Name of the Elastic DocumentDB cluster administrator
    admin_user_password str
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    auth_type str
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    shard_capacity int
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shard_count int

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    backup_retention_period float
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    kms_key_id str
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name str
    Name of the Elastic DocumentDB cluster
    preferred_backup_window str
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferred_maintenance_window str
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    subnet_ids Sequence[str]
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags Mapping[str, str]
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts ElasticClusterTimeoutsArgs
    vpc_security_group_ids Sequence[str]
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    adminUserName String
    Name of the Elastic DocumentDB cluster administrator
    adminUserPassword String
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    authType String
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    shardCapacity Number
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shardCount Number

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    backupRetentionPeriod Number
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    kmsKeyId String
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name String
    Name of the Elastic DocumentDB cluster
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferredMaintenanceWindow String
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    subnetIds List<String>
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags Map<String>
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map
    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Elastic DocumentDB Cluster

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ElasticCluster resource produces the following output properties:

    Arn string
    ARN of the DocumentDB Elastic Cluster
    Endpoint string
    The DNS address of the DocDB instance
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the DocumentDB Elastic Cluster
    Endpoint string
    The DNS address of the DocDB instance
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the DocumentDB Elastic Cluster
    endpoint String
    The DNS address of the DocDB instance
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the DocumentDB Elastic Cluster
    endpoint string
    The DNS address of the DocDB instance
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the DocumentDB Elastic Cluster
    endpoint str
    The DNS address of the DocDB instance
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the DocumentDB Elastic Cluster
    endpoint String
    The DNS address of the DocDB instance
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing ElasticCluster Resource

    Get an existing ElasticCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ElasticClusterState, opts?: CustomResourceOptions): ElasticCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_user_name: Optional[str] = None,
        admin_user_password: Optional[str] = None,
        arn: Optional[str] = None,
        auth_type: Optional[str] = None,
        backup_retention_period: Optional[float] = None,
        endpoint: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        name: Optional[str] = None,
        preferred_backup_window: Optional[str] = None,
        preferred_maintenance_window: Optional[str] = None,
        shard_capacity: Optional[int] = None,
        shard_count: Optional[int] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[ElasticClusterTimeoutsArgs] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None) -> ElasticCluster
    func GetElasticCluster(ctx *Context, name string, id IDInput, state *ElasticClusterState, opts ...ResourceOption) (*ElasticCluster, error)
    public static ElasticCluster Get(string name, Input<string> id, ElasticClusterState? state, CustomResourceOptions? opts = null)
    public static ElasticCluster get(String name, Output<String> id, ElasticClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdminUserName string
    Name of the Elastic DocumentDB cluster administrator
    AdminUserPassword string
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    Arn string
    ARN of the DocumentDB Elastic Cluster
    AuthType string
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    BackupRetentionPeriod double
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    Endpoint string
    The DNS address of the DocDB instance
    KmsKeyId string
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    Name string
    Name of the Elastic DocumentDB cluster
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    PreferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    ShardCapacity int
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    ShardCount int

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    SubnetIds List<string>
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    Tags Dictionary<string, string>
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Timeouts ElasticClusterTimeouts
    VpcSecurityGroupIds List<string>
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    AdminUserName string
    Name of the Elastic DocumentDB cluster administrator
    AdminUserPassword string
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    Arn string
    ARN of the DocumentDB Elastic Cluster
    AuthType string
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    BackupRetentionPeriod float64
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    Endpoint string
    The DNS address of the DocDB instance
    KmsKeyId string
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    Name string
    Name of the Elastic DocumentDB cluster
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    PreferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    ShardCapacity int
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    ShardCount int

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    SubnetIds []string
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    Tags map[string]string
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Timeouts ElasticClusterTimeoutsArgs
    VpcSecurityGroupIds []string
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    adminUserName String
    Name of the Elastic DocumentDB cluster administrator
    adminUserPassword String
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    arn String
    ARN of the DocumentDB Elastic Cluster
    authType String
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    backupRetentionPeriod Double
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    endpoint String
    The DNS address of the DocDB instance
    kmsKeyId String
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name String
    Name of the Elastic DocumentDB cluster
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferredMaintenanceWindow String
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    shardCapacity Integer
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shardCount Integer

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    subnetIds List<String>
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags Map<String,String>
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    timeouts ElasticClusterTimeouts
    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    adminUserName string
    Name of the Elastic DocumentDB cluster administrator
    adminUserPassword string
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    arn string
    ARN of the DocumentDB Elastic Cluster
    authType string
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    backupRetentionPeriod number
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    endpoint string
    The DNS address of the DocDB instance
    kmsKeyId string
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name string
    Name of the Elastic DocumentDB cluster
    preferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferredMaintenanceWindow string
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    shardCapacity number
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shardCount number

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    subnetIds string[]
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags {[key: string]: string}
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    timeouts ElasticClusterTimeouts
    vpcSecurityGroupIds string[]
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    admin_user_name str
    Name of the Elastic DocumentDB cluster administrator
    admin_user_password str
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    arn str
    ARN of the DocumentDB Elastic Cluster
    auth_type str
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    backup_retention_period float
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    endpoint str
    The DNS address of the DocDB instance
    kms_key_id str
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name str
    Name of the Elastic DocumentDB cluster
    preferred_backup_window str
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferred_maintenance_window str
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    shard_capacity int
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shard_count int

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    subnet_ids Sequence[str]
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags Mapping[str, str]
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    timeouts ElasticClusterTimeoutsArgs
    vpc_security_group_ids Sequence[str]
    List of VPC security groups to associate with the Elastic DocumentDB Cluster
    adminUserName String
    Name of the Elastic DocumentDB cluster administrator
    adminUserPassword String
    Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
    arn String
    ARN of the DocumentDB Elastic Cluster
    authType String
    Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
    backupRetentionPeriod Number
    The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
    endpoint String
    The DNS address of the DocDB instance
    kmsKeyId String
    ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
    name String
    Name of the Elastic DocumentDB cluster
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backup_retention_period.
    preferredMaintenanceWindow String
    Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
    shardCapacity Number
    Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
    shardCount Number

    Number of shards assigned to the elastic cluster. Maximum is 32

    The following arguments are optional:

    subnetIds List<String>
    IDs of subnets in which the Elastic DocumentDB Cluster operates.
    tags Map<String>
    A map of tags to assign to the collection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    timeouts Property Map
    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Elastic DocumentDB Cluster

    Supporting Types

    ElasticClusterTimeouts, ElasticClusterTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import DocDB (DocumentDB) Elastic Cluster using the arn argument. For example,

    $ pulumi import aws:docdb/elasticCluster:ElasticCluster example arn:aws:docdb-elastic:us-east-1:000011112222:cluster/12345678-7abc-def0-1234-56789abcdef

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws