Try AWS Native preview for resources not in the classic version.
aws.docdb.Cluster
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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
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()
{
BackupRetentionPeriod = 5,
ClusterIdentifier = "my-docdb-cluster",
Engine = "docdb",
MasterPassword = "mustbeeightchars",
MasterUsername = "foo",
PreferredBackupWindow = "07:00-09:00",
SkipFinalSnapshot = 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{
BackupRetentionPeriod: pulumi.Int(5),
ClusterIdentifier: pulumi.String("my-docdb-cluster"),
Engine: pulumi.String("docdb"),
MasterPassword: pulumi.String("mustbeeightchars"),
MasterUsername: pulumi.String("foo"),
PreferredBackupWindow: pulumi.String("07:00-09:00"),
SkipFinalSnapshot: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.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()
.backupRetentionPeriod(5)
.clusterIdentifier("my-docdb-cluster")
.engine("docdb")
.masterPassword("mustbeeightchars")
.masterUsername("foo")
.preferredBackupWindow("07:00-09:00")
.skipFinalSnapshot(true)
.build());
}
}
import pulumi
import pulumi_aws as aws
docdb = aws.docdb.Cluster("docdb",
backup_retention_period=5,
cluster_identifier="my-docdb-cluster",
engine="docdb",
master_password="mustbeeightchars",
master_username="foo",
preferred_backup_window="07:00-09:00",
skip_final_snapshot=True)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const docdb = new aws.docdb.Cluster("docdb", {
backupRetentionPeriod: 5,
clusterIdentifier: "my-docdb-cluster",
engine: "docdb",
masterPassword: "mustbeeightchars",
masterUsername: "foo",
preferredBackupWindow: "07:00-09:00",
skipFinalSnapshot: true,
});
resources:
docdb:
type: aws:docdb:Cluster
properties:
backupRetentionPeriod: 5
clusterIdentifier: my-docdb-cluster
engine: docdb
masterPassword: mustbeeightchars
masterUsername: foo
preferredBackupWindow: 07:00-09:00
skipFinalSnapshot: true
Create Cluster Resource
new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = 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,
tags: Optional[Mapping[str, str]] = None,
vpc_security_group_ids: Optional[Sequence[str]] = None)
@overload
def Cluster(resource_name: str,
args: Optional[ClusterArgs] = None,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Apply
Immediately bool Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false
.- Availability
Zones List<string> A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- Backup
Retention intPeriod The days to retain backups for. Default
1
- Cluster
Identifier string The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- Cluster
Identifier stringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- Cluster
Members List<string> List of DocumentDB Instances that are a part of this cluster
- Db
Cluster stringParameter Group Name A cluster parameter group to associate with the cluster.
- Db
Subnet stringGroup Name 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 List<string>Logs Exports 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
- Engine
Version string The database engine version. Updating this argument results in an outage.
- Final
Snapshot stringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- Global
Cluster stringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- Master
Password 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.
- Master
Username string Username for the master DB user.
- Port int
The port on which the DB accepts connections
- Preferred
Backup stringWindow 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 stringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- Vpc
Security List<string>Group Ids List of VPC security groups to associate with the Cluster
- Apply
Immediately bool Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false
.- Availability
Zones []string A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- Backup
Retention intPeriod The days to retain backups for. Default
1
- Cluster
Identifier string The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- Cluster
Identifier stringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- Cluster
Members []string List of DocumentDB Instances that are a part of this cluster
- Db
Cluster stringParameter Group Name A cluster parameter group to associate with the cluster.
- Db
Subnet stringGroup Name 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 []stringLogs Exports 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
- Engine
Version string The database engine version. Updating this argument results in an outage.
- Final
Snapshot stringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- Global
Cluster stringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- Master
Password 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.
- Master
Username string Username for the master DB user.
- Port int
The port on which the DB accepts connections
- Preferred
Backup stringWindow 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 stringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- Vpc
Security []stringGroup Ids List of VPC security groups to associate with the Cluster
- apply
Immediately Boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false
.- availability
Zones List<String> A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention IntegerPeriod The days to retain backups for. Default
1
- cluster
Identifier String The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- cluster
Identifier StringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- cluster
Members List<String> List of DocumentDB Instances that are a part of this cluster
- db
Cluster StringParameter Group Name A cluster parameter group to associate with the cluster.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance.
- deletion
Protection 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.
- enabled
Cloudwatch List<String>Logs Exports 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
- engine
Version String The database engine version. Updating this argument results in an outage.
- final
Snapshot StringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global
Cluster StringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- master
Password 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.
- master
Username String Username for the master DB user.
- port Integer
The port on which the DB accepts connections
- preferred
Backup StringWindow 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 StringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- vpc
Security List<String>Group Ids List of VPC security groups to associate with the Cluster
- apply
Immediately boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false
.- availability
Zones string[] A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention numberPeriod The days to retain backups for. Default
1
- cluster
Identifier string The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- cluster
Identifier stringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- cluster
Members string[] List of DocumentDB Instances that are a part of this cluster
- db
Cluster stringParameter Group Name A cluster parameter group to associate with the cluster.
- db
Subnet stringGroup Name A DB subnet group to associate with this DB instance.
- deletion
Protection 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.
- enabled
Cloudwatch string[]Logs Exports 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
- engine
Version string The database engine version. Updating this argument results in an outage.
- final
Snapshot stringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global
Cluster stringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- master
Password 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.
- master
Username string Username for the master DB user.
- port number
The port on which the DB accepts connections
- preferred
Backup stringWindow 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 stringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- skip
Final booleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted boolean Specifies whether the DB cluster is encrypted. The default is
false
.- {[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.- vpc
Security string[]Group Ids List of VPC security groups to associate with the Cluster
- 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_ intperiod 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_ strprefix 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_ strparameter_ group_ name A cluster parameter group to associate with the cluster.
- db_
subnet_ strgroup_ name 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_ Sequence[str]logs_ exports 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_ stridentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global_
cluster_ stridentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- kms_
key_ strid 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_ strwindow 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_ strwindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- skip_
final_ boolsnapshot 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 isfalse
.- 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
.- 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_ Sequence[str]group_ ids List of VPC security groups to associate with the Cluster
- apply
Immediately Boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false
.- availability
Zones List<String> A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention NumberPeriod The days to retain backups for. Default
1
- cluster
Identifier String The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- cluster
Identifier StringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- cluster
Members List<String> List of DocumentDB Instances that are a part of this cluster
- db
Cluster StringParameter Group Name A cluster parameter group to associate with the cluster.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance.
- deletion
Protection 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.
- enabled
Cloudwatch List<String>Logs Exports 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
- engine
Version String The database engine version. Updating this argument results in an outage.
- final
Snapshot StringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global
Cluster StringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- master
Password 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.
- master
Username String Username for the master DB user.
- port Number
The port on which the DB accepts connections
- preferred
Backup StringWindow 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 StringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- vpc
Security List<String>Group Ids 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
- Cluster
Resource stringId The DocumentDB Cluster Resource ID
- Endpoint string
The DNS address of the DocumentDB instance
- Hosted
Zone stringId The Route53 Hosted Zone ID of the endpoint
- Id string
The provider-assigned unique ID for this managed resource.
- Reader
Endpoint string A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- Arn string
Amazon Resource Name (ARN) of cluster
- Cluster
Resource stringId The DocumentDB Cluster Resource ID
- Endpoint string
The DNS address of the DocumentDB instance
- Hosted
Zone stringId The Route53 Hosted Zone ID of the endpoint
- Id string
The provider-assigned unique ID for this managed resource.
- Reader
Endpoint string A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
Amazon Resource Name (ARN) of cluster
- cluster
Resource StringId The DocumentDB Cluster Resource ID
- endpoint String
The DNS address of the DocumentDB instance
- hosted
Zone StringId The Route53 Hosted Zone ID of the endpoint
- id String
The provider-assigned unique ID for this managed resource.
- reader
Endpoint String A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn string
Amazon Resource Name (ARN) of cluster
- cluster
Resource stringId The DocumentDB Cluster Resource ID
- endpoint string
The DNS address of the DocumentDB instance
- hosted
Zone stringId The Route53 Hosted Zone ID of the endpoint
- id string
The provider-assigned unique ID for this managed resource.
- reader
Endpoint string A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn str
Amazon Resource Name (ARN) of cluster
- cluster_
resource_ strid The DocumentDB Cluster Resource ID
- endpoint str
The DNS address of the DocumentDB instance
- hosted_
zone_ strid 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
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
Amazon Resource Name (ARN) of cluster
- cluster
Resource StringId The DocumentDB Cluster Resource ID
- endpoint String
The DNS address of the DocumentDB instance
- hosted
Zone StringId The Route53 Hosted Zone ID of the endpoint
- id String
The provider-assigned unique ID for this managed resource.
- reader
Endpoint String A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.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,
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,
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.
- Apply
Immediately 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
- Availability
Zones List<string> A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- Backup
Retention intPeriod The days to retain backups for. Default
1
- Cluster
Identifier string The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- Cluster
Identifier stringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- Cluster
Members List<string> List of DocumentDB Instances that are a part of this cluster
- Cluster
Resource stringId The DocumentDB Cluster Resource ID
- Db
Cluster stringParameter Group Name A cluster parameter group to associate with the cluster.
- Db
Subnet stringGroup Name 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 List<string>Logs Exports 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
- Engine
Version string The database engine version. Updating this argument results in an outage.
- Final
Snapshot stringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- Global
Cluster stringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- Hosted
Zone stringId The Route53 Hosted Zone ID of the endpoint
- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- Master
Password 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.
- Master
Username string Username for the master DB user.
- Port int
The port on which the DB accepts connections
- Preferred
Backup stringWindow 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 stringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- Reader
Endpoint string A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Vpc
Security List<string>Group Ids List of VPC security groups to associate with the Cluster
- Apply
Immediately 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
- Availability
Zones []string A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- Backup
Retention intPeriod The days to retain backups for. Default
1
- Cluster
Identifier string The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- Cluster
Identifier stringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- Cluster
Members []string List of DocumentDB Instances that are a part of this cluster
- Cluster
Resource stringId The DocumentDB Cluster Resource ID
- Db
Cluster stringParameter Group Name A cluster parameter group to associate with the cluster.
- Db
Subnet stringGroup Name 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 []stringLogs Exports 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
- Engine
Version string The database engine version. Updating this argument results in an outage.
- Final
Snapshot stringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- Global
Cluster stringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- Hosted
Zone stringId The Route53 Hosted Zone ID of the endpoint
- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- Master
Password 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.
- Master
Username string Username for the master DB user.
- Port int
The port on which the DB accepts connections
- Preferred
Backup stringWindow 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 stringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- Reader
Endpoint string A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Vpc
Security []stringGroup Ids List of VPC security groups to associate with the Cluster
- apply
Immediately 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
- availability
Zones List<String> A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention IntegerPeriod The days to retain backups for. Default
1
- cluster
Identifier String The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- cluster
Identifier StringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- cluster
Members List<String> List of DocumentDB Instances that are a part of this cluster
- cluster
Resource StringId The DocumentDB Cluster Resource ID
- db
Cluster StringParameter Group Name A cluster parameter group to associate with the cluster.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance.
- deletion
Protection 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.
- enabled
Cloudwatch List<String>Logs Exports 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
- engine
Version String The database engine version. Updating this argument results in an outage.
- final
Snapshot StringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global
Cluster StringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- hosted
Zone StringId The Route53 Hosted Zone ID of the endpoint
- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- master
Password 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.
- master
Username String Username for the master DB user.
- port Integer
The port on which the DB accepts connections
- preferred
Backup StringWindow 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 StringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- reader
Endpoint String A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Security List<String>Group Ids List of VPC security groups to associate with the Cluster
- apply
Immediately 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
- availability
Zones string[] A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention numberPeriod The days to retain backups for. Default
1
- cluster
Identifier string The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- cluster
Identifier stringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- cluster
Members string[] List of DocumentDB Instances that are a part of this cluster
- cluster
Resource stringId The DocumentDB Cluster Resource ID
- db
Cluster stringParameter Group Name A cluster parameter group to associate with the cluster.
- db
Subnet stringGroup Name A DB subnet group to associate with this DB instance.
- deletion
Protection 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.
- enabled
Cloudwatch string[]Logs Exports 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
- engine
Version string The database engine version. Updating this argument results in an outage.
- final
Snapshot stringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global
Cluster stringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- hosted
Zone stringId The Route53 Hosted Zone ID of the endpoint
- kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- master
Password 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.
- master
Username string Username for the master DB user.
- port number
The port on which the DB accepts connections
- preferred
Backup stringWindow 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 stringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- reader
Endpoint string A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- skip
Final booleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted boolean Specifies whether the DB cluster is encrypted. The default is
false
.- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Security string[]Group Ids List of VPC security groups to associate with the Cluster
- 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_ intperiod 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_ strprefix 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_ strid The DocumentDB Cluster Resource ID
- db_
cluster_ strparameter_ group_ name A cluster parameter group to associate with the cluster.
- db_
subnet_ strgroup_ name 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_ Sequence[str]logs_ exports 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_ stridentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global_
cluster_ stridentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- hosted_
zone_ strid The Route53 Hosted Zone ID of the endpoint
- kms_
key_ strid 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_ strwindow 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_ strwindow 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_ boolsnapshot 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 isfalse
.- 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
.- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc_
security_ Sequence[str]group_ ids List of VPC security groups to associate with the Cluster
- apply
Immediately 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
- availability
Zones List<String> A list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention NumberPeriod The days to retain backups for. Default
1
- cluster
Identifier String The cluster identifier. If omitted, the provider will assign a random, unique identifier.
- cluster
Identifier StringPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with
cluster_identifier
.- cluster
Members List<String> List of DocumentDB Instances that are a part of this cluster
- cluster
Resource StringId The DocumentDB Cluster Resource ID
- db
Cluster StringParameter Group Name A cluster parameter group to associate with the cluster.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance.
- deletion
Protection 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.
- enabled
Cloudwatch List<String>Logs Exports 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
- engine
Version String The database engine version. Updating this argument results in an outage.
- final
Snapshot StringIdentifier The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
- global
Cluster StringIdentifier The global cluster identifier specified on
aws.docdb.GlobalCluster
.- hosted
Zone StringId The Route53 Hosted Zone ID of the endpoint
- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id
,storage_encrypted
needs to be set to true.- master
Password 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.
- master
Username String Username for the master DB user.
- port Number
The port on which the DB accepts connections
- preferred
Backup StringWindow 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 StringWindow The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
- reader
Endpoint String A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted. The default is
false
.- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- vpc
Security List<String>Group Ids 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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.