NAME

Paws::DocDB::ModifyDBInstance - Arguments for method ModifyDBInstance on Paws::DocDB

DESCRIPTION

This class represents the parameters used for calling the method ModifyDBInstance on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method ModifyDBInstance.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBInstance.

SYNOPSIS

    my $rds = Paws->service('DocDB');
    my $ModifyDBInstanceResult = $rds->ModifyDBInstance(
      DBInstanceIdentifier       => 'MyString',
      ApplyImmediately           => 1,             # OPTIONAL
      AutoMinorVersionUpgrade    => 1,             # OPTIONAL
      CACertificateIdentifier    => 'MyString',    # OPTIONAL
      DBInstanceClass            => 'MyString',    # OPTIONAL
      NewDBInstanceIdentifier    => 'MyString',    # OPTIONAL
      PreferredMaintenanceWindow => 'MyString',    # OPTIONAL
      PromotionTier              => 1,             # OPTIONAL
    );
    # Results:
    my $DBInstance = $ModifyDBInstanceResult->DBInstance;
    # Returns a L<Paws::DocDB::ModifyDBInstanceResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBInstance>

ATTRIBUTES

ApplyImmediately => Bool

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"

AutoMinorVersionUpgrade => Bool

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

CACertificateIdentifier => Str

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

DBInstanceClass => Str

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.

REQUIRED DBInstanceIdentifier => Str

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

Constraints:

•: Must match the identifier of an existing "DBInstance".

NewDBInstanceIdentifier => Str

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"

PreferredMaintenanceWindow => Str

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.

PromotionTier => Int

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>