Method: Aws::DocDB::Client#create_db_cluster

Defined in:: lib/aws-sdk-docdb/client.rb

#create_db_cluster(params = {}) ⇒ `Types::CreateDBClusterResult`

Creates a new Amazon DocumentDB cluster.

Examples:

Request syntax with placeholder values


resp = client.create_db_cluster({
  availability_zones: ["String"],
  backup_retention_period: 1,
  db_cluster_identifier: "String", # required
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  db_subnet_group_name: "String",
  engine: "String", # required
  engine_version: "String",
  port: 1,
  master_username: "String",
  master_user_password: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_encrypted: false,
  kms_key_id: "String",
  pre_signed_url: "String",
  enable_cloudwatch_logs_exports: ["String"],
  deletion_protection: false,
  global_cluster_identifier: "GlobalClusterIdentifier",
  storage_type: "String",
  manage_master_user_password: false,
  master_user_secret_kms_key_id: "String",
  source_region: "String",
})

Response structure


resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster.storage_type #=> String
resp.db_cluster.master_user_secret.secret_arn #=> String
resp.db_cluster.master_user_secret.secret_status #=> String
resp.db_cluster.master_user_secret.kms_key_id #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:availability_zones (Array<String>) —

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
:backup_retention_period (Integer) —
The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:
- Must be a value from 1 to 35.
^
:db_cluster_identifier (required, String) —
The cluster identifier. This parameter is stored as a lowercase string.

Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: ‘my-cluster`
:db_cluster_parameter_group_name (String) —

The name of the cluster parameter group to associate with this cluster.
:vpc_security_group_ids (Array<String>) —

A list of EC2 VPC security groups to associate with this cluster.
:db_subnet_group_name (String) —

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing ‘DBSubnetGroup`. Must not be default.

Example: ‘mySubnetgroup`
:engine (required, String) —

The name of the database engine to be used for this cluster.

Valid values: ‘docdb`
:engine_version (String) —

The version number of the database engine to use. The ‘–engine-version` will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
:port (Integer) —

The port number on which the instances in the cluster accept connections.
:master_username (String) —
The name of the master user for the cluster.

Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word for the chosen database engine.
:master_user_password (String) —

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (“), or the ”at“ symbol (@).

Constraints: Must contain from 8 to 100 characters.
:preferred_backup_window (String) —
The daily time range during which automated backups are created if automated backups are enabled using the ‘BackupRetentionPeriod` parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:
- Must be in the format ‘hh24:mi-hh24:mi`.
- Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
:preferred_maintenance_window (String) —

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

Format: ‘ddd:hh24:mi-ddd:hh24:mi`

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.
:tags (Array<Types::Tag>) —

The tags to be assigned to the cluster.
:storage_encrypted (Boolean) —

Specifies whether the cluster is encrypted.
:kms_key_id (String) —
The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in ‘KmsKeyId`:
- If the ‘StorageEncrypted` parameter is `true`, Amazon DocumentDB uses your default encryption key.
^

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
:pre_signed_url (String) —

Not currently supported.
:enable_cloudwatch_logs_exports (Array<String>) —

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see [ Auditing Amazon DocumentDB Events] and [ Profiling Amazon DocumentDB Operations].

[1]: docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html [2]: docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html
:deletion_protection (Boolean) —

Specifies whether this cluster can be deleted. If ‘DeletionProtection` is enabled, the cluster cannot be deleted unless it is modified and `DeletionProtection` is disabled. `DeletionProtection` protects clusters from being accidentally deleted.
:global_cluster_identifier (String) —

The cluster identifier of the new global cluster.
:storage_type (String) —
The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the *Amazon DocumentDB Developer Guide*.

Valid values for storage type - ‘standard | iopt1`

Default value is ‘standard `

<note markdown=“1”> When you create a DocumentDB DB cluster with the storage type set to ‘iopt1`, the storage type is returned in the response. The storage type isn’t returned when you set it to ‘standard`.
```
</note>
```
:manage_master_user_password (Boolean) —

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Constraint: You can’t manage the master user password with Amazon Web Services Secrets Manager if ‘MasterUserPassword` is specified.
:master_user_secret_kms_key_id (String) —

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don’t specify ‘MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the ‘aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
:source_region (String) —

The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:

(Types::CreateDBClusterResult) —
Returns a response object which responds to the following methods:
- #db_cluster => Types::DBCluster

Method: Aws::DocDB::Client#create_db_cluster

#create_db_cluster(params = {}) ⇒ Types::CreateDBClusterResult

Examples:

Request syntax with placeholder values

Response structure

#create_db_cluster(params = {}) ⇒ `Types::CreateDBClusterResult`