Class: Aws::DocDB::Types::CreateDBInstanceMessage

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::CreateDBInstanceMessage

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass CreateDBInstanceMessage data as a hash:

{
  db_instance_identifier: "String", # required
  db_instance_class: "String", # required
  engine: "String", # required
  availability_zone: "String",
  preferred_maintenance_window: "String",
  auto_minor_version_upgrade: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  db_cluster_identifier: "String", # required
  promotion_tier: 1,
}

Represents the input to CreateDBInstance.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_minor_version_upgrade ⇒ Boolean

  This parameter does not apply to Amazon DocumentDB.

• #availability_zone ⇒ String

  The Amazon EC2 Availability Zone that the instance is created in.

• #db_cluster_identifier ⇒ String

  The identifier of the cluster that the instance will belong to.

• #db_instance_class ⇒ String

  The compute and memory capacity of the instance; for example, `db.r5.large`.

• #db_instance_identifier ⇒ String

  The instance identifier.

• #engine ⇒ String

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

• #preferred_maintenance_window ⇒ String

  The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

• #promotion_tier ⇒ Integer

  A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

• #tags ⇒ Array<Types::Tag>

  The tags to be assigned to the instance.

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: `false`

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Region.

Example: `us-east-1d`

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ String

The identifier of the cluster that the instance will belong to.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_class ⇒ String

The compute and memory capacity of the instance; for example, `db.r5.large`.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifier ⇒ String

The instance 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: `mydbinstance`

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Valid value: `docdb`

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

The time range each week 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.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#promotion_tier ⇒ Integer

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Returns:

• (Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-docdb/types.rb', line 1018

class CreateDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :availability_zone,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :tags,
  :db_cluster_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end