class Aws::DocDB::Types::CreateDBClusterMessage
Represents the input to CreateDBCluster.
@note When making an API call, you may pass CreateDBClusterMessage
data as a hash: { 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", source_region: "String", }
@!attribute [rw] availability_zones
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in. @return [Array<String>]
@!attribute [rw] backup_retention_period
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. ^ @return [Integer]
@!attribute [rw] db_cluster_identifier
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` @return [String]
@!attribute [rw] db_cluster_parameter_group_name
The name of the cluster parameter group to associate with this cluster. @return [String]
@!attribute [rw] vpc_security_group_ids
A list of EC2 VPC security groups to associate with this cluster. @return [Array<String>]
@!attribute [rw] db_subnet_group_name
A subnet group to associate with this cluster. Constraints: Must match the name of an existing `DBSubnetGroup`. Must not be default. Example: `mySubnetgroup` @return [String]
@!attribute [rw] engine
The name of the database engine to be used for this cluster. Valid values: `docdb` @return [String]
@!attribute [rw] engine_version
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. @return [String]
@!attribute [rw] port
The port number on which the instances in the cluster accept connections. @return [Integer]
@!attribute [rw] master_username
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. @return [String]
@!attribute [rw] master_user_password
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. @return [String]
@!attribute [rw] preferred_backup_window
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 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. @return [String]
@!attribute [rw] preferred_maintenance_window
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 Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. @return [String]
@!attribute [rw] tags
The tags to be assigned to the cluster. @return [Array<Types::Tag>]
@!attribute [rw] storage_encrypted
Specifies whether the cluster is encrypted. @return [Boolean]
@!attribute [rw] kms_key_id
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 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 account. Your account has a different default encryption key for each Regions. @return [String]
@!attribute [rw] pre_signed_url
Not currently supported. @return [String]
@!attribute [rw] enable_cloudwatch_logs_exports
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][1] and [ Profiling Amazon DocumentDB Operations][2]. [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html [2]: https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html @return [Array<String>]
@!attribute [rw] deletion_protection
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. @return [Boolean]
@!attribute [rw] global_cluster_identifier
The cluster identifier of the new global cluster. @return [String]
@!attribute [rw] source_region
The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterMessage AWS API Documentation
Constants
- SENSITIVE