software.amazon.awssdk.services.docdb.model.ModifyDbInstanceRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.docdb.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the input to ModifyDBInstance.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModifyDbInstanceRequest extends DocDbRequest implements
ToCopyableBuilder {
private static final SdkField DB_INSTANCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceIdentifier").getter(getter(ModifyDbInstanceRequest::dbInstanceIdentifier))
.setter(setter(Builder::dbInstanceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceIdentifier").build())
.build();
private static final SdkField DB_INSTANCE_CLASS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceClass").getter(getter(ModifyDbInstanceRequest::dbInstanceClass))
.setter(setter(Builder::dbInstanceClass))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceClass").build()).build();
private static final SdkField APPLY_IMMEDIATELY_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ApplyImmediately").getter(getter(ModifyDbInstanceRequest::applyImmediately))
.setter(setter(Builder::applyImmediately))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplyImmediately").build()).build();
private static final SdkField PREFERRED_MAINTENANCE_WINDOW_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("PreferredMaintenanceWindow")
.getter(getter(ModifyDbInstanceRequest::preferredMaintenanceWindow))
.setter(setter(Builder::preferredMaintenanceWindow))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PreferredMaintenanceWindow").build())
.build();
private static final SdkField AUTO_MINOR_VERSION_UPGRADE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("AutoMinorVersionUpgrade").getter(getter(ModifyDbInstanceRequest::autoMinorVersionUpgrade))
.setter(setter(Builder::autoMinorVersionUpgrade))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AutoMinorVersionUpgrade").build())
.build();
private static final SdkField NEW_DB_INSTANCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NewDBInstanceIdentifier").getter(getter(ModifyDbInstanceRequest::newDBInstanceIdentifier))
.setter(setter(Builder::newDBInstanceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NewDBInstanceIdentifier").build())
.build();
private static final SdkField CA_CERTIFICATE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CACertificateIdentifier").getter(getter(ModifyDbInstanceRequest::caCertificateIdentifier))
.setter(setter(Builder::caCertificateIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CACertificateIdentifier").build())
.build();
private static final SdkField PROMOTION_TIER_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("PromotionTier").getter(getter(ModifyDbInstanceRequest::promotionTier))
.setter(setter(Builder::promotionTier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PromotionTier").build()).build();
private static final SdkField ENABLE_PERFORMANCE_INSIGHTS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("EnablePerformanceInsights")
.getter(getter(ModifyDbInstanceRequest::enablePerformanceInsights))
.setter(setter(Builder::enablePerformanceInsights))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnablePerformanceInsights").build())
.build();
private static final SdkField PERFORMANCE_INSIGHTS_KMS_KEY_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("PerformanceInsightsKMSKeyId")
.getter(getter(ModifyDbInstanceRequest::performanceInsightsKMSKeyId))
.setter(setter(Builder::performanceInsightsKMSKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PerformanceInsightsKMSKeyId")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_INSTANCE_IDENTIFIER_FIELD,
DB_INSTANCE_CLASS_FIELD, APPLY_IMMEDIATELY_FIELD, PREFERRED_MAINTENANCE_WINDOW_FIELD,
AUTO_MINOR_VERSION_UPGRADE_FIELD, NEW_DB_INSTANCE_IDENTIFIER_FIELD, CA_CERTIFICATE_IDENTIFIER_FIELD,
PROMOTION_TIER_FIELD, ENABLE_PERFORMANCE_INSIGHTS_FIELD, PERFORMANCE_INSIGHTS_KMS_KEY_ID_FIELD));
private final String dbInstanceIdentifier;
private final String dbInstanceClass;
private final Boolean applyImmediately;
private final String preferredMaintenanceWindow;
private final Boolean autoMinorVersionUpgrade;
private final String newDBInstanceIdentifier;
private final String caCertificateIdentifier;
private final Integer promotionTier;
private final Boolean enablePerformanceInsights;
private final String performanceInsightsKMSKeyId;
private ModifyDbInstanceRequest(BuilderImpl builder) {
super(builder);
this.dbInstanceIdentifier = builder.dbInstanceIdentifier;
this.dbInstanceClass = builder.dbInstanceClass;
this.applyImmediately = builder.applyImmediately;
this.preferredMaintenanceWindow = builder.preferredMaintenanceWindow;
this.autoMinorVersionUpgrade = builder.autoMinorVersionUpgrade;
this.newDBInstanceIdentifier = builder.newDBInstanceIdentifier;
this.caCertificateIdentifier = builder.caCertificateIdentifier;
this.promotionTier = builder.promotionTier;
this.enablePerformanceInsights = builder.enablePerformanceInsights;
this.performanceInsightsKMSKeyId = builder.performanceInsightsKMSKeyId;
}
/**
*
* The instance identifier. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBInstance.
*
*
*
*
* @return The instance identifier. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBInstance.
*
*
*/
public final String dbInstanceIdentifier() {
return dbInstanceIdentifier;
}
/**
*
* The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance
* classes are available in all Amazon Web Services 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.
*
*
* @return The new compute and memory capacity of the instance; for example, db.r5.large. Not all
* instance classes are available in all Amazon Web Services 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.
*/
public final String dbInstanceClass() {
return dbInstanceClass;
}
/**
*
* 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
*
*
* @return 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
*/
public final Boolean applyImmediately() {
return applyImmediately;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String preferredMaintenanceWindow() {
return preferredMaintenanceWindow;
}
/**
*
* This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades
* regardless of the value set.
*
*
* @return This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version
* upgrades regardless of the value set.
*/
public final Boolean autoMinorVersionUpgrade() {
return autoMinorVersionUpgrade;
}
/**
*
* 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
*
*
* @return 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
*/
public final String newDBInstanceIdentifier() {
return newDBInstanceIdentifier;
}
/**
*
* Indicates the certificate that needs to be associated with the instance.
*
*
* @return Indicates the certificate that needs to be associated with the instance.
*/
public final String caCertificateIdentifier() {
return caCertificateIdentifier;
}
/**
*
* 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
*
*
* @return 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
*/
public final Integer promotionTier() {
return promotionTier;
}
/**
*
* A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon
* Performance Insights.
*
*
* @return A value that indicates whether to enable Performance Insights for the DB Instance. For more information,
* see Using
* Amazon Performance Insights.
*/
public final Boolean enablePerformanceInsights() {
return enablePerformanceInsights;
}
/**
*
* The KMS key identifier for encryption of Performance Insights data.
*
*
* The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*
* If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.
* There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different
* default KMS key for each Amazon Web Services region.
*
*
* @return The KMS key identifier for encryption of Performance Insights data.
*
* The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*
* If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default
* KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
* account has a different default KMS key for each Amazon Web Services region.
*/
public final String performanceInsightsKMSKeyId() {
return performanceInsightsKMSKeyId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceClass());
hashCode = 31 * hashCode + Objects.hashCode(applyImmediately());
hashCode = 31 * hashCode + Objects.hashCode(preferredMaintenanceWindow());
hashCode = 31 * hashCode + Objects.hashCode(autoMinorVersionUpgrade());
hashCode = 31 * hashCode + Objects.hashCode(newDBInstanceIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(caCertificateIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(promotionTier());
hashCode = 31 * hashCode + Objects.hashCode(enablePerformanceInsights());
hashCode = 31 * hashCode + Objects.hashCode(performanceInsightsKMSKeyId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ModifyDbInstanceRequest)) {
return false;
}
ModifyDbInstanceRequest other = (ModifyDbInstanceRequest) obj;
return Objects.equals(dbInstanceIdentifier(), other.dbInstanceIdentifier())
&& Objects.equals(dbInstanceClass(), other.dbInstanceClass())
&& Objects.equals(applyImmediately(), other.applyImmediately())
&& Objects.equals(preferredMaintenanceWindow(), other.preferredMaintenanceWindow())
&& Objects.equals(autoMinorVersionUpgrade(), other.autoMinorVersionUpgrade())
&& Objects.equals(newDBInstanceIdentifier(), other.newDBInstanceIdentifier())
&& Objects.equals(caCertificateIdentifier(), other.caCertificateIdentifier())
&& Objects.equals(promotionTier(), other.promotionTier())
&& Objects.equals(enablePerformanceInsights(), other.enablePerformanceInsights())
&& Objects.equals(performanceInsightsKMSKeyId(), other.performanceInsightsKMSKeyId());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("ModifyDbInstanceRequest").add("DBInstanceIdentifier", dbInstanceIdentifier())
.add("DBInstanceClass", dbInstanceClass()).add("ApplyImmediately", applyImmediately())
.add("PreferredMaintenanceWindow", preferredMaintenanceWindow())
.add("AutoMinorVersionUpgrade", autoMinorVersionUpgrade())
.add("NewDBInstanceIdentifier", newDBInstanceIdentifier())
.add("CACertificateIdentifier", caCertificateIdentifier()).add("PromotionTier", promotionTier())
.add("EnablePerformanceInsights", enablePerformanceInsights())
.add("PerformanceInsightsKMSKeyId", performanceInsightsKMSKeyId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(dbInstanceIdentifier()));
case "DBInstanceClass":
return Optional.ofNullable(clazz.cast(dbInstanceClass()));
case "ApplyImmediately":
return Optional.ofNullable(clazz.cast(applyImmediately()));
case "PreferredMaintenanceWindow":
return Optional.ofNullable(clazz.cast(preferredMaintenanceWindow()));
case "AutoMinorVersionUpgrade":
return Optional.ofNullable(clazz.cast(autoMinorVersionUpgrade()));
case "NewDBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(newDBInstanceIdentifier()));
case "CACertificateIdentifier":
return Optional.ofNullable(clazz.cast(caCertificateIdentifier()));
case "PromotionTier":
return Optional.ofNullable(clazz.cast(promotionTier()));
case "EnablePerformanceInsights":
return Optional.ofNullable(clazz.cast(enablePerformanceInsights()));
case "PerformanceInsightsKMSKeyId":
return Optional.ofNullable(clazz.cast(performanceInsightsKMSKeyId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModifyDbInstanceRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DocDbRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The instance identifier. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBInstance.
*
*
*
*
* @param dbInstanceIdentifier
* The instance identifier. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DBInstance.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstanceIdentifier(String dbInstanceIdentifier);
/**
*
* The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance
* classes are available in all Amazon Web Services 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.
*
*
* @param dbInstanceClass
* The new compute and memory capacity of the instance; for example, db.r5.large. Not all
* instance classes are available in all Amazon Web Services 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstanceClass(String dbInstanceClass);
/**
*
* 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
*
*
* @param applyImmediately
* 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applyImmediately(Boolean applyImmediately);
/**
*
* 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.
*
*
* @param preferredMaintenanceWindow
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder preferredMaintenanceWindow(String preferredMaintenanceWindow);
/**
*
* This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades
* regardless of the value set.
*
*
* @param autoMinorVersionUpgrade
* This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version
* upgrades regardless of the value set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade);
/**
*
* 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
*
*
* @param newDBInstanceIdentifier
* 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder newDBInstanceIdentifier(String newDBInstanceIdentifier);
/**
*
* Indicates the certificate that needs to be associated with the instance.
*
*
* @param caCertificateIdentifier
* Indicates the certificate that needs to be associated with the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder caCertificateIdentifier(String caCertificateIdentifier);
/**
*
* 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
*
*
* @param promotionTier
* 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder promotionTier(Integer promotionTier);
/**
*
* A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see
* Using Amazon
* Performance Insights.
*
*
* @param enablePerformanceInsights
* A value that indicates whether to enable Performance Insights for the DB Instance. For more
* information, see Using
* Amazon Performance Insights.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enablePerformanceInsights(Boolean enablePerformanceInsights);
/**
*
* The KMS key identifier for encryption of Performance Insights data.
*
*
* The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*
* If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS
* key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
* different default KMS key for each Amazon Web Services region.
*
*
* @param performanceInsightsKMSKeyId
* The KMS key identifier for encryption of Performance Insights data.
*
* The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*
* If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your
* default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web
* Services account has a different default KMS key for each Amazon Web Services region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DocDbRequest.BuilderImpl implements Builder {
private String dbInstanceIdentifier;
private String dbInstanceClass;
private Boolean applyImmediately;
private String preferredMaintenanceWindow;
private Boolean autoMinorVersionUpgrade;
private String newDBInstanceIdentifier;
private String caCertificateIdentifier;
private Integer promotionTier;
private Boolean enablePerformanceInsights;
private String performanceInsightsKMSKeyId;
private BuilderImpl() {
}
private BuilderImpl(ModifyDbInstanceRequest model) {
super(model);
dbInstanceIdentifier(model.dbInstanceIdentifier);
dbInstanceClass(model.dbInstanceClass);
applyImmediately(model.applyImmediately);
preferredMaintenanceWindow(model.preferredMaintenanceWindow);
autoMinorVersionUpgrade(model.autoMinorVersionUpgrade);
newDBInstanceIdentifier(model.newDBInstanceIdentifier);
caCertificateIdentifier(model.caCertificateIdentifier);
promotionTier(model.promotionTier);
enablePerformanceInsights(model.enablePerformanceInsights);
performanceInsightsKMSKeyId(model.performanceInsightsKMSKeyId);
}
public final String getDbInstanceIdentifier() {
return dbInstanceIdentifier;
}
public final void setDbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
}
@Override
public final Builder dbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
return this;
}
public final String getDbInstanceClass() {
return dbInstanceClass;
}
public final void setDbInstanceClass(String dbInstanceClass) {
this.dbInstanceClass = dbInstanceClass;
}
@Override
public final Builder dbInstanceClass(String dbInstanceClass) {
this.dbInstanceClass = dbInstanceClass;
return this;
}
public final Boolean getApplyImmediately() {
return applyImmediately;
}
public final void setApplyImmediately(Boolean applyImmediately) {
this.applyImmediately = applyImmediately;
}
@Override
public final Builder applyImmediately(Boolean applyImmediately) {
this.applyImmediately = applyImmediately;
return this;
}
public final String getPreferredMaintenanceWindow() {
return preferredMaintenanceWindow;
}
public final void setPreferredMaintenanceWindow(String preferredMaintenanceWindow) {
this.preferredMaintenanceWindow = preferredMaintenanceWindow;
}
@Override
public final Builder preferredMaintenanceWindow(String preferredMaintenanceWindow) {
this.preferredMaintenanceWindow = preferredMaintenanceWindow;
return this;
}
public final Boolean getAutoMinorVersionUpgrade() {
return autoMinorVersionUpgrade;
}
public final void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) {
this.autoMinorVersionUpgrade = autoMinorVersionUpgrade;
}
@Override
public final Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) {
this.autoMinorVersionUpgrade = autoMinorVersionUpgrade;
return this;
}
public final String getNewDBInstanceIdentifier() {
return newDBInstanceIdentifier;
}
public final void setNewDBInstanceIdentifier(String newDBInstanceIdentifier) {
this.newDBInstanceIdentifier = newDBInstanceIdentifier;
}
@Override
public final Builder newDBInstanceIdentifier(String newDBInstanceIdentifier) {
this.newDBInstanceIdentifier = newDBInstanceIdentifier;
return this;
}
public final String getCaCertificateIdentifier() {
return caCertificateIdentifier;
}
public final void setCaCertificateIdentifier(String caCertificateIdentifier) {
this.caCertificateIdentifier = caCertificateIdentifier;
}
@Override
public final Builder caCertificateIdentifier(String caCertificateIdentifier) {
this.caCertificateIdentifier = caCertificateIdentifier;
return this;
}
public final Integer getPromotionTier() {
return promotionTier;
}
public final void setPromotionTier(Integer promotionTier) {
this.promotionTier = promotionTier;
}
@Override
public final Builder promotionTier(Integer promotionTier) {
this.promotionTier = promotionTier;
return this;
}
public final Boolean getEnablePerformanceInsights() {
return enablePerformanceInsights;
}
public final void setEnablePerformanceInsights(Boolean enablePerformanceInsights) {
this.enablePerformanceInsights = enablePerformanceInsights;
}
@Override
public final Builder enablePerformanceInsights(Boolean enablePerformanceInsights) {
this.enablePerformanceInsights = enablePerformanceInsights;
return this;
}
public final String getPerformanceInsightsKMSKeyId() {
return performanceInsightsKMSKeyId;
}
public final void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) {
this.performanceInsightsKMSKeyId = performanceInsightsKMSKeyId;
}
@Override
public final Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) {
this.performanceInsightsKMSKeyId = performanceInsightsKMSKeyId;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ModifyDbInstanceRequest build() {
return new ModifyDbInstanceRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}