Class: Aws::Neptune::Types::CreateDBClusterMessage

Inherits:

Struct

Object
Struct
Aws::Neptune::Types::CreateDBClusterMessage

show all

Defined in:: gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

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).
#copy_tags_to_snapshot ⇒ Boolean
If set to true, tags are copied to any snapshot of the DB cluster that is created..
#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>
A list of the log types that this DB cluster should export to CloudWatch Logs.
#enable_iam_database_authentication ⇒ Boolean
If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).
#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.
#global_cluster_identifier ⇒ String
The ID of the Neptune global database to which this new DB cluster should be added.
#kms_key_id ⇒ String
The Amazon KMS key identifier for an encrypted DB cluster.
#master_user_password ⇒ String
Not supported by Neptune.
#master_username ⇒ String
Not supported by Neptune.
#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.
#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration
Contains the scaling configuration of a Neptune Serverless DB cluster.
#source_region ⇒ String
The source region of the snapshot.
#storage_encrypted ⇒ Boolean
Specifies whether the DB cluster is encrypted.
#storage_type ⇒ String
The storage type to associate with the DB cluster.
#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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :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)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#character_set_name ⇒ `String`

(Not supported by Neptune)

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

If set to true, tags are copied to any snapshot of the DB cluster that is created.

Returns:

(Boolean)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Boolean)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

Returns:

(Array<String>)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authentication ⇒ `Boolean`

If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

Default: false.

Returns:

(Boolean)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

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

Valid Values: neptune

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The version number of the database engine to use for the new DB cluster.

Example: 1.0.2.1

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifier ⇒ `String`

The ID of the Neptune global database to which this new DB cluster should be added.

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

The Amazon 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 Amazon 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 and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_password ⇒ `String`

Not supported by Neptune.

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

Not supported by Neptune.

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_name ⇒ `String`

(Not supported by Neptune)

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

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

Default: 8182

Returns:

(Integer)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#pre_signed_url ⇒ `String`

This parameter is not currently supported.

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :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 Region. To see the time blocks available, see Neptune 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.

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :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 Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfiguration`

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

Returns:

(Types::ServerlessV2ScalingConfiguration)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :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)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ `Boolean`

Specifies whether the DB cluster is encrypted.

Returns:

(Boolean)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type to associate with the DB cluster.

Valid Values:

standard | iopt1

Default:

standard

When you create a Neptune 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)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The tags to assign to the new DB cluster.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 935

class CreateDBClusterMessage < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :copy_tags_to_snapshot,
  :database_name,
  :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,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :pre_signed_url,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :serverless_v2_scaling_configuration,
  :global_cluster_identifier,
  :storage_type,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Neptune::Types::CreateDBClusterMessage

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zones ⇒ Array<String>

#backup_retention_period ⇒ Integer

#character_set_name ⇒ String

#copy_tags_to_snapshot ⇒ Boolean

#database_name ⇒ String

#db_cluster_identifier ⇒ String

#db_cluster_parameter_group_name ⇒ String

#db_subnet_group_name ⇒ String

#deletion_protection ⇒ Boolean

#enable_cloudwatch_logs_exports ⇒ Array<String>

#enable_iam_database_authentication ⇒ Boolean

#engine ⇒ String

#engine_version ⇒ String

#global_cluster_identifier ⇒ String

#kms_key_id ⇒ String

#master_user_password ⇒ String

#master_username ⇒ String

#option_group_name ⇒ String

#port ⇒ Integer

#pre_signed_url ⇒ String

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#replication_source_identifier ⇒ String

#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration

#source_region ⇒ String

#storage_encrypted ⇒ Boolean

#storage_type ⇒ String

#tags ⇒ Array<Types::Tag>

#vpc_security_group_ids ⇒ Array<String>

#availability_zones ⇒ `Array<String>`

#backup_retention_period ⇒ `Integer`

#character_set_name ⇒ `String`

#copy_tags_to_snapshot ⇒ `Boolean`

#database_name ⇒ `String`

#db_cluster_identifier ⇒ `String`

#db_cluster_parameter_group_name ⇒ `String`

#db_subnet_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

#enable_iam_database_authentication ⇒ `Boolean`

#engine ⇒ `String`

#engine_version ⇒ `String`

#global_cluster_identifier ⇒ `String`

#kms_key_id ⇒ `String`

#master_user_password ⇒ `String`

#master_username ⇒ `String`

#option_group_name ⇒ `String`

#port ⇒ `Integer`

#pre_signed_url ⇒ `String`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#replication_source_identifier ⇒ `String`

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfiguration`

#source_region ⇒ `String`

#storage_encrypted ⇒ `Boolean`

#storage_type ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#vpc_security_group_ids ⇒ `Array<String>`