Class: Aws::DocDB::Types::CreateDBClusterMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

Represents the input to CreateDBCluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zones ⇒ Array<String>

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

Returns:

  • (Array<String>)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

^

Returns:

  • (Integer)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ Boolean

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Returns:

  • (Boolean)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ 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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group_name ⇒ String

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Boolean)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Array<String>)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Valid values: docdb

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The version number of the database engine to use. Amazon DocumentDB resolves the value of this parameter as follows:

  • If you omit this parameter or specify 8.0, Amazon DocumentDB uses the newest available 8.0 minor version in the Amazon Web Services Region.

  • If you specify 5.0, Amazon DocumentDB uses the 5.0 long-term support (LTS) minor version. This resolution moves only when a new 5.0 LTS minor version is declared.

  • If you specify a fully qualified version, such as 8.0.1 or 5.0.2, Amazon DocumentDB uses exactly that version.

For production workloads, explicitly declare this parameter with a fully qualified engine version rather than relying on resolution. A fully qualified version keeps the engine version of the cluster independent of the Amazon Web Services Region in which you create it and of the minor versions that are available when the request is made. This matters most for requests issued by scripts, automation, infrastructure-as-code templates, and pinned SDK clients.

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifier ⇒ String

The cluster identifier of the new global cluster.

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Boolean)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

The network type of the cluster.

The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.

Valid Values: IPV4 | DUAL

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

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

Returns:

  • (Integer)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#pre_signed_url ⇒ String

Not currently supported.

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_region ⇒ String

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

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ Boolean

Specifies whether the cluster is encrypted.

Returns:

  • (Boolean)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#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

When you create an Amazon DocumentDB 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.

Returns:

  • (String)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to be assigned to the cluster.

Returns:



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>)


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 818

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :global_cluster_identifier,
  :storage_type,
  :serverless_v2_scaling_configuration,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :network_type,
  :copy_tags_to_snapshot,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end