NAME

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

DESCRIPTION

This class represents the parameters used for calling the method ModifyDBInstance on the Amazon Neptune 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('Neptune');
    my $ModifyDBInstanceResult = $rds->ModifyDBInstance(
      DBInstanceIdentifier              => 'MyString',
      AllocatedStorage                  => 1,             # OPTIONAL
      AllowMajorVersionUpgrade          => 1,             # OPTIONAL
      ApplyImmediately                  => 1,             # OPTIONAL
      AutoMinorVersionUpgrade           => 1,             # OPTIONAL
      BackupRetentionPeriod             => 1,             # OPTIONAL
      CACertificateIdentifier           => 'MyString',    # OPTIONAL
      CloudwatchLogsExportConfiguration => {
        DisableLogTypes => [ 'MyString', ... ],           # OPTIONAL
        EnableLogTypes  => [ 'MyString', ... ],           # OPTIONAL
      },    # OPTIONAL
      CopyTagsToSnapshot              => 1,                      # OPTIONAL
      DBInstanceClass                 => 'MyString',             # OPTIONAL
      DBParameterGroupName            => 'MyString',             # OPTIONAL
      DBPortNumber                    => 1,                      # OPTIONAL
      DBSecurityGroups                => [ 'MyString', ... ],    # OPTIONAL
      DBSubnetGroupName               => 'MyString',             # OPTIONAL
      DeletionProtection              => 1,                      # OPTIONAL
      Domain                          => 'MyString',             # OPTIONAL
      DomainIAMRoleName               => 'MyString',             # OPTIONAL
      EnableIAMDatabaseAuthentication => 1,                      # OPTIONAL
      EnablePerformanceInsights       => 1,                      # OPTIONAL
      EngineVersion                   => 'MyString',             # OPTIONAL
      Iops                            => 1,                      # OPTIONAL
      LicenseModel                    => 'MyString',             # OPTIONAL
      MasterUserPassword              => 'MyString',             # OPTIONAL
      MonitoringInterval              => 1,                      # OPTIONAL
      MonitoringRoleArn               => 'MyString',             # OPTIONAL
      MultiAZ                         => 1,                      # OPTIONAL
      NewDBInstanceIdentifier         => 'MyString',             # OPTIONAL
      OptionGroupName                 => 'MyString',             # OPTIONAL
      PerformanceInsightsKMSKeyId     => 'MyString',             # OPTIONAL
      PreferredBackupWindow           => 'MyString',             # OPTIONAL
      PreferredMaintenanceWindow      => 'MyString',             # OPTIONAL
      PromotionTier                   => 1,                      # OPTIONAL
      PubliclyAccessible              => 1,                      # OPTIONAL
      StorageType                     => 'MyString',             # OPTIONAL
      TdeCredentialArn                => 'MyString',             # OPTIONAL
      TdeCredentialPassword           => 'MyString',             # OPTIONAL
      VpcSecurityGroupIds             => [ 'MyString', ... ],    # OPTIONAL
    );
    # Results:
    my $DBInstance = $ModifyDBInstanceResult->DBInstance;
    # Returns a L<Paws::Neptune::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

AllocatedStorage => Int

Not supported by Neptune.

AllowMajorVersionUpgrade => Bool

Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

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 DB instance.

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

Default: "false"

AutoMinorVersionUpgrade => Bool

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to "true" during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.

BackupRetentionPeriod => Int

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

CACertificateIdentifier => Str

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

CloudwatchLogsExportConfiguration => Paws::Neptune::CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

CopyTagsToSnapshot => Bool

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

DBInstanceClass => Str

The new compute and memory capacity of the DB instance, for example, "db.m4.large". Not all DB instance classes are available in all AWS Regions.

If you modify the DB 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 DB instance identifier. This value is stored as a lowercase string.

Constraints:

•: Must match the identifier of an existing DBInstance.

DBParameterGroupName => Str

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

DBPortNumber => Int

The port number on which the database accepts connections.

The value of the "DBPortNumber" parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the "DBPortNumber" value regardless of the value of the "ApplyImmediately" parameter.

Default: 8182

DBSecurityGroups => ArrayRef[Str|Undef]

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

•: If supplied, must match existing DBSecurityGroups.

DBSubnetGroupName => Str

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify "true" for the "ApplyImmediately" parameter.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: "mySubnetGroup"

DeletionProtection => Bool

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).

Domain => Str

Not supported.

DomainIAMRoleName => Str

Not supported

EnableIAMDatabaseAuthentication => Bool

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: "false"

EnablePerformanceInsights => Bool

(Not supported by Neptune)

EngineVersion => Str

The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.

Iops => Int

The new Provisioned IOPS (I/O operations per second) value for the instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the "ApplyImmediately" parameter is set to "true" for this request.

Default: Uses existing setting

LicenseModel => Str

Not supported by Neptune.

MasterUserPassword => Str

Not supported by Neptune.

MonitoringInterval => Int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If "MonitoringRoleArn" is specified, then you must also set "MonitoringInterval" to a value other than 0.

Valid Values: "0, 1, 5, 10, 15, 30, 60"

MonitoringRoleArn => Str

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, "arn:aws:iam:123456789012:role/emaccess".

If "MonitoringInterval" is set to a value other than 0, then you must supply a "MonitoringRoleArn" value.

MultiAZ => Bool

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the "ApplyImmediately" parameter is set to "true" for this request.

NewDBInstanceIdentifier => Str

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set "Apply Immediately" to true, or will occur during the next maintenance window if "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"

OptionGroupName => Str

(Not supported by Neptune)

PerformanceInsightsKMSKeyId => Str

(Not supported by Neptune)

PreferredBackupWindow => Str

The daily time range during which automated backups are created if automated backups are enabled.

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes

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, then changing this parameter will cause a reboot of the DB instance. If 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 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 a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid Values: 0 - 15

Constraints:

•: If supplied, must match existing VpcSecurityGroupIds.

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>