aws::docdb-cluster¶

Creates an Document db cluster.

Example¶

aws::docdb-cluster db-cluster-example
    identifier: "db-cluster-example"
    db-subnet-group: $(aws::db-subnet-group db-subnet-group-db-cluster-example)
    engine: "docdb"
    engine-version: "3.6.0"
    db-cluster-param-group: $(aws::db-cluster-param-group db-cluster-param-group-db-cluster-example)
    master-username: "master"
    master-user-password: "masterpassword"
    port: 27017
    preferred-backup-window: "00:00-00:30"
    preferred-maintenance-window: "wed:03:28-wed:03:58"
    vpc-security-groups: [
        $(aws::security-group security-group-db-cluster-example-1),
        $(aws::security-group security-group-db-cluster-example-2)
    ]
    storage-encrypted: false
    backup-retention-period: 1
    tags: {
        Name: "db-cluster-example"
    }
    post-delete-snapshot-identifier: "db-cluster-example-backup-snapshot"
end

Attributes¶

Attribute	Description
backup-retention-period	Set backup retention period. Minimum allowed value is `1`. (Required)
identifier	Name of the cluster. (Required)
db-subnet-group	Associated db subnet group. (Required)
engine	Engine for the cluster. (Required)
engine-version	Engine version for the cluster. (Required)
db-cluster-param-group	Associated db cluster parameter group. (Required)
kms-key	Associated kms key.
master-username	Master username. (Required)
master-user-password	Master user password. (Required)
port	Set the access port. (Required)
preferred-backup-window	Set preferred backup window. (Required)
preferred-maintenance-window	Set preferred maintenance window. (Required)
vpc-security-groups set	Associated vpc security groups. (Required)
storage-encrypted	Encrypt storage.
enable-cloudwatch-logs-exports list	Enabled cloud watch log exports.
post-delete-snapshot-identifier	snapshot name to be created post cluster delete.

Outputs¶

Attribute	Description
id	The id for the db cluster.
status	The status for the db cluster.
arn	The arn for the db cluster.