class Aws::DocDB::Types::CreateDBClusterMessage


@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterMessage AWS API Documentation
@return [Boolean]
deleted.
‘DeletionProtection` protects clusters from being accidentally
unless it is modified and `DeletionProtection` is disabled.
`DeletionProtection` is enabled, the cluster cannot be deleted
Specifies whether this cluster can be deleted. If
@!attribute [rw] deletion_protection
@return [Array<String>]<br>: docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html<br>[1]: docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html<br><br><br><br>Profiling Amazon DocumentDB Operations].
more information, see [ Auditing Amazon DocumentDB Events] and [
CloudWatch Logs. You can enable audit logs or profiler logs. For
A list of log types that need to be enabled for exporting to Amazon
@!attribute [rw] enable_cloudwatch_logs_exports
@return [String]
Not currently supported.
@!attribute [rw] pre_signed_url
@return [String]
that AWS Region.
destination AWS Region. This key is used to encrypt the replica in
Region, you must set `KmsKeyId` to a KMS key ID that is valid in the
If you create a replica of an encrypted cluster in another AWS
Region.
Your AWS account has a different default encryption key for each AWS
AWS KMS creates the default encryption key for your AWS account.
uses your default encryption key.
`ReplicationSourceIdentifier` is not specified, Amazon DocumentDB
* If the `StorageEncrypted` parameter is `true` and
encryption key.
encrypt the source. Otherwise, Amazon DocumentDB uses your default
then Amazon DocumentDB uses the encryption key that is used to
* If `ReplicationSourceIdentifier` identifies an encrypted source,
If an encryption key is not specified in `KmsKeyId`:
of the ARN for the AWS KMS encryption key.
encrypt the new cluster, you can use the AWS KMS key alias instead
AWS account that owns the AWS KMS encryption key that is used to
AWS KMS encryption key. If you are creating a cluster using the same
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
The AWS KMS key identifier for an encrypted cluster.
@!attribute [rw] kms_key_id
@return [Boolean]
Specifies whether the cluster is encrypted.
@!attribute [rw] storage_encrypted
@return [Array<Types::Tag>]
The tags to be assigned to the cluster.
@!attribute [rw] tags
@return [String]
Constraints: Minimum 30-minute window.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
week.
block of time for each AWS Region, occurring on a random day of the
The default is a 30-minute window selected at random from an 8-hour
Format: `ddd:hh24:mi-ddd:hh24:mi`
Universal Coordinated Time (UTC).
The weekly time range during which system maintenance can occur, in
@!attribute [rw] preferred_maintenance_window
@return [String]
* Must be at least 30 minutes.
* Must not conflict with the preferred maintenance window.
* Must be in Universal Coordinated Time (UTC).
* Must be in the format `hh24:mi-hh24:mi`.
Constraints:
block of time for each AWS Region.
The default is a 30-minute window selected at random from an 8-hour
parameter.
automated backups are enabled using the `BackupRetentionPeriod`
The daily time range during which automated backups are created if
@!attribute [rw] preferred_backup_window
@return [String]
Constraints: Must contain from 8 to 100 characters.
(“), or the ”at“ symbol (@).
any printable ASCII character except forward slash (/), double quote
The password for the master database user. This password can contain
@!attribute [rw] master_user_password
@return [String]
* Cannot be a reserved word for the chosen database engine.
* The first character must be a letter.
* Must be from 1 to 63 letters or numbers.
Constraints:
The name of the master user for the cluster.
@!attribute [rw] master_username
@return [Integer]
connections.
The port number on which the instances in the cluster accept
@!attribute [rw] port
@return [String]
The version number of the database engine to use.
@!attribute [rw] engine_version
@return [String]
Valid values: `docdb`
The name of the database engine to be used for this cluster.
@!attribute [rw] engine
@return [String]
Example: `mySubnetgroup`
Must not be default.
Constraints: Must match the name of an existing `DBSubnetGroup`.
A subnet group to associate with this cluster.
@!attribute [rw] db_subnet_group_name
@return [Array<String>]
A list of EC2 VPC security groups to associate with this cluster.
@!attribute [rw] vpc_security_group_ids
@return [String]
cluster.
The name of the cluster parameter group to associate with this
@!attribute [rw] db_cluster_parameter_group_name
@return [String]
Example: `my-cluster`
* Cannot end with a hyphen or contain two consecutive hyphens.
* The first character must be a letter.
* Must contain from 1 to 63 letters, numbers, or hyphens.
Constraints:
string.
The cluster identifier. This parameter is stored as a lowercase
@!attribute [rw] db_cluster_identifier
@return [Integer]
^
* Must be a value from 1 to 35.
Constraints:
Default: 1
must specify a minimum value of 1.
The number of days for which automated backups are retained. You
@!attribute [rw] backup_retention_period
@return [Array<String>]
cluster can be created in.
A list of Amazon EC2 Availability Zones that instances in the
@!attribute [rw] availability_zones
}
deletion_protection: false,
enable_cloudwatch_logs_exports: [”String“],
pre_signed_url: ”String“,
kms_key_id: ”String“,
storage_encrypted: false,
],
},
value: ”String“,
key: ”String“,
{
tags: [
preferred_maintenance_window: ”String“,
preferred_backup_window: ”String“,
master_user_password: ”String“, # required
master_username: ”String“, # required
port: 1,
engine_version: ”String“,
engine: ”String“, # required
db_subnet_group_name: ”String“,
vpc_security_group_ids: [”String“],
db_cluster_parameter_group_name: ”String“,
db_cluster_identifier: ”String“, # required
backup_retention_period: 1,
availability_zones: [”String“],
{
data as a hash:
@note When making an API call, you may pass CreateDBClusterMessage
Represents the input to CreateDBCluster.