class Aws::DocDB::Types::CreateDBClusterMessage

@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterMessage AWS API Documentation
@return [String]
shapshot is encrypted and in a different region.
The source region of the snapshot. This is only needed when the
@!attribute [rw] source_region
@return [String]
each Amazon Web Services Region.
Your Amazon Web Services account has a different default KMS key for
There is a default KMS key for your Amazon Web Services account.
and you must use a customer managed KMS key.
can’t use the ‘aws/secretsmanager` KMS key to encrypt the secret,
secret is in a different Amazon Web Services account, then you
`aws/secretsmanager` KMS key is used to encrypt the secret. If the
If you don’t specify ‘MasterUserSecretKmsKeyId`, then the
ARN.
different Amazon Web Services account, specify the key ARN or alias
alias ARN, or alias name for the KMS key. To use a KMS key in a
The Amazon Web Services KMS key identifier is the key ARN, key ID,
Secrets Manager for the DB cluster.
password is managed by Amazon DocumentDB in Amazon Web Services
Secrets Manager. This setting is valid only if the master user
is automatically generated and managed in Amazon Web Services
The Amazon Web Services KMS key identifier to encrypt a secret that
@!attribute [rw] master_user_secret_kms_key_id
@return [Boolean]
Web Services Secrets Manager if `MasterUserPassword` is specified.
Constraint: You can’t manage the master user password with Amazon
Services Secrets Manager.
Specifies whether to manage the master user password with Amazon Web
@!attribute [rw] manage_master_user_password
@return [String]
</note>
type isn’t returned when you set it to ‘standard`.
`iopt1`, the storage type is returned in the response. The storage
<note markdown=“1”> When you create a DocumentDB DB cluster with the storage type set to
Default value is `standard `
Valid values for storage type - `standard | iopt1`
Guide*.
Cluster storage configurations in the *Amazon DocumentDB Developer
For information on storage types for Amazon DocumentDB clusters, see
The storage type to associate with the DB cluster.
@!attribute [rw] storage_type
@return [String]
The cluster identifier of the new global cluster.
@!attribute [rw] global_cluster_identifier
@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]
encryption key for each Amazon Web Services Regions.
account. Your Amazon Web Services account has a different default
KMS creates the default encryption key for your Amazon Web Services
^
uses your default encryption key.
* If the `StorageEncrypted` parameter is `true`, Amazon DocumentDB
If an encryption key is not specified in `KmsKeyId`:
the ARN for the KMS encryption key.
to encrypt the new cluster, you can use the KMS key alias instead of
Web Services account that owns the KMS encryption key that is used
encryption key. If you are creating a cluster using the same Amazon
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
The 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
random day of the week.
block of time for each Amazon Web Services Region, occurring on a
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 Amazon Web Services 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]
parameter with the intended major engine version.
For production workloads, we recommend explicitly declaring this
`–engine-version` will default to the latest major engine version.
The version number of the database engine to use. The
@!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
Represents the input to CreateDBCluster.