CreateDBClusterMessage

public struct CreateDBClusterMessage : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

    Declaration

    Swift

    public let availabilityZones: [String]?

  • 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.

    Declaration

    Swift

    public let backupRetentionPeriod: Int?

  • 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

    Declaration

    Swift

    public let dBClusterIdentifier: String

  • The name of the cluster parameter group to associate with this cluster.

    Declaration

    Swift

    public let dBClusterParameterGroupName: String?

  • A subnet group to associate with this cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup

    Declaration

    Swift

    public let dBSubnetGroupName: String?

  • 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.

    Declaration

    Swift

    public let deletionProtection: Bool?

  • A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

    Declaration

    Swift

    public let enableCloudwatchLogsExports: [String]?

  • The name of the database engine to be used for this cluster. Valid values: docdb

    Declaration

    Swift

    public let engine: String

  • The version number of the database engine to use.

    Declaration

    Swift

    public let engineVersion: String?

  • The AWS KMS key identifier for an encrypted cluster. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. If an encryption key is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. If you create a replica of an encrypted cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

    Declaration

    Swift

    public let kmsKeyId: 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.

    Declaration

    Swift

    public let masterUsername: 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.

    Declaration

    Swift

    public let masterUserPassword: String

  • The port number on which the instances in the cluster accept connections.

    Declaration

    Swift

    public let port: Int?

  • 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 AWS 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.

    Declaration

    Swift

    public let preferredBackupWindow: 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 AWS Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.

    Declaration

    Swift

    public let preferredMaintenanceWindow: String?

  • Specifies whether the cluster is encrypted.

    Declaration

    Swift

    public let storageEncrypted: Bool?

  • The tags to be assigned to the cluster.

    Declaration

    Swift

    public let tags: [Tag]?

  • A list of EC2 VPC security groups to associate with this cluster.

    Declaration

    Swift

    public let vpcSecurityGroupIds: [String]?

  • Undocumented

    Declaration

    Swift

    public init(availabilityZones: [String]? = nil, backupRetentionPeriod: Int? = nil, dBClusterIdentifier: String, dBClusterParameterGroupName: String? = nil, dBSubnetGroupName: String? = nil, deletionProtection: Bool? = nil, enableCloudwatchLogsExports: [String]? = nil, engine: String, engineVersion: String? = nil, kmsKeyId: String? = nil, masterUsername: String, masterUserPassword: String, port: Int? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, storageEncrypted: Bool? = nil, tags: [Tag]? = nil, vpcSecurityGroupIds: [String]? = nil)