1. Packages
  2. AWS Classic
  3. API Docs
  4. docdb
  5. Cluster

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

aws.docdb.Cluster

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

    Manages a DocumentDB Cluster.

    Changes to a DocumentDB Cluster can occur when you manually change a parameter, such as port, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

    Note: using apply_immediately can result in a brief downtime as the server reboots.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const docdb = new aws.docdb.Cluster("docdb", {
        clusterIdentifier: "my-docdb-cluster",
        engine: "docdb",
        masterUsername: "foo",
        masterPassword: "mustbeeightchars",
        backupRetentionPeriod: 5,
        preferredBackupWindow: "07:00-09:00",
        skipFinalSnapshot: true,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    docdb = aws.docdb.Cluster("docdb",
        cluster_identifier="my-docdb-cluster",
        engine="docdb",
        master_username="foo",
        master_password="mustbeeightchars",
        backup_retention_period=5,
        preferred_backup_window="07:00-09:00",
        skip_final_snapshot=True)
    
    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.NewCluster(ctx, "docdb", &docdb.ClusterArgs{
    			ClusterIdentifier:     pulumi.String("my-docdb-cluster"),
    			Engine:                pulumi.String("docdb"),
    			MasterUsername:        pulumi.String("foo"),
    			MasterPassword:        pulumi.String("mustbeeightchars"),
    			BackupRetentionPeriod: pulumi.Int(5),
    			PreferredBackupWindow: pulumi.String("07:00-09:00"),
    			SkipFinalSnapshot:     pulumi.Bool(true),
    		})
    		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 docdb = new Aws.DocDB.Cluster("docdb", new()
        {
            ClusterIdentifier = "my-docdb-cluster",
            Engine = "docdb",
            MasterUsername = "foo",
            MasterPassword = "mustbeeightchars",
            BackupRetentionPeriod = 5,
            PreferredBackupWindow = "07:00-09:00",
            SkipFinalSnapshot = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.docdb.Cluster;
    import com.pulumi.aws.docdb.ClusterArgs;
    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 docdb = new Cluster("docdb", ClusterArgs.builder()        
                .clusterIdentifier("my-docdb-cluster")
                .engine("docdb")
                .masterUsername("foo")
                .masterPassword("mustbeeightchars")
                .backupRetentionPeriod(5)
                .preferredBackupWindow("07:00-09:00")
                .skipFinalSnapshot(true)
                .build());
    
        }
    }
    
    resources:
      docdb:
        type: aws:docdb:Cluster
        properties:
          clusterIdentifier: my-docdb-cluster
          engine: docdb
          masterUsername: foo
          masterPassword: mustbeeightchars
          backupRetentionPeriod: 5
          preferredBackupWindow: 07:00-09:00
          skipFinalSnapshot: true
    

    Create Cluster Resource

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

    Constructor syntax

    new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: Optional[ClusterArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                allow_major_version_upgrade: Optional[bool] = None,
                apply_immediately: Optional[bool] = None,
                availability_zones: Optional[Sequence[str]] = None,
                backup_retention_period: Optional[int] = None,
                cluster_identifier: Optional[str] = None,
                cluster_identifier_prefix: Optional[str] = None,
                cluster_members: Optional[Sequence[str]] = None,
                db_cluster_parameter_group_name: Optional[str] = None,
                db_subnet_group_name: Optional[str] = None,
                deletion_protection: Optional[bool] = None,
                enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
                engine: Optional[str] = None,
                engine_version: Optional[str] = None,
                final_snapshot_identifier: Optional[str] = None,
                global_cluster_identifier: Optional[str] = None,
                kms_key_id: Optional[str] = None,
                master_password: Optional[str] = None,
                master_username: Optional[str] = None,
                port: Optional[int] = None,
                preferred_backup_window: Optional[str] = None,
                preferred_maintenance_window: Optional[str] = None,
                skip_final_snapshot: Optional[bool] = None,
                snapshot_identifier: Optional[str] = None,
                storage_encrypted: Optional[bool] = None,
                storage_type: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                vpc_security_group_ids: Optional[Sequence[str]] = None)
    func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws:docdb:Cluster
    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 ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var exampleclusterResourceResourceFromDocdbcluster = new Aws.DocDB.Cluster("exampleclusterResourceResourceFromDocdbcluster", new()
    {
        AllowMajorVersionUpgrade = false,
        ApplyImmediately = false,
        AvailabilityZones = new[]
        {
            "string",
        },
        BackupRetentionPeriod = 0,
        ClusterIdentifier = "string",
        ClusterIdentifierPrefix = "string",
        ClusterMembers = new[]
        {
            "string",
        },
        DbClusterParameterGroupName = "string",
        DbSubnetGroupName = "string",
        DeletionProtection = false,
        EnabledCloudwatchLogsExports = new[]
        {
            "string",
        },
        Engine = "string",
        EngineVersion = "string",
        FinalSnapshotIdentifier = "string",
        GlobalClusterIdentifier = "string",
        KmsKeyId = "string",
        MasterPassword = "string",
        MasterUsername = "string",
        Port = 0,
        PreferredBackupWindow = "string",
        PreferredMaintenanceWindow = "string",
        SkipFinalSnapshot = false,
        SnapshotIdentifier = "string",
        StorageEncrypted = false,
        StorageType = "string",
        Tags = 
        {
            { "string", "string" },
        },
        VpcSecurityGroupIds = new[]
        {
            "string",
        },
    });
    
    example, err := docdb.NewCluster(ctx, "exampleclusterResourceResourceFromDocdbcluster", &docdb.ClusterArgs{
    	AllowMajorVersionUpgrade: pulumi.Bool(false),
    	ApplyImmediately:         pulumi.Bool(false),
    	AvailabilityZones: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	BackupRetentionPeriod:   pulumi.Int(0),
    	ClusterIdentifier:       pulumi.String("string"),
    	ClusterIdentifierPrefix: pulumi.String("string"),
    	ClusterMembers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DbClusterParameterGroupName: pulumi.String("string"),
    	DbSubnetGroupName:           pulumi.String("string"),
    	DeletionProtection:          pulumi.Bool(false),
    	EnabledCloudwatchLogsExports: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Engine:                     pulumi.String("string"),
    	EngineVersion:              pulumi.String("string"),
    	FinalSnapshotIdentifier:    pulumi.String("string"),
    	GlobalClusterIdentifier:    pulumi.String("string"),
    	KmsKeyId:                   pulumi.String("string"),
    	MasterPassword:             pulumi.String("string"),
    	MasterUsername:             pulumi.String("string"),
    	Port:                       pulumi.Int(0),
    	PreferredBackupWindow:      pulumi.String("string"),
    	PreferredMaintenanceWindow: pulumi.String("string"),
    	SkipFinalSnapshot:          pulumi.Bool(false),
    	SnapshotIdentifier:         pulumi.String("string"),
    	StorageEncrypted:           pulumi.Bool(false),
    	StorageType:                pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	VpcSecurityGroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var exampleclusterResourceResourceFromDocdbcluster = new Cluster("exampleclusterResourceResourceFromDocdbcluster", ClusterArgs.builder()        
        .allowMajorVersionUpgrade(false)
        .applyImmediately(false)
        .availabilityZones("string")
        .backupRetentionPeriod(0)
        .clusterIdentifier("string")
        .clusterIdentifierPrefix("string")
        .clusterMembers("string")
        .dbClusterParameterGroupName("string")
        .dbSubnetGroupName("string")
        .deletionProtection(false)
        .enabledCloudwatchLogsExports("string")
        .engine("string")
        .engineVersion("string")
        .finalSnapshotIdentifier("string")
        .globalClusterIdentifier("string")
        .kmsKeyId("string")
        .masterPassword("string")
        .masterUsername("string")
        .port(0)
        .preferredBackupWindow("string")
        .preferredMaintenanceWindow("string")
        .skipFinalSnapshot(false)
        .snapshotIdentifier("string")
        .storageEncrypted(false)
        .storageType("string")
        .tags(Map.of("string", "string"))
        .vpcSecurityGroupIds("string")
        .build());
    
    examplecluster_resource_resource_from_docdbcluster = aws.docdb.Cluster("exampleclusterResourceResourceFromDocdbcluster",
        allow_major_version_upgrade=False,
        apply_immediately=False,
        availability_zones=["string"],
        backup_retention_period=0,
        cluster_identifier="string",
        cluster_identifier_prefix="string",
        cluster_members=["string"],
        db_cluster_parameter_group_name="string",
        db_subnet_group_name="string",
        deletion_protection=False,
        enabled_cloudwatch_logs_exports=["string"],
        engine="string",
        engine_version="string",
        final_snapshot_identifier="string",
        global_cluster_identifier="string",
        kms_key_id="string",
        master_password="string",
        master_username="string",
        port=0,
        preferred_backup_window="string",
        preferred_maintenance_window="string",
        skip_final_snapshot=False,
        snapshot_identifier="string",
        storage_encrypted=False,
        storage_type="string",
        tags={
            "string": "string",
        },
        vpc_security_group_ids=["string"])
    
    const exampleclusterResourceResourceFromDocdbcluster = new aws.docdb.Cluster("exampleclusterResourceResourceFromDocdbcluster", {
        allowMajorVersionUpgrade: false,
        applyImmediately: false,
        availabilityZones: ["string"],
        backupRetentionPeriod: 0,
        clusterIdentifier: "string",
        clusterIdentifierPrefix: "string",
        clusterMembers: ["string"],
        dbClusterParameterGroupName: "string",
        dbSubnetGroupName: "string",
        deletionProtection: false,
        enabledCloudwatchLogsExports: ["string"],
        engine: "string",
        engineVersion: "string",
        finalSnapshotIdentifier: "string",
        globalClusterIdentifier: "string",
        kmsKeyId: "string",
        masterPassword: "string",
        masterUsername: "string",
        port: 0,
        preferredBackupWindow: "string",
        preferredMaintenanceWindow: "string",
        skipFinalSnapshot: false,
        snapshotIdentifier: "string",
        storageEncrypted: false,
        storageType: "string",
        tags: {
            string: "string",
        },
        vpcSecurityGroupIds: ["string"],
    });
    
    type: aws:docdb:Cluster
    properties:
        allowMajorVersionUpgrade: false
        applyImmediately: false
        availabilityZones:
            - string
        backupRetentionPeriod: 0
        clusterIdentifier: string
        clusterIdentifierPrefix: string
        clusterMembers:
            - string
        dbClusterParameterGroupName: string
        dbSubnetGroupName: string
        deletionProtection: false
        enabledCloudwatchLogsExports:
            - string
        engine: string
        engineVersion: string
        finalSnapshotIdentifier: string
        globalClusterIdentifier: string
        kmsKeyId: string
        masterPassword: string
        masterUsername: string
        port: 0
        preferredBackupWindow: string
        preferredMaintenanceWindow: string
        skipFinalSnapshot: false
        snapshotIdentifier: string
        storageEncrypted: false
        storageType: string
        tags:
            string: string
        vpcSecurityGroupIds:
            - string
    

    Cluster 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 Cluster resource accepts the following input properties:

    AllowMajorVersionUpgrade bool
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    ApplyImmediately bool
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    AvailabilityZones List<string>
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    BackupRetentionPeriod int
    The days to retain backups for. Default 1
    ClusterIdentifier string
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    ClusterIdentifierPrefix string
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    ClusterMembers List<string>
    List of DocumentDB Instances that are a part of this cluster
    DbClusterParameterGroupName string
    A cluster parameter group to associate with the cluster.
    DbSubnetGroupName string
    A DB subnet group to associate with this DB instance.
    DeletionProtection bool
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    EnabledCloudwatchLogsExports List<string>
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    Engine string
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    EngineVersion string
    The database engine version. Updating this argument results in an outage.
    FinalSnapshotIdentifier string
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    GlobalClusterIdentifier string
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    MasterPassword string
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    MasterUsername string
    Username for the master DB user.
    Port int
    The port on which the DB accepts connections
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    SkipFinalSnapshot bool
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    SnapshotIdentifier string
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    StorageEncrypted bool
    Specifies whether the DB cluster is encrypted. The default is false.
    StorageType string
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    Tags Dictionary<string, string>
    A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VpcSecurityGroupIds List<string>
    List of VPC security groups to associate with the Cluster
    AllowMajorVersionUpgrade bool
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    ApplyImmediately bool
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    AvailabilityZones []string
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    BackupRetentionPeriod int
    The days to retain backups for. Default 1
    ClusterIdentifier string
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    ClusterIdentifierPrefix string
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    ClusterMembers []string
    List of DocumentDB Instances that are a part of this cluster
    DbClusterParameterGroupName string
    A cluster parameter group to associate with the cluster.
    DbSubnetGroupName string
    A DB subnet group to associate with this DB instance.
    DeletionProtection bool
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    EnabledCloudwatchLogsExports []string
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    Engine string
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    EngineVersion string
    The database engine version. Updating this argument results in an outage.
    FinalSnapshotIdentifier string
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    GlobalClusterIdentifier string
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    MasterPassword string
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    MasterUsername string
    Username for the master DB user.
    Port int
    The port on which the DB accepts connections
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    SkipFinalSnapshot bool
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    SnapshotIdentifier string
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    StorageEncrypted bool
    Specifies whether the DB cluster is encrypted. The default is false.
    StorageType string
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    Tags map[string]string
    A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VpcSecurityGroupIds []string
    List of VPC security groups to associate with the Cluster
    allowMajorVersionUpgrade Boolean
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    applyImmediately Boolean
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    availabilityZones List<String>
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backupRetentionPeriod Integer
    The days to retain backups for. Default 1
    clusterIdentifier String
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    clusterIdentifierPrefix String
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    clusterMembers List<String>
    List of DocumentDB Instances that are a part of this cluster
    dbClusterParameterGroupName String
    A cluster parameter group to associate with the cluster.
    dbSubnetGroupName String
    A DB subnet group to associate with this DB instance.
    deletionProtection Boolean
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabledCloudwatchLogsExports List<String>
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    engine String
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engineVersion String
    The database engine version. Updating this argument results in an outage.
    finalSnapshotIdentifier String
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    globalClusterIdentifier String
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    masterPassword String
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    masterUsername String
    Username for the master DB user.
    port Integer
    The port on which the DB accepts connections
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    skipFinalSnapshot Boolean
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshotIdentifier String
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storageEncrypted Boolean
    Specifies whether the DB cluster is encrypted. The default is false.
    storageType String
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags Map<String,String>
    A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Cluster
    allowMajorVersionUpgrade boolean
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    applyImmediately boolean
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    availabilityZones string[]
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backupRetentionPeriod number
    The days to retain backups for. Default 1
    clusterIdentifier string
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    clusterIdentifierPrefix string
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    clusterMembers string[]
    List of DocumentDB Instances that are a part of this cluster
    dbClusterParameterGroupName string
    A cluster parameter group to associate with the cluster.
    dbSubnetGroupName string
    A DB subnet group to associate with this DB instance.
    deletionProtection boolean
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabledCloudwatchLogsExports string[]
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    engine string
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engineVersion string
    The database engine version. Updating this argument results in an outage.
    finalSnapshotIdentifier string
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    globalClusterIdentifier string
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    kmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    masterPassword string
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    masterUsername string
    Username for the master DB user.
    port number
    The port on which the DB accepts connections
    preferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    skipFinalSnapshot boolean
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshotIdentifier string
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storageEncrypted boolean
    Specifies whether the DB cluster is encrypted. The default is false.
    storageType string
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags {[key: string]: string}
    A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcSecurityGroupIds string[]
    List of VPC security groups to associate with the Cluster
    allow_major_version_upgrade bool
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    apply_immediately bool
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    availability_zones Sequence[str]
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backup_retention_period int
    The days to retain backups for. Default 1
    cluster_identifier str
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    cluster_identifier_prefix str
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    cluster_members Sequence[str]
    List of DocumentDB Instances that are a part of this cluster
    db_cluster_parameter_group_name str
    A cluster parameter group to associate with the cluster.
    db_subnet_group_name str
    A DB subnet group to associate with this DB instance.
    deletion_protection bool
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabled_cloudwatch_logs_exports Sequence[str]
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    engine str
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engine_version str
    The database engine version. Updating this argument results in an outage.
    final_snapshot_identifier str
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    global_cluster_identifier str
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    kms_key_id str
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    master_password str
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    master_username str
    Username for the master DB user.
    port int
    The port on which the DB accepts connections
    preferred_backup_window str
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferred_maintenance_window str
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    skip_final_snapshot bool
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshot_identifier str
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storage_encrypted bool
    Specifies whether the DB cluster is encrypted. The default is false.
    storage_type str
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags Mapping[str, str]
    A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpc_security_group_ids Sequence[str]
    List of VPC security groups to associate with the Cluster
    allowMajorVersionUpgrade Boolean
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    applyImmediately Boolean
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    availabilityZones List<String>
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backupRetentionPeriod Number
    The days to retain backups for. Default 1
    clusterIdentifier String
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    clusterIdentifierPrefix String
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    clusterMembers List<String>
    List of DocumentDB Instances that are a part of this cluster
    dbClusterParameterGroupName String
    A cluster parameter group to associate with the cluster.
    dbSubnetGroupName String
    A DB subnet group to associate with this DB instance.
    deletionProtection Boolean
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabledCloudwatchLogsExports List<String>
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    engine String
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engineVersion String
    The database engine version. Updating this argument results in an outage.
    finalSnapshotIdentifier String
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    globalClusterIdentifier String
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    masterPassword String
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    masterUsername String
    Username for the master DB user.
    port Number
    The port on which the DB accepts connections
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    skipFinalSnapshot Boolean
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshotIdentifier String
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storageEncrypted Boolean
    Specifies whether the DB cluster is encrypted. The default is false.
    storageType String
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags Map<String>
    A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Cluster

    Outputs

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

    Arn string
    Amazon Resource Name (ARN) of cluster
    ClusterResourceId string
    The DocumentDB Cluster Resource ID
    Endpoint string
    The DNS address of the DocumentDB instance
    HostedZoneId string
    The Route53 Hosted Zone ID of the endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    ReaderEndpoint string
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of cluster
    ClusterResourceId string
    The DocumentDB Cluster Resource ID
    Endpoint string
    The DNS address of the DocumentDB instance
    HostedZoneId string
    The Route53 Hosted Zone ID of the endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    ReaderEndpoint string
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of cluster
    clusterResourceId String
    The DocumentDB Cluster Resource ID
    endpoint String
    The DNS address of the DocumentDB instance
    hostedZoneId String
    The Route53 Hosted Zone ID of the endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    readerEndpoint String
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of cluster
    clusterResourceId string
    The DocumentDB Cluster Resource ID
    endpoint string
    The DNS address of the DocumentDB instance
    hostedZoneId string
    The Route53 Hosted Zone ID of the endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    readerEndpoint string
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of cluster
    cluster_resource_id str
    The DocumentDB Cluster Resource ID
    endpoint str
    The DNS address of the DocumentDB instance
    hosted_zone_id str
    The Route53 Hosted Zone ID of the endpoint
    id str
    The provider-assigned unique ID for this managed resource.
    reader_endpoint str
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of cluster
    clusterResourceId String
    The DocumentDB Cluster Resource ID
    endpoint String
    The DNS address of the DocumentDB instance
    hostedZoneId String
    The Route53 Hosted Zone ID of the endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    readerEndpoint String
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Cluster Resource

    Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_major_version_upgrade: Optional[bool] = None,
            apply_immediately: Optional[bool] = None,
            arn: Optional[str] = None,
            availability_zones: Optional[Sequence[str]] = None,
            backup_retention_period: Optional[int] = None,
            cluster_identifier: Optional[str] = None,
            cluster_identifier_prefix: Optional[str] = None,
            cluster_members: Optional[Sequence[str]] = None,
            cluster_resource_id: Optional[str] = None,
            db_cluster_parameter_group_name: Optional[str] = None,
            db_subnet_group_name: Optional[str] = None,
            deletion_protection: Optional[bool] = None,
            enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
            endpoint: Optional[str] = None,
            engine: Optional[str] = None,
            engine_version: Optional[str] = None,
            final_snapshot_identifier: Optional[str] = None,
            global_cluster_identifier: Optional[str] = None,
            hosted_zone_id: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            master_password: Optional[str] = None,
            master_username: Optional[str] = None,
            port: Optional[int] = None,
            preferred_backup_window: Optional[str] = None,
            preferred_maintenance_window: Optional[str] = None,
            reader_endpoint: Optional[str] = None,
            skip_final_snapshot: Optional[bool] = None,
            snapshot_identifier: Optional[str] = None,
            storage_encrypted: Optional[bool] = None,
            storage_type: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState 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:
    AllowMajorVersionUpgrade bool
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    ApplyImmediately bool
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    Arn string
    Amazon Resource Name (ARN) of cluster
    AvailabilityZones List<string>
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    BackupRetentionPeriod int
    The days to retain backups for. Default 1
    ClusterIdentifier string
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    ClusterIdentifierPrefix string
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    ClusterMembers List<string>
    List of DocumentDB Instances that are a part of this cluster
    ClusterResourceId string
    The DocumentDB Cluster Resource ID
    DbClusterParameterGroupName string
    A cluster parameter group to associate with the cluster.
    DbSubnetGroupName string
    A DB subnet group to associate with this DB instance.
    DeletionProtection bool
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    EnabledCloudwatchLogsExports List<string>
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    Endpoint string
    The DNS address of the DocumentDB instance
    Engine string
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    EngineVersion string
    The database engine version. Updating this argument results in an outage.
    FinalSnapshotIdentifier string
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    GlobalClusterIdentifier string
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    HostedZoneId string
    The Route53 Hosted Zone ID of the endpoint
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    MasterPassword string
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    MasterUsername string
    Username for the master DB user.
    Port int
    The port on which the DB accepts connections
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    ReaderEndpoint string
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    SkipFinalSnapshot bool
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    SnapshotIdentifier string
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    StorageEncrypted bool
    Specifies whether the DB cluster is encrypted. The default is false.
    StorageType string
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    Tags Dictionary<string, string>
    A map of tags to assign to the DB cluster. 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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcSecurityGroupIds List<string>
    List of VPC security groups to associate with the Cluster
    AllowMajorVersionUpgrade bool
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    ApplyImmediately bool
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    Arn string
    Amazon Resource Name (ARN) of cluster
    AvailabilityZones []string
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    BackupRetentionPeriod int
    The days to retain backups for. Default 1
    ClusterIdentifier string
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    ClusterIdentifierPrefix string
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    ClusterMembers []string
    List of DocumentDB Instances that are a part of this cluster
    ClusterResourceId string
    The DocumentDB Cluster Resource ID
    DbClusterParameterGroupName string
    A cluster parameter group to associate with the cluster.
    DbSubnetGroupName string
    A DB subnet group to associate with this DB instance.
    DeletionProtection bool
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    EnabledCloudwatchLogsExports []string
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    Endpoint string
    The DNS address of the DocumentDB instance
    Engine string
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    EngineVersion string
    The database engine version. Updating this argument results in an outage.
    FinalSnapshotIdentifier string
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    GlobalClusterIdentifier string
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    HostedZoneId string
    The Route53 Hosted Zone ID of the endpoint
    KmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    MasterPassword string
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    MasterUsername string
    Username for the master DB user.
    Port int
    The port on which the DB accepts connections
    PreferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    ReaderEndpoint string
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    SkipFinalSnapshot bool
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    SnapshotIdentifier string
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    StorageEncrypted bool
    Specifies whether the DB cluster is encrypted. The default is false.
    StorageType string
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    Tags map[string]string
    A map of tags to assign to the DB cluster. 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
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcSecurityGroupIds []string
    List of VPC security groups to associate with the Cluster
    allowMajorVersionUpgrade Boolean
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    applyImmediately Boolean
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    arn String
    Amazon Resource Name (ARN) of cluster
    availabilityZones List<String>
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backupRetentionPeriod Integer
    The days to retain backups for. Default 1
    clusterIdentifier String
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    clusterIdentifierPrefix String
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    clusterMembers List<String>
    List of DocumentDB Instances that are a part of this cluster
    clusterResourceId String
    The DocumentDB Cluster Resource ID
    dbClusterParameterGroupName String
    A cluster parameter group to associate with the cluster.
    dbSubnetGroupName String
    A DB subnet group to associate with this DB instance.
    deletionProtection Boolean
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabledCloudwatchLogsExports List<String>
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    endpoint String
    The DNS address of the DocumentDB instance
    engine String
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engineVersion String
    The database engine version. Updating this argument results in an outage.
    finalSnapshotIdentifier String
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    globalClusterIdentifier String
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    hostedZoneId String
    The Route53 Hosted Zone ID of the endpoint
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    masterPassword String
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    masterUsername String
    Username for the master DB user.
    port Integer
    The port on which the DB accepts connections
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    readerEndpoint String
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    skipFinalSnapshot Boolean
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshotIdentifier String
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storageEncrypted Boolean
    Specifies whether the DB cluster is encrypted. The default is false.
    storageType String
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags Map<String,String>
    A map of tags to assign to the DB cluster. 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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Cluster
    allowMajorVersionUpgrade boolean
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    applyImmediately boolean
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    arn string
    Amazon Resource Name (ARN) of cluster
    availabilityZones string[]
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backupRetentionPeriod number
    The days to retain backups for. Default 1
    clusterIdentifier string
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    clusterIdentifierPrefix string
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    clusterMembers string[]
    List of DocumentDB Instances that are a part of this cluster
    clusterResourceId string
    The DocumentDB Cluster Resource ID
    dbClusterParameterGroupName string
    A cluster parameter group to associate with the cluster.
    dbSubnetGroupName string
    A DB subnet group to associate with this DB instance.
    deletionProtection boolean
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabledCloudwatchLogsExports string[]
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    endpoint string
    The DNS address of the DocumentDB instance
    engine string
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engineVersion string
    The database engine version. Updating this argument results in an outage.
    finalSnapshotIdentifier string
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    globalClusterIdentifier string
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    hostedZoneId string
    The Route53 Hosted Zone ID of the endpoint
    kmsKeyId string
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    masterPassword string
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    masterUsername string
    Username for the master DB user.
    port number
    The port on which the DB accepts connections
    preferredBackupWindow string
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    readerEndpoint string
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    skipFinalSnapshot boolean
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshotIdentifier string
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storageEncrypted boolean
    Specifies whether the DB cluster is encrypted. The default is false.
    storageType string
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags {[key: string]: string}
    A map of tags to assign to the DB cluster. 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}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcSecurityGroupIds string[]
    List of VPC security groups to associate with the Cluster
    allow_major_version_upgrade bool
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    apply_immediately bool
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    arn str
    Amazon Resource Name (ARN) of cluster
    availability_zones Sequence[str]
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backup_retention_period int
    The days to retain backups for. Default 1
    cluster_identifier str
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    cluster_identifier_prefix str
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    cluster_members Sequence[str]
    List of DocumentDB Instances that are a part of this cluster
    cluster_resource_id str
    The DocumentDB Cluster Resource ID
    db_cluster_parameter_group_name str
    A cluster parameter group to associate with the cluster.
    db_subnet_group_name str
    A DB subnet group to associate with this DB instance.
    deletion_protection bool
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabled_cloudwatch_logs_exports Sequence[str]
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    endpoint str
    The DNS address of the DocumentDB instance
    engine str
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engine_version str
    The database engine version. Updating this argument results in an outage.
    final_snapshot_identifier str
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    global_cluster_identifier str
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    hosted_zone_id str
    The Route53 Hosted Zone ID of the endpoint
    kms_key_id str
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    master_password str
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    master_username str
    Username for the master DB user.
    port int
    The port on which the DB accepts connections
    preferred_backup_window str
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferred_maintenance_window str
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    reader_endpoint str
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    skip_final_snapshot bool
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshot_identifier str
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storage_encrypted bool
    Specifies whether the DB cluster is encrypted. The default is false.
    storage_type str
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags Mapping[str, str]
    A map of tags to assign to the DB cluster. 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]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpc_security_group_ids Sequence[str]
    List of VPC security groups to associate with the Cluster
    allowMajorVersionUpgrade Boolean
    A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
    applyImmediately Boolean
    Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
    arn String
    Amazon Resource Name (ARN) of cluster
    availabilityZones List<String>
    A list of EC2 Availability Zones that instances in the DB cluster can be created in.
    backupRetentionPeriod Number
    The days to retain backups for. Default 1
    clusterIdentifier String
    The cluster identifier. If omitted, the provider will assign a random, unique identifier.
    clusterIdentifierPrefix String
    Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
    clusterMembers List<String>
    List of DocumentDB Instances that are a part of this cluster
    clusterResourceId String
    The DocumentDB Cluster Resource ID
    dbClusterParameterGroupName String
    A cluster parameter group to associate with the cluster.
    dbSubnetGroupName String
    A DB subnet group to associate with this DB instance.
    deletionProtection Boolean
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    enabledCloudwatchLogsExports List<String>
    List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
    endpoint String
    The DNS address of the DocumentDB instance
    engine String
    The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb.
    engineVersion String
    The database engine version. Updating this argument results in an outage.
    finalSnapshotIdentifier String
    The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
    globalClusterIdentifier String
    The global cluster identifier specified on aws.docdb.GlobalCluster.
    hostedZoneId String
    The Route53 Hosted Zone ID of the endpoint
    kmsKeyId String
    The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
    masterPassword String
    Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
    masterUsername String
    Username for the master DB user.
    port Number
    The port on which the DB accepts connections
    preferredBackupWindow String
    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
    preferredMaintenanceWindow String
    The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
    readerEndpoint String
    A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
    skipFinalSnapshot Boolean
    Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
    snapshotIdentifier String
    Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
    storageEncrypted Boolean
    Specifies whether the DB cluster is encrypted. The default is false.
    storageType String
    The storage type to associate with the DB cluster. Valid values: standard, iopt1.
    tags Map<String>
    A map of tags to assign to the DB cluster. 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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcSecurityGroupIds List<String>
    List of VPC security groups to associate with the Cluster

    Import

    Using pulumi import, import DocumentDB Clusters using the cluster_identifier. For example:

    $ pulumi import aws:docdb/cluster:Cluster docdb_cluster docdb-prod-cluster
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi