/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.neptune.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ModifyDBInstanceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*

* Constraints: *

* */ private String dBInstanceIdentifier; /** *

* Not supported by Neptune. *

*/ private Integer allocatedStorage; /** *

* The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB * instance classes are available in all Amazon 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 *

*/ private String dBInstanceClass; /** *

* 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 *

*/ private String dBSubnetGroupName; /** *

* 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: *

* */ private java.util.List dBSecurityGroups; /** *

* A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon * as possible. *

*

* Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more * information, see ModifyDBCluster. *

*

* Constraints: *

* */ private java.util.List vpcSecurityGroupIds; /** *

* 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 *

*/ private Boolean applyImmediately; /** *

* Not supported by Neptune. *

*/ private String masterUserPassword; /** *

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

*/ private String dBParameterGroupName; /** *

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

*

* Default: Uses existing setting *

*/ private Integer backupRetentionPeriod; /** *

* 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: *

* */ private String preferredBackupWindow; /** *

* 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 *

*/ private String preferredMaintenanceWindow; /** *

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

*/ private Boolean multiAZ; /** *

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

*/ private String engineVersion; /** *

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

*/ private Boolean allowMajorVersionUpgrade; /** *

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

*/ private Boolean autoMinorVersionUpgrade; /** *

* Not supported by Neptune. *

*/ private String licenseModel; /** *

* 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 *

*/ private Integer iops; /** *

* (Not supported by Neptune) *

*/ private String optionGroupName; /** *

* 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: *

* *

* Example: mydbinstance *

*/ private String newDBInstanceIdentifier; /** *

* Not supported. *

*/ private String storageType; /** *

* The ARN from the key store with which to associate the instance for TDE encryption. *

*/ private String tdeCredentialArn; /** *

* The password for the given ARN from the key store in order to access the device. *

*/ private String tdeCredentialPassword; /** *

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

*/ private String cACertificateIdentifier; /** *

* Not supported. *

*/ private String domain; /** *

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

*/ private Boolean copyTagsToSnapshot; /** *

* 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 *

*/ private Integer monitoringInterval; /** *

* 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 *

*/ private Integer dBPortNumber; /** *

* This flag should no longer be used. *

*/ @Deprecated private Boolean publiclyAccessible; /** *

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

*/ private String monitoringRoleArn; /** *

* Not supported *

*/ private String domainIAMRoleName; /** *

* 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 *

*/ private Integer promotionTier; /** *

* 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 *

*/ private Boolean enableIAMDatabaseAuthentication; /** *

* (Not supported by Neptune) *

*/ private Boolean enablePerformanceInsights; /** *

* (Not supported by Neptune) *

*/ private String performanceInsightsKMSKeyId; /** *

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

*/ private CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration; /** *

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

*/ private Boolean deletionProtection; /** *

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

*

* Constraints: *

* * * @param dBInstanceIdentifier * The DB instance identifier. This value is stored as a lowercase string.

*

* Constraints: *

*