You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Neptune::Types::CreateDBClusterMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Neptune::Types::CreateDBClusterMessage
- Defined in:
- (unknown)
Overview
When passing CreateDBClusterMessage as input to an Aws::Client method, you can use a vanilla Hash:
{
availability_zones: ["String"],
backup_retention_period: 1,
character_set_name: "String",
database_name: "String",
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",
option_group_name: "String",
preferred_backup_window: "String",
preferred_maintenance_window: "String",
replication_source_identifier: "String",
tags: [
{
key: "String",
value: "String",
},
],
storage_encrypted: false,
kms_key_id: "String",
pre_signed_url: "String",
enable_iam_database_authentication: false,
enable_cloudwatch_logs_exports: ["String"],
deletion_protection: false,
}
Instance Attribute Summary collapse
-
#availability_zones ⇒ Array<String>
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
-
#backup_retention_period ⇒ Integer
The number of days for which automated backups are retained.
-
#character_set_name ⇒ String
(Not supported by Neptune).
-
#database_name ⇒ String
The name for your database of up to 64 alpha-numeric characters.
-
#db_cluster_identifier ⇒ String
The DB cluster identifier.
-
#db_cluster_parameter_group_name ⇒ String
The name of the DB cluster parameter group to associate with this DB cluster.
-
#db_subnet_group_name ⇒ String
A DB subnet group to associate with this DB cluster.
-
#deletion_protection ⇒ Boolean
A value that indicates whether the DB cluster has deletion protection enabled.
-
#enable_cloudwatch_logs_exports ⇒ Array<String>
The list of log types that need to be enabled for exporting to CloudWatch Logs.
-
#enable_iam_database_authentication ⇒ Boolean
Not supported by Neptune.
-
#engine ⇒ String
The name of the database engine to be used for this DB cluster.
-
#engine_version ⇒ String
The version number of the database engine to use for the new DB cluster.
-
#kms_key_id ⇒ String
The AWS KMS key identifier for an encrypted DB cluster.
-
#master_user_password ⇒ String
The password for the master database user.
-
#master_username ⇒ String
The name of the master user for the DB cluster.
-
#option_group_name ⇒ String
(Not supported by Neptune).
-
#port ⇒ Integer
The port number on which the instances in the DB cluster accept connections.
-
#pre_signed_url ⇒ String
This parameter is not currently supported.
-
#preferred_backup_window ⇒ String
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter. -
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
#replication_source_identifier ⇒ String
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
-
#storage_encrypted ⇒ Boolean
Specifies whether the DB cluster is encrypted.
-
#tags ⇒ Array<Types::Tag>
The tags to assign to the new DB cluster.
-
#vpc_security_group_ids ⇒ Array<String>
A list of EC2 VPC security groups to associate with this DB cluster.
Instance Attribute Details
#availability_zones ⇒ Array<String>
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
#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
^
#character_set_name ⇒ String
(Not supported by Neptune)
#database_name ⇒ String
The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.
#db_cluster_identifier ⇒ String
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
#db_cluster_parameter_group_name ⇒ String
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
^
#db_subnet_group_name ⇒ String
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
#deletion_protection ⇒ Boolean
A value that indicates whether the DB cluster has deletion protection enabled. The database can\'t be deleted when deletion protection is enabled. By default, deletion protection is enabled.
#enable_cloudwatch_logs_exports ⇒ Array<String>
The list of log types that need to be enabled for exporting to CloudWatch Logs.
#enable_iam_database_authentication ⇒ Boolean
Not supported by Neptune.
#engine ⇒ String
The name of the database engine to be used for this DB cluster.
Valid Values: neptune
#engine_version ⇒ String
The version number of the database engine to use for the new DB cluster.
Example: 1.0.2.1
#kms_key_id ⇒ String
The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then 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
ReplicationSourceIdentifier
identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.If the
StorageEncrypted
parameter is true andReplicationSourceIdentifier
is not specified, then Amazon Neptune will use 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 Read Replica of an encrypted DB 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 Read Replica in
that AWS Region.
#master_user_password ⇒ String
The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints: Must contain from 8 to 41 characters.
#master_username ⇒ String
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
#option_group_name ⇒ String
(Not supported by Neptune)
#port ⇒ Integer
The port number on which the instances in the DB cluster accept connections.
Default: 8182
#pre_signed_url ⇒ String
This parameter is not currently supported.
#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 AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
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.
#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 AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
#replication_source_identifier ⇒ String
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
#storage_encrypted ⇒ Boolean
Specifies whether the DB cluster is encrypted.
#tags ⇒ Array<Types::Tag>
The tags to assign to the new DB cluster.
#vpc_security_group_ids ⇒ Array<String>
A list of EC2 VPC security groups to associate with this DB cluster.