AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DocDB::Types::ModifyDBInstanceMessage

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

Overview

Note:

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

{
  db_instance_identifier: "String", # required
  db_instance_class: "String",
  apply_immediately: false,
  preferred_maintenance_window: "String",
  auto_minor_version_upgrade: false,
  new_db_instance_identifier: "String",
  ca_certificate_identifier: "String",
  promotion_tier: 1,
}

Represents the input to ModifyDBInstance.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediatelyBoolean

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

Returns:

  • (Boolean)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

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

Returns:

  • (Boolean)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#ca_certificate_identifierString

Indicates the certificate that needs to be associated with the instance.

Returns:

  • (String)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_classString

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

Returns:

  • (String)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifierString

The instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

^

Returns:

  • (String)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#new_db_instance_identifierString

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value 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)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

Returns:

  • (String)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end

#promotion_tierInteger

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)


4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4751

class ModifyDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :apply_immediately,
  :preferred_maintenance_window,
  :auto_minor_version_upgrade,
  :new_db_instance_identifier,
  :ca_certificate_identifier,
  :promotion_tier)
  SENSITIVE = []
  include Aws::Structure
end