software.amazon.awssdk.services.rds.model.ModifyDbInstanceRequest Maven / Gradle / Ivy
Show all versions of rds Show documentation
/*
* 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.rds.model;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModifyDbInstanceRequest extends RdsRequest 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 ALLOCATED_STORAGE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("AllocatedStorage").getter(getter(ModifyDbInstanceRequest::allocatedStorage))
.setter(setter(Builder::allocatedStorage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllocatedStorage").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 DB_SUBNET_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSubnetGroupName").getter(getter(ModifyDbInstanceRequest::dbSubnetGroupName))
.setter(setter(Builder::dbSubnetGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSubnetGroupName").build()).build();
private static final SdkField> DB_SECURITY_GROUPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DBSecurityGroups")
.getter(getter(ModifyDbInstanceRequest::dbSecurityGroups))
.setter(setter(Builder::dbSecurityGroups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSecurityGroups").build(),
ListTrait
.builder()
.memberLocationName("DBSecurityGroupName")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("DBSecurityGroupName").build()).build()).build()).build();
private static final SdkField> VPC_SECURITY_GROUP_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("VpcSecurityGroupIds")
.getter(getter(ModifyDbInstanceRequest::vpcSecurityGroupIds))
.setter(setter(Builder::vpcSecurityGroupIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcSecurityGroupIds").build(),
ListTrait
.builder()
.memberLocationName("VpcSecurityGroupId")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("VpcSecurityGroupId").build()).build()).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 MASTER_USER_PASSWORD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MasterUserPassword").getter(getter(ModifyDbInstanceRequest::masterUserPassword))
.setter(setter(Builder::masterUserPassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MasterUserPassword").build())
.build();
private static final SdkField DB_PARAMETER_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBParameterGroupName").getter(getter(ModifyDbInstanceRequest::dbParameterGroupName))
.setter(setter(Builder::dbParameterGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBParameterGroupName").build())
.build();
private static final SdkField BACKUP_RETENTION_PERIOD_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("BackupRetentionPeriod").getter(getter(ModifyDbInstanceRequest::backupRetentionPeriod))
.setter(setter(Builder::backupRetentionPeriod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BackupRetentionPeriod").build())
.build();
private static final SdkField PREFERRED_BACKUP_WINDOW_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PreferredBackupWindow").getter(getter(ModifyDbInstanceRequest::preferredBackupWindow))
.setter(setter(Builder::preferredBackupWindow))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PreferredBackupWindow").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 MULTI_AZ_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("MultiAZ").getter(getter(ModifyDbInstanceRequest::multiAZ)).setter(setter(Builder::multiAZ))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MultiAZ").build()).build();
private static final SdkField ENGINE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EngineVersion").getter(getter(ModifyDbInstanceRequest::engineVersion))
.setter(setter(Builder::engineVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EngineVersion").build()).build();
private static final SdkField ALLOW_MAJOR_VERSION_UPGRADE_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("AllowMajorVersionUpgrade")
.getter(getter(ModifyDbInstanceRequest::allowMajorVersionUpgrade)).setter(setter(Builder::allowMajorVersionUpgrade))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllowMajorVersionUpgrade").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 LICENSE_MODEL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LicenseModel").getter(getter(ModifyDbInstanceRequest::licenseModel))
.setter(setter(Builder::licenseModel))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LicenseModel").build()).build();
private static final SdkField IOPS_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Iops")
.getter(getter(ModifyDbInstanceRequest::iops)).setter(setter(Builder::iops))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Iops").build()).build();
private static final SdkField OPTION_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OptionGroupName").getter(getter(ModifyDbInstanceRequest::optionGroupName))
.setter(setter(Builder::optionGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OptionGroupName").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 STORAGE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StorageType").getter(getter(ModifyDbInstanceRequest::storageType)).setter(setter(Builder::storageType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StorageType").build()).build();
private static final SdkField TDE_CREDENTIAL_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TdeCredentialArn").getter(getter(ModifyDbInstanceRequest::tdeCredentialArn))
.setter(setter(Builder::tdeCredentialArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TdeCredentialArn").build()).build();
private static final SdkField TDE_CREDENTIAL_PASSWORD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TdeCredentialPassword").getter(getter(ModifyDbInstanceRequest::tdeCredentialPassword))
.setter(setter(Builder::tdeCredentialPassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TdeCredentialPassword").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 DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Domain")
.getter(getter(ModifyDbInstanceRequest::domain)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Domain").build()).build();
private static final SdkField DOMAIN_FQDN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainFqdn").getter(getter(ModifyDbInstanceRequest::domainFqdn)).setter(setter(Builder::domainFqdn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainFqdn").build()).build();
private static final SdkField DOMAIN_OU_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainOu").getter(getter(ModifyDbInstanceRequest::domainOu)).setter(setter(Builder::domainOu))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainOu").build()).build();
private static final SdkField DOMAIN_AUTH_SECRET_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainAuthSecretArn").getter(getter(ModifyDbInstanceRequest::domainAuthSecretArn))
.setter(setter(Builder::domainAuthSecretArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainAuthSecretArn").build())
.build();
private static final SdkField> DOMAIN_DNS_IPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DomainDnsIps")
.getter(getter(ModifyDbInstanceRequest::domainDnsIps))
.setter(setter(Builder::domainDnsIps))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainDnsIps").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField COPY_TAGS_TO_SNAPSHOT_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("CopyTagsToSnapshot").getter(getter(ModifyDbInstanceRequest::copyTagsToSnapshot))
.setter(setter(Builder::copyTagsToSnapshot))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CopyTagsToSnapshot").build())
.build();
private static final SdkField MONITORING_INTERVAL_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MonitoringInterval").getter(getter(ModifyDbInstanceRequest::monitoringInterval))
.setter(setter(Builder::monitoringInterval))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MonitoringInterval").build())
.build();
private static final SdkField DB_PORT_NUMBER_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("DBPortNumber").getter(getter(ModifyDbInstanceRequest::dbPortNumber))
.setter(setter(Builder::dbPortNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBPortNumber").build()).build();
private static final SdkField PUBLICLY_ACCESSIBLE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("PubliclyAccessible").getter(getter(ModifyDbInstanceRequest::publiclyAccessible))
.setter(setter(Builder::publiclyAccessible))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PubliclyAccessible").build())
.build();
private static final SdkField MONITORING_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MonitoringRoleArn").getter(getter(ModifyDbInstanceRequest::monitoringRoleArn))
.setter(setter(Builder::monitoringRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MonitoringRoleArn").build()).build();
private static final SdkField DOMAIN_IAM_ROLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainIAMRoleName").getter(getter(ModifyDbInstanceRequest::domainIAMRoleName))
.setter(setter(Builder::domainIAMRoleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainIAMRoleName").build()).build();
private static final SdkField DISABLE_DOMAIN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DisableDomain").getter(getter(ModifyDbInstanceRequest::disableDomain))
.setter(setter(Builder::disableDomain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisableDomain").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_IAM_DATABASE_AUTHENTICATION_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("EnableIAMDatabaseAuthentication")
.getter(getter(ModifyDbInstanceRequest::enableIAMDatabaseAuthentication))
.setter(setter(Builder::enableIAMDatabaseAuthentication))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnableIAMDatabaseAuthentication")
.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 SdkField PERFORMANCE_INSIGHTS_RETENTION_PERIOD_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("PerformanceInsightsRetentionPeriod")
.getter(getter(ModifyDbInstanceRequest::performanceInsightsRetentionPeriod))
.setter(setter(Builder::performanceInsightsRetentionPeriod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PerformanceInsightsRetentionPeriod")
.build()).build();
private static final SdkField CLOUDWATCH_LOGS_EXPORT_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("CloudwatchLogsExportConfiguration")
.getter(getter(ModifyDbInstanceRequest::cloudwatchLogsExportConfiguration))
.setter(setter(Builder::cloudwatchLogsExportConfiguration))
.constructor(CloudwatchLogsExportConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CloudwatchLogsExportConfiguration")
.build()).build();
private static final SdkField> PROCESSOR_FEATURES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ProcessorFeatures")
.getter(getter(ModifyDbInstanceRequest::processorFeatures))
.setter(setter(Builder::processorFeatures))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProcessorFeatures").build(),
ListTrait
.builder()
.memberLocationName("ProcessorFeature")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ProcessorFeature::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ProcessorFeature").build()).build()).build()).build();
private static final SdkField USE_DEFAULT_PROCESSOR_FEATURES_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("UseDefaultProcessorFeatures")
.getter(getter(ModifyDbInstanceRequest::useDefaultProcessorFeatures))
.setter(setter(Builder::useDefaultProcessorFeatures))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UseDefaultProcessorFeatures")
.build()).build();
private static final SdkField DELETION_PROTECTION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DeletionProtection").getter(getter(ModifyDbInstanceRequest::deletionProtection))
.setter(setter(Builder::deletionProtection))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeletionProtection").build())
.build();
private static final SdkField MAX_ALLOCATED_STORAGE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxAllocatedStorage").getter(getter(ModifyDbInstanceRequest::maxAllocatedStorage))
.setter(setter(Builder::maxAllocatedStorage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxAllocatedStorage").build())
.build();
private static final SdkField CERTIFICATE_ROTATION_RESTART_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("CertificateRotationRestart")
.getter(getter(ModifyDbInstanceRequest::certificateRotationRestart))
.setter(setter(Builder::certificateRotationRestart))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CertificateRotationRestart").build())
.build();
private static final SdkField REPLICA_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReplicaMode").getter(getter(ModifyDbInstanceRequest::replicaModeAsString))
.setter(setter(Builder::replicaMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicaMode").build()).build();
private static final SdkField ENABLE_CUSTOMER_OWNED_IP_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("EnableCustomerOwnedIp").getter(getter(ModifyDbInstanceRequest::enableCustomerOwnedIp))
.setter(setter(Builder::enableCustomerOwnedIp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnableCustomerOwnedIp").build())
.build();
private static final SdkField AWS_BACKUP_RECOVERY_POINT_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AwsBackupRecoveryPointArn").getter(getter(ModifyDbInstanceRequest::awsBackupRecoveryPointArn))
.setter(setter(Builder::awsBackupRecoveryPointArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AwsBackupRecoveryPointArn").build())
.build();
private static final SdkField AUTOMATION_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AutomationMode").getter(getter(ModifyDbInstanceRequest::automationModeAsString))
.setter(setter(Builder::automationMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AutomationMode").build()).build();
private static final SdkField RESUME_FULL_AUTOMATION_MODE_MINUTES_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("ResumeFullAutomationModeMinutes")
.getter(getter(ModifyDbInstanceRequest::resumeFullAutomationModeMinutes))
.setter(setter(Builder::resumeFullAutomationModeMinutes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResumeFullAutomationModeMinutes")
.build()).build();
private static final SdkField NETWORK_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NetworkType").getter(getter(ModifyDbInstanceRequest::networkType)).setter(setter(Builder::networkType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NetworkType").build()).build();
private static final SdkField STORAGE_THROUGHPUT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("StorageThroughput").getter(getter(ModifyDbInstanceRequest::storageThroughput))
.setter(setter(Builder::storageThroughput))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StorageThroughput").build()).build();
private static final SdkField MANAGE_MASTER_USER_PASSWORD_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("ManageMasterUserPassword")
.getter(getter(ModifyDbInstanceRequest::manageMasterUserPassword)).setter(setter(Builder::manageMasterUserPassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ManageMasterUserPassword").build())
.build();
private static final SdkField ROTATE_MASTER_USER_PASSWORD_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("RotateMasterUserPassword")
.getter(getter(ModifyDbInstanceRequest::rotateMasterUserPassword)).setter(setter(Builder::rotateMasterUserPassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RotateMasterUserPassword").build())
.build();
private static final SdkField MASTER_USER_SECRET_KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MasterUserSecretKmsKeyId").getter(getter(ModifyDbInstanceRequest::masterUserSecretKmsKeyId))
.setter(setter(Builder::masterUserSecretKmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MasterUserSecretKmsKeyId").build())
.build();
private static final SdkField ENGINE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Engine")
.getter(getter(ModifyDbInstanceRequest::engine)).setter(setter(Builder::engine))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Engine").build()).build();
private static final SdkField DEDICATED_LOG_VOLUME_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DedicatedLogVolume").getter(getter(ModifyDbInstanceRequest::dedicatedLogVolume))
.setter(setter(Builder::dedicatedLogVolume))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DedicatedLogVolume").build())
.build();
private static final SdkField MULTI_TENANT_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("MultiTenant").getter(getter(ModifyDbInstanceRequest::multiTenant)).setter(setter(Builder::multiTenant))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MultiTenant").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_INSTANCE_IDENTIFIER_FIELD,
ALLOCATED_STORAGE_FIELD, DB_INSTANCE_CLASS_FIELD, DB_SUBNET_GROUP_NAME_FIELD, DB_SECURITY_GROUPS_FIELD,
VPC_SECURITY_GROUP_IDS_FIELD, APPLY_IMMEDIATELY_FIELD, MASTER_USER_PASSWORD_FIELD, DB_PARAMETER_GROUP_NAME_FIELD,
BACKUP_RETENTION_PERIOD_FIELD, PREFERRED_BACKUP_WINDOW_FIELD, PREFERRED_MAINTENANCE_WINDOW_FIELD, MULTI_AZ_FIELD,
ENGINE_VERSION_FIELD, ALLOW_MAJOR_VERSION_UPGRADE_FIELD, AUTO_MINOR_VERSION_UPGRADE_FIELD, LICENSE_MODEL_FIELD,
IOPS_FIELD, OPTION_GROUP_NAME_FIELD, NEW_DB_INSTANCE_IDENTIFIER_FIELD, STORAGE_TYPE_FIELD, TDE_CREDENTIAL_ARN_FIELD,
TDE_CREDENTIAL_PASSWORD_FIELD, CA_CERTIFICATE_IDENTIFIER_FIELD, DOMAIN_FIELD, DOMAIN_FQDN_FIELD, DOMAIN_OU_FIELD,
DOMAIN_AUTH_SECRET_ARN_FIELD, DOMAIN_DNS_IPS_FIELD, COPY_TAGS_TO_SNAPSHOT_FIELD, MONITORING_INTERVAL_FIELD,
DB_PORT_NUMBER_FIELD, PUBLICLY_ACCESSIBLE_FIELD, MONITORING_ROLE_ARN_FIELD, DOMAIN_IAM_ROLE_NAME_FIELD,
DISABLE_DOMAIN_FIELD, PROMOTION_TIER_FIELD, ENABLE_IAM_DATABASE_AUTHENTICATION_FIELD,
ENABLE_PERFORMANCE_INSIGHTS_FIELD, PERFORMANCE_INSIGHTS_KMS_KEY_ID_FIELD,
PERFORMANCE_INSIGHTS_RETENTION_PERIOD_FIELD, CLOUDWATCH_LOGS_EXPORT_CONFIGURATION_FIELD, PROCESSOR_FEATURES_FIELD,
USE_DEFAULT_PROCESSOR_FEATURES_FIELD, DELETION_PROTECTION_FIELD, MAX_ALLOCATED_STORAGE_FIELD,
CERTIFICATE_ROTATION_RESTART_FIELD, REPLICA_MODE_FIELD, ENABLE_CUSTOMER_OWNED_IP_FIELD,
AWS_BACKUP_RECOVERY_POINT_ARN_FIELD, AUTOMATION_MODE_FIELD, RESUME_FULL_AUTOMATION_MODE_MINUTES_FIELD,
NETWORK_TYPE_FIELD, STORAGE_THROUGHPUT_FIELD, MANAGE_MASTER_USER_PASSWORD_FIELD, ROTATE_MASTER_USER_PASSWORD_FIELD,
MASTER_USER_SECRET_KMS_KEY_ID_FIELD, ENGINE_FIELD, DEDICATED_LOG_VOLUME_FIELD, MULTI_TENANT_FIELD));
private final String dbInstanceIdentifier;
private final Integer allocatedStorage;
private final String dbInstanceClass;
private final String dbSubnetGroupName;
private final List dbSecurityGroups;
private final List vpcSecurityGroupIds;
private final Boolean applyImmediately;
private final String masterUserPassword;
private final String dbParameterGroupName;
private final Integer backupRetentionPeriod;
private final String preferredBackupWindow;
private final String preferredMaintenanceWindow;
private final Boolean multiAZ;
private final String engineVersion;
private final Boolean allowMajorVersionUpgrade;
private final Boolean autoMinorVersionUpgrade;
private final String licenseModel;
private final Integer iops;
private final String optionGroupName;
private final String newDBInstanceIdentifier;
private final String storageType;
private final String tdeCredentialArn;
private final String tdeCredentialPassword;
private final String caCertificateIdentifier;
private final String domain;
private final String domainFqdn;
private final String domainOu;
private final String domainAuthSecretArn;
private final List domainDnsIps;
private final Boolean copyTagsToSnapshot;
private final Integer monitoringInterval;
private final Integer dbPortNumber;
private final Boolean publiclyAccessible;
private final String monitoringRoleArn;
private final String domainIAMRoleName;
private final Boolean disableDomain;
private final Integer promotionTier;
private final Boolean enableIAMDatabaseAuthentication;
private final Boolean enablePerformanceInsights;
private final String performanceInsightsKMSKeyId;
private final Integer performanceInsightsRetentionPeriod;
private final CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration;
private final List processorFeatures;
private final Boolean useDefaultProcessorFeatures;
private final Boolean deletionProtection;
private final Integer maxAllocatedStorage;
private final Boolean certificateRotationRestart;
private final String replicaMode;
private final Boolean enableCustomerOwnedIp;
private final String awsBackupRecoveryPointArn;
private final String automationMode;
private final Integer resumeFullAutomationModeMinutes;
private final String networkType;
private final Integer storageThroughput;
private final Boolean manageMasterUserPassword;
private final Boolean rotateMasterUserPassword;
private final String masterUserSecretKmsKeyId;
private final String engine;
private final Boolean dedicatedLogVolume;
private final Boolean multiTenant;
private ModifyDbInstanceRequest(BuilderImpl builder) {
super(builder);
this.dbInstanceIdentifier = builder.dbInstanceIdentifier;
this.allocatedStorage = builder.allocatedStorage;
this.dbInstanceClass = builder.dbInstanceClass;
this.dbSubnetGroupName = builder.dbSubnetGroupName;
this.dbSecurityGroups = builder.dbSecurityGroups;
this.vpcSecurityGroupIds = builder.vpcSecurityGroupIds;
this.applyImmediately = builder.applyImmediately;
this.masterUserPassword = builder.masterUserPassword;
this.dbParameterGroupName = builder.dbParameterGroupName;
this.backupRetentionPeriod = builder.backupRetentionPeriod;
this.preferredBackupWindow = builder.preferredBackupWindow;
this.preferredMaintenanceWindow = builder.preferredMaintenanceWindow;
this.multiAZ = builder.multiAZ;
this.engineVersion = builder.engineVersion;
this.allowMajorVersionUpgrade = builder.allowMajorVersionUpgrade;
this.autoMinorVersionUpgrade = builder.autoMinorVersionUpgrade;
this.licenseModel = builder.licenseModel;
this.iops = builder.iops;
this.optionGroupName = builder.optionGroupName;
this.newDBInstanceIdentifier = builder.newDBInstanceIdentifier;
this.storageType = builder.storageType;
this.tdeCredentialArn = builder.tdeCredentialArn;
this.tdeCredentialPassword = builder.tdeCredentialPassword;
this.caCertificateIdentifier = builder.caCertificateIdentifier;
this.domain = builder.domain;
this.domainFqdn = builder.domainFqdn;
this.domainOu = builder.domainOu;
this.domainAuthSecretArn = builder.domainAuthSecretArn;
this.domainDnsIps = builder.domainDnsIps;
this.copyTagsToSnapshot = builder.copyTagsToSnapshot;
this.monitoringInterval = builder.monitoringInterval;
this.dbPortNumber = builder.dbPortNumber;
this.publiclyAccessible = builder.publiclyAccessible;
this.monitoringRoleArn = builder.monitoringRoleArn;
this.domainIAMRoleName = builder.domainIAMRoleName;
this.disableDomain = builder.disableDomain;
this.promotionTier = builder.promotionTier;
this.enableIAMDatabaseAuthentication = builder.enableIAMDatabaseAuthentication;
this.enablePerformanceInsights = builder.enablePerformanceInsights;
this.performanceInsightsKMSKeyId = builder.performanceInsightsKMSKeyId;
this.performanceInsightsRetentionPeriod = builder.performanceInsightsRetentionPeriod;
this.cloudwatchLogsExportConfiguration = builder.cloudwatchLogsExportConfiguration;
this.processorFeatures = builder.processorFeatures;
this.useDefaultProcessorFeatures = builder.useDefaultProcessorFeatures;
this.deletionProtection = builder.deletionProtection;
this.maxAllocatedStorage = builder.maxAllocatedStorage;
this.certificateRotationRestart = builder.certificateRotationRestart;
this.replicaMode = builder.replicaMode;
this.enableCustomerOwnedIp = builder.enableCustomerOwnedIp;
this.awsBackupRecoveryPointArn = builder.awsBackupRecoveryPointArn;
this.automationMode = builder.automationMode;
this.resumeFullAutomationModeMinutes = builder.resumeFullAutomationModeMinutes;
this.networkType = builder.networkType;
this.storageThroughput = builder.storageThroughput;
this.manageMasterUserPassword = builder.manageMasterUserPassword;
this.rotateMasterUserPassword = builder.rotateMasterUserPassword;
this.masterUserSecretKmsKeyId = builder.masterUserSecretKmsKeyId;
this.engine = builder.engine;
this.dedicatedLogVolume = builder.dedicatedLogVolume;
this.multiTenant = builder.multiTenant;
}
/**
*
* The identifier of DB instance to modify. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DB instance.
*
*
*
*
* @return The identifier of DB instance to modify. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DB instance.
*
*
*/
public final String dbInstanceIdentifier() {
return dbInstanceIdentifier;
}
/**
*
* The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
*
*
* For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must be at
* least 10% greater than the current value. Values that are not at least 10% greater than the existing value are
* rounded up so that they are 10% greater than the current value.
*
*
* For the valid values for allocated storage for each engine, see CreateDBInstance.
*
*
* Constraints:
*
*
* -
*
* When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3,
* io1, or io2 storage type), you must also specify the Iops parameter. You
* can use the current value for Iops.
*
*
*
*
* @return The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
*
* For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must
* be at least 10% greater than the current value. Values that are not at least 10% greater than the
* existing value are rounded up so that they are 10% greater than the current value.
*
*
* For the valid values for allocated storage for each engine, see CreateDBInstance.
*
*
* Constraints:
*
*
* -
*
* When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3,
* io1, or io2 storage type), you must also specify the Iops
* parameter. You can use the current value for Iops.
*
*
*/
public final Integer allocatedStorage() {
return 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 Web Services Regions, or for all database engines. For the full list of DB
* instance classes, and availability for your engine, see DB Instance Class
* in the Amazon RDS User Guide or Aurora DB
* instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB
* instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
*
*
* If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
* maintenance window, unless you specify ApplyImmediately in your request.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* If you are modifying the DB instance class and upgrading the engine version at the same time, the currently
* running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an
* error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the
* DB instance class.
*
*
*
*
* @return 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 Web Services Regions, or for all database engines. For the
* full list of DB instance classes, and availability for your engine, see DB Instance
* Class in the Amazon RDS User Guide or Aurora
* DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
*
* If you modify the DB instance class, an outage occurs during the change. The change is applied during the
* next maintenance window, unless you specify ApplyImmediately in your request.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* If you are modifying the DB instance class and upgrading the engine version at the same time, the
* currently running engine version must be supported on the specified DB instance class. Otherwise, the
* operation returns an error. In this case, first run the operation to upgrade the engine version, and then
* run it again to modify the DB instance class.
*
*
*/
public final String dbInstanceClass() {
return dbInstanceClass;
}
/**
*
* The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different
* VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For
* more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
* window, unless you enable ApplyImmediately.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB subnet group.
*
*
*
*
* Example: mydbsubnetgroup
*
*
* @return The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a
* different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB
* instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
* Changing the subnet group causes an outage during the change. The change is applied during the next
* maintenance window, unless you enable ApplyImmediately.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB subnet group.
*
*
*
*
* Example: mydbsubnetgroup
*/
public final String dbSubnetGroupName() {
return dbSubnetGroupName;
}
/**
* For responses, this returns true if the service returned a value for the DBSecurityGroups property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasDbSecurityGroups() {
return dbSecurityGroups != null && !(dbSecurityGroups instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB security groups.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasDbSecurityGroups} method.
*
*
* @return 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.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB security groups.
*
*
*/
public final List dbSecurityGroups() {
return dbSecurityGroups;
}
/**
* For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasVpcSecurityGroupIds() {
return vpcSecurityGroupIds != null && !(vpcSecurityGroupIds instanceof SdkAutoConstructList);
}
/**
*
* A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously
* applied as soon as possible.
*
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information,
* see ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing VPC security group IDs.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasVpcSecurityGroupIds} method.
*
*
* @return A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is
* asynchronously applied as soon as possible.
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
* information, see ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing VPC security group IDs.
*
*
*/
public final List vpcSecurityGroupIds() {
return 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. By
* default, this parameter is disabled.
*
*
* If this parameter is disabled, 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. Review the table of parameters in Modifying a DB
* Instance in the Amazon RDS User Guide to see the impact of enabling or disabling
* ApplyImmediately for each modified parameter and to determine when the changes are applied.
*
*
* @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 DB
* instance. By default, this parameter is disabled.
*
* If this parameter is disabled, 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. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or
* disabling ApplyImmediately for each modified parameter and to determine when the changes are
* applied.
*/
public final Boolean applyImmediately() {
return applyImmediately;
}
/**
*
* The new password for the master user.
*
*
* Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
* Between the time of the request and the completion of the request, the MasterUserPassword element
* exists in the PendingModifiedValues element of the operation response.
*
*
*
* Amazon RDS API operations never return the password, so this operation provides a way to regain access to a
* primary instance user if the password is lost. This includes restoring privileges that might have been
* accidentally revoked.
*
*
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
* ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Can't be specified if ManageMasterUserPassword is turned on.
*
*
* -
*
* Can include any printable ASCII character except "/",
* """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
*
*
*
*
* Length Constraints:
*
*
* -
*
* RDS for Db2 - Must contain from 8 to 255 characters.
*
*
* -
*
* RDS for MariaDB - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
*
*
* -
*
* RDS for MySQL - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Oracle - Must contain from 8 to 30 characters.
*
*
* -
*
* RDS for PostgreSQL - Must contain from 8 to 128 characters.
*
*
*
*
* @return The new password for the master user.
*
* Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as
* possible. Between the time of the request and the completion of the request, the
* MasterUserPassword element exists in the PendingModifiedValues element of the
* operation response.
*
*
*
* Amazon RDS API operations never return the password, so this operation provides a way to regain access to
* a primary instance user if the password is lost. This includes restoring privileges that might have been
* accidentally revoked.
*
*
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
* ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Can't be specified if ManageMasterUserPassword is turned on.
*
*
* -
*
* Can include any printable ASCII character except "/",
* """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes)
* character.
*
*
*
*
* Length Constraints:
*
*
* -
*
* RDS for Db2 - Must contain from 8 to 255 characters.
*
*
* -
*
* RDS for MariaDB - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
*
*
* -
*
* RDS for MySQL - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Oracle - Must contain from 8 to 30 characters.
*
*
* -
*
* RDS for PostgreSQL - Must contain from 8 to 128 characters.
*
*
*/
public final String masterUserPassword() {
return 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. In this case, the DB
* instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance
* window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are
* applied immediately without a reboot.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the same DB parameter group family as the DB instance.
*
*
*
*
* @return 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. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't
* applied during the next maintenance window. However, if you modify dynamic parameters in the newly
* associated DB parameter group, these changes are applied immediately without a reboot.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the same DB parameter group family as the DB instance.
*
*
*/
public final String dbParameterGroupName() {
return dbParameterGroupName;
}
/**
*
* The number of days to retain automated backups. Setting this parameter to a positive number enables backups.
* Setting this parameter to 0 disables automated backups.
*
*
*
* Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few
* minutes, depending on the size and class of your DB instance.
*
*
*
* These changes are applied during the next maintenance window unless the ApplyImmediately parameter
* is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the
* change is asynchronously applied as soon as possible.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed
* by the DB cluster. For more information, see ModifyDBCluster.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
* -
*
* Can't be set to 0 for an RDS Custom for Oracle DB instance.
*
*
*
*
* @return The number of days to retain automated backups. Setting this parameter to a positive number enables
* backups. Setting this parameter to 0 disables automated backups.
*
* Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a
* few minutes, depending on the size and class of your DB instance.
*
*
*
* These changes are applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request. If you change the parameter from one non-zero value to another
* non-zero value, the change is asynchronously applied as soon as possible.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is
* managed by the DB cluster. For more information, see ModifyDBCluster.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
* -
*
* Can't be set to 0 for an RDS Custom for Oracle DB instance.
*
*
*/
public final Integer backupRetentionPeriod() {
return backupRetentionPeriod;
}
/**
*
* The daily time range during which automated backups are created if automated backups are enabled, as determined
* by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the
* change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from
* an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @return The daily time range during which automated backups are created if automated backups are enabled, as
* determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in
* an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window
* selected at random from an 8-hour block of time for each Amazon Web Services Region. For more
* information, see Backup window in the Amazon RDS User Guide.
*
* This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*/
public final String preferredBackupWindow() {
return preferredBackupWindow;
}
/**
*
* The weekly time range 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 causes a reboot of the DB instance. If you
* change 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.
*
*
* For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the format ddd:hh24:mi-ddd:hh24:mi.
*
*
* -
*
* The day values must be mon | tue | wed | thu | fri | sat | sun.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred backup window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @return The weekly time range 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 causes a reboot
* of the DB instance. If you change 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.
*
* For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the format ddd:hh24:mi-ddd:hh24:mi.
*
*
* -
*
* The day values must be mon | tue | wed | thu | fri | sat | sun.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred backup window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*/
public final String preferredMaintenanceWindow() {
return preferredMaintenanceWindow;
}
/**
*
* Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage.
* The change is applied during the next maintenance window unless the ApplyImmediately parameter is
* enabled for this request.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an
* outage. The change is applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request.
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final Boolean multiAZ() {
return multiAZ;
}
/**
*
* The version number of the database engine to upgrade to. Changing this parameter results in an outage and the
* change is applied during the next maintenance window unless the ApplyImmediately parameter is
* enabled for this request.
*
*
* For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in
* the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the
* default for that DB parameter group family.
*
*
* If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the
* current minor version is lower. For information about valid engine versions, see CreateDBInstance,
* or call DescribeDBEngineVersions.
*
*
* If the instance that you're modifying is acting as a read replica, the engine version that you specify must be
* the same or higher than the version that the source DB instance or cluster is running.
*
*
* In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
* PATCH_DB_FAILURE lifecycle.
*
*
* Constraints:
*
*
* -
*
* If you are upgrading the engine version and modifying the DB instance class at the same time, the currently
* running engine version must be supported on the specified DB instance class. Otherwise, the operation returns an
* error. In this case, first run the operation to upgrade the engine version, and then run it again to modify the
* DB instance class.
*
*
*
*
* @return The version number of the database engine to upgrade to. Changing this parameter results in an outage and
* the change is applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request.
*
* For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter
* group in the DB parameter group family for the new engine version must be specified. The new DB parameter
* group can be the default for that DB parameter group family.
*
*
* If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if
* the current minor version is lower. For information about valid engine versions, see
* CreateDBInstance, or call DescribeDBEngineVersions.
*
*
* If the instance that you're modifying is acting as a read replica, the engine version that you specify
* must be the same or higher than the version that the source DB instance or cluster is running.
*
*
* In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
* PATCH_DB_FAILURE lifecycle.
*
*
* Constraints:
*
*
* -
*
* If you are upgrading the engine version and modifying the DB instance class at the same time, the
* currently running engine version must be supported on the specified DB instance class. Otherwise, the
* operation returns an error. In this case, first run the operation to upgrade the engine version, and then
* run it again to modify the DB instance class.
*
*
*/
public final String engineVersion() {
return engineVersion;
}
/**
*
* Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the
* change is asynchronously applied as soon as possible.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Major version upgrades must be allowed when specifying a value for the EngineVersion parameter
* that's a different major version than the DB instance's current version.
*
*
*
*
* @return Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage
* and the change is asynchronously applied as soon as possible.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Major version upgrades must be allowed when specifying a value for the EngineVersion
* parameter that's a different major version than the DB instance's current version.
*
*
*/
public final Boolean allowMajorVersionUpgrade() {
return allowMajorVersionUpgrade;
}
/**
*
* Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance
* window. An outage occurs when all the following conditions are met:
*
*
* -
*
* The automatic upgrade is enabled for the maintenance window.
*
*
* -
*
* A newer minor version is available.
*
*
* -
*
* RDS has enabled automatic patching for the engine version.
*
*
*
*
* If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause
* an outage.
*
*
* For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
*
*
* @return Specifies whether minor version upgrades are applied automatically to the DB instance during the
* maintenance window. An outage occurs when all the following conditions are met:
*
* -
*
* The automatic upgrade is enabled for the maintenance window.
*
*
* -
*
* A newer minor version is available.
*
*
* -
*
* RDS has enabled automatic patching for the engine version.
*
*
*
*
* If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and
* doesn't cause an outage.
*
*
* For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
*/
public final Boolean autoMinorVersionUpgrade() {
return autoMinorVersionUpgrade;
}
/**
*
* The license model for the DB instance.
*
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* RDS for Db2 - bring-your-own-license
*
*
* -
*
* RDS for MariaDB - general-public-license
*
*
* -
*
* RDS for Microsoft SQL Server - license-included
*
*
* -
*
* RDS for MySQL - general-public-license
*
*
* -
*
* RDS for Oracle - bring-your-own-license | license-included
*
*
* -
*
* RDS for PostgreSQL - postgresql-license
*
*
*
*
* @return The license model for the DB instance.
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* RDS for Db2 - bring-your-own-license
*
*
* -
*
* RDS for MariaDB - general-public-license
*
*
* -
*
* RDS for Microsoft SQL Server - license-included
*
*
* -
*
* RDS for MySQL - general-public-license
*
*
* -
*
* RDS for Oracle - bring-your-own-license | license-included
*
*
* -
*
* RDS for PostgreSQL - postgresql-license
*
*
*/
public final String licenseModel() {
return licenseModel;
}
/**
*
* The new Provisioned IOPS (I/O operations per second) value for the RDS 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 enabled for this request. If you are migrating from
* Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change
* in storage type to take effect.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on
* several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS
* provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24
* hours, but the process can take up to several days in some cases. During the migration, the DB instance is
* available for use, but might experience performance degradation. While the migration takes place, nightly backups
* for the instance are suspended. No other Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance,
* and creating a DB snapshot of the instance.
*
*
* Constraints:
*
*
* -
*
* For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least
* 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded
* up so that they are 10% greater than the current value.
*
*
* -
*
* When you increase the Provisioned IOPS, you must also specify the AllocatedStorage parameter. You
* can use the current value for AllocatedStorage.
*
*
*
*
* Default: Uses existing setting
*
*
* @return The new Provisioned IOPS (I/O operations per second) value for the RDS 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 enabled for this request. If you are
* migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a
* reboot for the change in storage type to take effect.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from
* using Provisioned IOPS to using standard storage, the process can take time. The duration of the
* migration depends on several factors such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations.
* Typical migration times are under 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance is available for use, but might experience performance degradation.
* While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS
* operations can take place for the instance, including modifying the instance, rebooting the instance,
* deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the
* instance.
*
*
* Constraints:
*
*
* -
*
* For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be
* at least 10% greater than the current value. Values that are not at least 10% greater than the existing
* value are rounded up so that they are 10% greater than the current value.
*
*
* -
*
* When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
* parameter. You can use the current value for AllocatedStorage.
*
*
*
*
* Default: Uses existing setting
*/
public final Integer iops() {
return iops;
}
/**
*
* The option group to associate the DB instance with.
*
*
* Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an
* option group that enables OEM, it can cause a brief period, lasting less than a second, during which new
* connections are rejected but existing connections aren't interrupted.
*
*
* The change is applied during the next maintenance window unless the ApplyImmediately parameter is
* enabled for this request.
*
*
* Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option
* group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The option group to associate the DB instance with.
*
* Changing this parameter doesn't result in an outage, with one exception. If the parameter change results
* in an option group that enables OEM, it can cause a brief period, lasting less than a second, during
* which new connections are rejected but existing connections aren't interrupted.
*
*
* The change is applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request.
*
*
* Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an
* option group, and that option group can't be removed from a DB instance after it is associated with a DB
* instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String optionGroupName() {
return optionGroupName;
}
/**
*
* The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier,
* an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next
* maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: mydbinstance
*
*
* @return The new identifier for the DB instance when renaming a DB instance. When you change the DB instance
* identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will
* occur during the next maintenance window if you disable ApplyImmediately. This value is
* stored as a lowercase string.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: mydbinstance
*/
public final String newDBInstanceIdentifier() {
return newDBInstanceIdentifier;
}
/**
*
* The storage type to associate with the DB instance.
*
*
* If you specify io1, io2, or gp3 you must also include a value for the
* Iops parameter.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using
* Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on
* several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS
* provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24
* hours, but the process can take up to several days in some cases. During the migration, the DB instance is
* available for use, but might experience performance degradation. While the migration takes place, nightly backups
* for the instance are suspended. No other Amazon RDS operations can take place for the instance, including
* modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance,
* and creating a DB snapshot of the instance.
*
*
* Valid Values: gp2 | gp3 | io1 | io2 | standard
*
*
* Default: io1, if the Iops parameter is specified. Otherwise, gp2.
*
*
* @return The storage type to associate with the DB instance.
*
* If you specify io1, io2, or gp3 you must also include a value for
* the Iops parameter.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from
* using Provisioned IOPS to using standard storage, the process can take time. The duration of the
* migration depends on several factors such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations.
* Typical migration times are under 24 hours, but the process can take up to several days in some cases.
* During the migration, the DB instance is available for use, but might experience performance degradation.
* While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS
* operations can take place for the instance, including modifying the instance, rebooting the instance,
* deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the
* instance.
*
*
* Valid Values: gp2 | gp3 | io1 | io2 | standard
*
*
* Default: io1, if the Iops parameter is specified. Otherwise, gp2.
*/
public final String storageType() {
return storageType;
}
/**
*
* The ARN from the key store with which to associate the instance for TDE encryption.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The ARN from the key store with which to associate the instance for TDE encryption.
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String tdeCredentialArn() {
return tdeCredentialArn;
}
/**
*
* The password for the given ARN from the key store in order to access the device.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The password for the given ARN from the key store in order to access the device.
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String tdeCredentialPassword() {
return tdeCredentialPassword;
}
/**
*
* The CA certificate identifier to use for the DB instance's server certificate.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* For more information, see Using SSL/TLS to encrypt a
* connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to
* encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
*
*
* @return The CA certificate identifier to use for the DB instance's server certificate.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* For more information, see Using SSL/TLS to
* encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS
* to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
*/
public final String caCertificateIdentifier() {
return caCertificateIdentifier;
}
/**
*
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance
* from its current domain. You must create the domain before this operation. Currently, you can create only Db2,
* MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
*
*
* For more information, see Kerberos
* Authentication in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The Active Directory directory ID to move the DB instance to. Specify none to remove the
* instance from its current domain. You must create the domain before this operation. Currently, you can
* create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory
* Domain.
*
* For more information, see Kerberos
* Authentication in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String domain() {
return domain;
}
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
*
* @return The fully qualified domain name (FQDN) of an Active Directory domain.
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*/
public final String domainFqdn() {
return domainFqdn;
}
/**
*
* The Active Directory organizational unit for your DB instance to join.
*
*
* Constraints:
*
*
* -
*
* Must be in the distinguished name format.
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
*
*
* @return The Active Directory organizational unit for your DB instance to join.
*
* Constraints:
*
*
* -
*
* Must be in the distinguished name format.
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
*/
public final String domainOu() {
return domainOu;
}
/**
*
* The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
*
*
* Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
*
*
* @return The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
*
* Example:
* arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
*/
public final String domainAuthSecretArn() {
return domainAuthSecretArn;
}
/**
* For responses, this returns true if the service returned a value for the DomainDnsIps property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasDomainDnsIps() {
return domainDnsIps != null && !(domainDnsIps instanceof SdkAutoConstructList);
}
/**
*
* The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
*
*
* Constraints:
*
*
* -
*
* Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the
* primary domain controller for both entries in the list.
*
*
*
*
* Example: 123.124.125.126,234.235.236.237
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasDomainDnsIps} method.
*
*
* @return The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
*
* Constraints:
*
*
* -
*
* Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of
* the primary domain controller for both entries in the list.
*
*
*
*
* Example: 123.124.125.126,234.235.236.237
*/
public final List domainDnsIps() {
return domainDnsIps;
}
/**
*
* Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't
* copied.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster.
* Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
* ModifyDBCluster.
*
*
* @return Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags
* aren't copied.
*
* This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB
* cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more
* information, see ModifyDBCluster.
*/
public final Boolean copyTagsToSnapshot() {
return copyTagsToSnapshot;
}
/**
*
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To
* disable collection of Enhanced Monitoring metrics, specify 0.
*
*
* If MonitoringRoleArn is specified, set MonitoringInterval to a value other than
* 0.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
*
*
* Default: 0
*
*
* @return The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
* instance. To disable collection of Enhanced Monitoring metrics, specify 0.
*
* If MonitoringRoleArn is specified, set MonitoringInterval to a value other than
* 0.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
*
*
* Default: 0
*/
public final Integer monitoringInterval() {
return 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.
*
*
* If you change the DBPortNumber value, your database restarts regardless of the value of the
* ApplyImmediately parameter.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 1150-65535
*
*
* Default:
*
*
* -
*
* Amazon Aurora - 3306
*
*
* -
*
* RDS for Db2 - 50000
*
*
* -
*
* RDS for MariaDB - 3306
*
*
* -
*
* RDS for Microsoft SQL Server - 1433
*
*
* -
*
* RDS for MySQL - 3306
*
*
* -
*
* RDS for Oracle - 1521
*
*
* -
*
* RDS for PostgreSQL - 5432
*
*
*
*
* Constraints:
*
*
* -
*
* For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260,
* 3343, 3389, 47001, or 49152-49156.
*
*
*
*
* @return 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.
*
*
* If you change the DBPortNumber value, your database restarts regardless of the value of the
* ApplyImmediately parameter.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 1150-65535
*
*
* Default:
*
*
* -
*
* Amazon Aurora - 3306
*
*
* -
*
* RDS for Db2 - 50000
*
*
* -
*
* RDS for MariaDB - 3306
*
*
* -
*
* RDS for Microsoft SQL Server - 1433
*
*
* -
*
* RDS for MySQL - 3306
*
*
* -
*
* RDS for Oracle - 1521
*
*
* -
*
* RDS for PostgreSQL - 5432
*
*
*
*
* Constraints:
*
*
* -
*
* For RDS for Microsoft SQL Server, the value can't be 1234, 1434,
* 3260, 3343, 3389, 47001, or 49152-49156.
*
*
*/
public final Integer dbPortNumber() {
return dbPortNumber;
}
/**
*
* Specifies whether the DB instance is publicly accessible.
*
*
* When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private
* cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from
* within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB
* instance is ultimately controlled by the security group it uses. That public access isn't permitted if the
* security group assigned to the DB instance doesn't permit it.
*
*
* When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a
* private IP address.
*
*
* PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public
* subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
*
*
* Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the
* ApplyImmediately parameter.
*
*
* @return Specifies whether the DB instance is publicly accessible.
*
* When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual
* private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you
* connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address.
* Access to the DB instance is ultimately controlled by the security group it uses. That public access
* isn't permitted if the security group assigned to the DB instance doesn't permit it.
*
*
* When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that
* resolves to a private IP address.
*
*
* PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a
* public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
*
*
* Changes to the PubliclyAccessible parameter are applied immediately regardless of the value
* of the ApplyImmediately parameter.
*/
public final Boolean publiclyAccessible() {
return publiclyAccessible;
}
/**
*
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
* example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see
*
* To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
*
*
* If MonitoringInterval is set to a value other than 0, supply a
* MonitoringRoleArn value.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
* For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a
* monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
*
* If MonitoringInterval is set to a value other than 0, supply a
* MonitoringRoleArn value.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String monitoringRoleArn() {
return monitoringRoleArn;
}
/**
*
* The name of the IAM role to use when making API calls to the Directory Service.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The name of the IAM role to use when making API calls to the Directory Service.
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String domainIAMRoleName() {
return domainIAMRoleName;
}
/**
*
* Specifies whether to remove the DB instance from the Active Directory domain.
*
*
* @return Specifies whether to remove the DB instance from the Active Directory domain.
*/
public final Boolean disableDomain() {
return disableDomain;
}
/**
*
* The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the
* existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Default: 1
*
*
* Valid Values: 0 - 15
*
*
* @return The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of
* the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Default: 1
*
*
* Valid Values: 0 - 15
*/
public final Integer promotionTier() {
return promotionTier;
}
/**
*
* Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
* database accounts. By default, mapping isn't enabled.
*
*
* This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is
* managed by the DB cluster.
*
*
* For more information about IAM database authentication, see IAM Database
* Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts
* to database accounts. By default, mapping isn't enabled.
*
* This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database
* accounts is managed by the DB cluster.
*
*
* For more information about IAM database authentication, see IAM Database
* Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final Boolean enableIAMDatabaseAuthentication() {
return enableIAMDatabaseAuthentication;
}
/**
*
* Specifies whether to enable Performance Insights for the DB instance.
*
*
* For more information, see Using Amazon Performance
* Insights in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return Specifies whether to enable Performance Insights for the DB instance.
*
* For more information, see Using Amazon
* Performance Insights in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final Boolean enablePerformanceInsights() {
return enablePerformanceInsights;
}
/**
*
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*
* If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS
* key.
*
*
* If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String performanceInsightsKMSKeyId() {
return performanceInsightsKMSKeyId;
}
/**
*
* The number of days to retain Performance Insights data.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* 7
*
*
* -
*
* month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31),
* 341 (11 months * 31), 589 (19 months * 31)
*
*
* -
*
* 731
*
*
*
*
* Default: 7 days
*
*
* If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
*
*
* @return The number of days to retain Performance Insights data.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* 7
*
*
* -
*
* month * 31, where month is a number of months from 1-23. Examples: 93 (3
* months * 31), 341 (11 months * 31), 589 (19 months * 31)
*
*
* -
*
* 731
*
*
*
*
* Default: 7 days
*
*
* If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
*/
public final Integer performanceInsightsRetentionPeriod() {
return performanceInsightsRetentionPeriod;
}
/**
*
* The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
*
*
* A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance
* immediately. Therefore, the ApplyImmediately parameter has no effect.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
*
* A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB
* instance immediately. Therefore, the ApplyImmediately parameter has no effect.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration() {
return cloudwatchLogsExportConfiguration;
}
/**
* For responses, this returns true if the service returned a value for the ProcessorFeatures property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasProcessorFeatures() {
return processorFeatures != null && !(processorFeatures instanceof SdkAutoConstructList);
}
/**
*
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasProcessorFeatures} method.
*
*
* @return The number of CPU cores and the number of threads per core for the DB instance class of the DB
* instance.
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final List processorFeatures() {
return processorFeatures;
}
/**
*
* Specifies whether the DB instance class of the DB instance uses its default processor features.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return Specifies whether the DB instance class of the DB instance uses its default processor features.
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final Boolean useDefaultProcessorFeatures() {
return useDefaultProcessorFeatures;
}
/**
*
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion
* protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB
* Instance.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the
* DB cluster. For more information, see ModifyDBCluster. DB instances in a DB cluster can be deleted
* even when deletion protection is enabled for the DB cluster.
*
*
* @return Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see
* Deleting a DB
* Instance.
*
* This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection
* for the DB cluster. For more information, see ModifyDBCluster. DB instances in a DB cluster
* can be deleted even when deletion protection is enabled for the DB cluster.
*/
public final Boolean deletionProtection() {
return deletionProtection;
}
/**
*
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
*
*
* For more information about this setting, including limitations that apply to it, see
* Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
* instance.
*
* For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User
* Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final Integer maxAllocatedStorage() {
return maxAllocatedStorage;
}
/**
*
* Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
*
*
* By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated
* until the DB instance is restarted.
*
*
*
* Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
*
*
*
* If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to
* rotate your SSL/TLS certificate:
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for RDS DB engines, see
* Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for Aurora DB engines, see
* Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
*
*
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
*
* By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not
* updated until the DB instance is restarted.
*
*
*
* Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
*
*
*
* If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB
* engine to rotate your SSL/TLS certificate:
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for RDS DB engines, see
* Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
*
*
*
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final Boolean certificateRotationRestart() {
return certificateRotationRestart;
}
/**
*
* A value that sets the open mode of a replica database to either mounted or read-only.
*
*
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is
* cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the
* mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
* For more information, see Working with Oracle Read
* Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #replicaMode} will
* return {@link ReplicaMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #replicaModeAsString}.
*
*
* @return A value that sets the open mode of a replica database to either mounted or read-only.
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is
* cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit
* information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't
* serve a read-only workload. For more information, see Working with
* Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @see ReplicaMode
*/
public final ReplicaMode replicaMode() {
return ReplicaMode.fromValue(replicaMode);
}
/**
*
* A value that sets the open mode of a replica database to either mounted or read-only.
*
*
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is
* cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the
* mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
* For more information, see Working with Oracle Read
* Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #replicaMode} will
* return {@link ReplicaMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #replicaModeAsString}.
*
*
* @return A value that sets the open mode of a replica database to either mounted or read-only.
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is
* cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit
* information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't
* serve a read-only workload. For more information, see Working with
* Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @see ReplicaMode
*/
public final String replicaModeAsString() {
return replicaMode;
}
/**
*
* Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
*
*
* A CoIP provides local or external connectivity to resources in your Outpost subnets through your
* on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from
* outside of its virtual private cloud (VPC) on your local network.
*
*
* For more information about RDS on Outposts, see Working with Amazon RDS on
* Amazon Web Services Outposts in the Amazon RDS User Guide.
*
*
* For more information about CoIPs, see Customer-owned IP
* addresses in the Amazon Web Services Outposts User Guide.
*
*
* @return Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
*
* A CoIP provides local or external connectivity to resources in your Outpost subnets through your
* on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB
* instance from outside of its virtual private cloud (VPC) on your local network.
*
*
* For more information about RDS on Outposts, see Working with Amazon
* RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
*
*
* For more information about CoIPs, see Customer-owned IP
* addresses in the Amazon Web Services Outposts User Guide.
*/
public final Boolean enableCustomerOwnedIp() {
return enableCustomerOwnedIp;
}
/**
*
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @return The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
*
* This setting doesn't apply to RDS Custom DB instances.
*/
public final String awsBackupRecoveryPointArn() {
return awsBackupRecoveryPointArn;
}
/**
*
* The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring and
* instance recovery. If all paused, the instance pauses automation for the duration set by
* ResumeFullAutomationModeMinutes.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #automationMode}
* will return {@link AutomationMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #automationModeAsString}.
*
*
* @return The automation mode of the RDS Custom DB instance. If full, the DB instance automates
* monitoring and instance recovery. If all paused, the instance pauses automation for the
* duration set by ResumeFullAutomationModeMinutes.
* @see AutomationMode
*/
public final AutomationMode automationMode() {
return AutomationMode.fromValue(automationMode);
}
/**
*
* The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring and
* instance recovery. If all paused, the instance pauses automation for the duration set by
* ResumeFullAutomationModeMinutes.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #automationMode}
* will return {@link AutomationMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #automationModeAsString}.
*
*
* @return The automation mode of the RDS Custom DB instance. If full, the DB instance automates
* monitoring and instance recovery. If all paused, the instance pauses automation for the
* duration set by ResumeFullAutomationModeMinutes.
* @see AutomationMode
*/
public final String automationModeAsString() {
return automationMode;
}
/**
*
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
*
*
* Default: 60
*
*
* Constraints:
*
*
* -
*
* Must be at least 60.
*
*
* -
*
* Must be no more than 1,440.
*
*
*
*
* @return The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full
* automation.
*
* Default: 60
*
*
* Constraints:
*
*
* -
*
* Must be at least 60.
*
*
* -
*
* Must be no more than 1,440.
*
*
*/
public final Integer resumeFullAutomationModeMinutes() {
return resumeFullAutomationModeMinutes;
}
/**
*
* The network type of the DB instance.
*
*
* The network type is determined by the DBSubnetGroup specified for the DB instance. A
* DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see Working
* with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* Valid Values: IPV4 | DUAL
*
*
* @return The network type of the DB instance.
*
* The network type is determined by the DBSubnetGroup specified for the DB instance. A
* DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* Valid Values: IPV4 | DUAL
*/
public final String networkType() {
return networkType;
}
/**
*
* The storage throughput value for the DB instance.
*
*
* This setting applies only to the gp3 storage type.
*
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*
*
* @return The storage throughput value for the DB instance.
*
* This setting applies only to the gp3 storage type.
*
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*/
public final Integer storageThroughput() {
return storageThroughput;
}
/**
*
* Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
*
*
* If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
* on this management. In this case, you can't specify MasterUserPassword.
*
*
* If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you
* specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
* specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password
* for the master user specified by MasterUserPassword.
*
*
* For more information, see Password management with
* Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
* is specified.
*
*
*
*
* @return Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
*
* If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you
* can turn on this management. In this case, you can't specify MasterUserPassword.
*
*
* If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and
* you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
* you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses
* the new password for the master user specified by MasterUserPassword.
*
*
* For more information, see Password
* management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Can't manage the master user password with Amazon Web Services Secrets Manager if
* MasterUserPassword is specified.
*
*
*/
public final Boolean manageMasterUserPassword() {
return manageMasterUserPassword;
}
/**
*
* Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
* password.
*
*
* This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager
* for the DB cluster. The secret value contains the updated password.
*
*
* For more information, see Password management with
* Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* You must apply the change immediately when rotating the master user password.
*
*
*
*
* @return Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
* password.
*
* This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets
* Manager for the DB cluster. The secret value contains the updated password.
*
*
* For more information, see Password
* management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* You must apply the change immediately when rotating the master user password.
*
*
*/
public final Boolean rotateMasterUserPassword() {
return rotateMasterUserPassword;
}
/**
*
* The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
* Amazon Web Services Secrets Manager.
*
*
* This setting is valid only if both of the following conditions are met:
*
*
* -
*
* The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
*
*
* If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't
* change the KMS key used to encrypt the secret.
*
*
* -
*
* You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web
* Services Secrets Manager.
*
*
* If you are turning on ManageMasterUserPassword and don't specify
* MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the
* secret. If the secret is in a different Amazon Web Services account, then you can't use the
* aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
*
*
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To
* use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* 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 Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and
* managed in Amazon Web Services Secrets Manager.
*
* This setting is valid only if both of the following conditions are met:
*
*
* -
*
* The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
*
*
* If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you
* can't change the KMS key used to encrypt the secret.
*
*
* -
*
* You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web
* Services Secrets Manager.
*
*
* If you are turning on ManageMasterUserPassword and don't specify
* MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to
* encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
* aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS
* key.
*
*
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS
* key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* 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 masterUserSecretKmsKeyId() {
return masterUserSecretKmsKeyId;
}
/**
*
* The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade
* an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
*
*
* Note the following requirements:
*
*
* -
*
* Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.
*
*
* -
*
* Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
*
*
*
*
* Note the following limitations:
*
*
* -
*
* You can't convert a CDB to a non-CDB.
*
*
* -
*
* You can't convert a replica database.
*
*
* -
*
* You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
*
*
* -
*
* You can't convert the existing custom parameter or option group when it has options or parameters that are
* permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To
* avoid reverting to the default, specify a new parameter group with --db-parameter-group-name and a
* new option group with --option-group-name.
*
*
*
*
* @return The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to
* upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
*
* Note the following requirements:
*
*
* -
*
* Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.
*
*
* -
*
* Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
*
*
*
*
* Note the following limitations:
*
*
* -
*
* You can't convert a CDB to a non-CDB.
*
*
* -
*
* You can't convert a replica database.
*
*
* -
*
* You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
*
*
* -
*
* You can't convert the existing custom parameter or option group when it has options or parameters that
* are permanent or persistent. In this situation, the DB instance reverts to the default option and
* parameter group. To avoid reverting to the default, specify a new parameter group with
* --db-parameter-group-name and a new option group with --option-group-name.
*
*
*/
public final String engine() {
return engine;
}
/**
*
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*
*
* @return Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*/
public final Boolean dedicatedLogVolume() {
return dedicatedLogVolume;
}
/**
*
* Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
* configuration. This parameter is supported only for RDS for Oracle CDB instances.
*
*
* During the conversion, RDS creates an initial tenant database and associates the DB name, master user name,
* character set, and national character set metadata with this database. The tags associated with the instance also
* propagate to the initial tenant database. You can add more tenant databases to your DB instance by using the
* CreateTenantDatabase operation.
*
*
*
* The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert back
* to the single-tenant configuration. When you specify this parameter, you must also specify
* ApplyImmediately.
*
*
*
* @return Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
* configuration. This parameter is supported only for RDS for Oracle CDB instances.
*
* During the conversion, RDS creates an initial tenant database and associates the DB name, master user
* name, character set, and national character set metadata with this database. The tags associated with the
* instance also propagate to the initial tenant database. You can add more tenant databases to your DB
* instance by using the CreateTenantDatabase operation.
*
*
*
* The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later
* convert back to the single-tenant configuration. When you specify this parameter, you must also specify
* ApplyImmediately.
*
*/
public final Boolean multiTenant() {
return multiTenant;
}
@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(allocatedStorage());
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceClass());
hashCode = 31 * hashCode + Objects.hashCode(dbSubnetGroupName());
hashCode = 31 * hashCode + Objects.hashCode(hasDbSecurityGroups() ? dbSecurityGroups() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasVpcSecurityGroupIds() ? vpcSecurityGroupIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(applyImmediately());
hashCode = 31 * hashCode + Objects.hashCode(masterUserPassword());
hashCode = 31 * hashCode + Objects.hashCode(dbParameterGroupName());
hashCode = 31 * hashCode + Objects.hashCode(backupRetentionPeriod());
hashCode = 31 * hashCode + Objects.hashCode(preferredBackupWindow());
hashCode = 31 * hashCode + Objects.hashCode(preferredMaintenanceWindow());
hashCode = 31 * hashCode + Objects.hashCode(multiAZ());
hashCode = 31 * hashCode + Objects.hashCode(engineVersion());
hashCode = 31 * hashCode + Objects.hashCode(allowMajorVersionUpgrade());
hashCode = 31 * hashCode + Objects.hashCode(autoMinorVersionUpgrade());
hashCode = 31 * hashCode + Objects.hashCode(licenseModel());
hashCode = 31 * hashCode + Objects.hashCode(iops());
hashCode = 31 * hashCode + Objects.hashCode(optionGroupName());
hashCode = 31 * hashCode + Objects.hashCode(newDBInstanceIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(storageType());
hashCode = 31 * hashCode + Objects.hashCode(tdeCredentialArn());
hashCode = 31 * hashCode + Objects.hashCode(tdeCredentialPassword());
hashCode = 31 * hashCode + Objects.hashCode(caCertificateIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(domain());
hashCode = 31 * hashCode + Objects.hashCode(domainFqdn());
hashCode = 31 * hashCode + Objects.hashCode(domainOu());
hashCode = 31 * hashCode + Objects.hashCode(domainAuthSecretArn());
hashCode = 31 * hashCode + Objects.hashCode(hasDomainDnsIps() ? domainDnsIps() : null);
hashCode = 31 * hashCode + Objects.hashCode(copyTagsToSnapshot());
hashCode = 31 * hashCode + Objects.hashCode(monitoringInterval());
hashCode = 31 * hashCode + Objects.hashCode(dbPortNumber());
hashCode = 31 * hashCode + Objects.hashCode(publiclyAccessible());
hashCode = 31 * hashCode + Objects.hashCode(monitoringRoleArn());
hashCode = 31 * hashCode + Objects.hashCode(domainIAMRoleName());
hashCode = 31 * hashCode + Objects.hashCode(disableDomain());
hashCode = 31 * hashCode + Objects.hashCode(promotionTier());
hashCode = 31 * hashCode + Objects.hashCode(enableIAMDatabaseAuthentication());
hashCode = 31 * hashCode + Objects.hashCode(enablePerformanceInsights());
hashCode = 31 * hashCode + Objects.hashCode(performanceInsightsKMSKeyId());
hashCode = 31 * hashCode + Objects.hashCode(performanceInsightsRetentionPeriod());
hashCode = 31 * hashCode + Objects.hashCode(cloudwatchLogsExportConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(hasProcessorFeatures() ? processorFeatures() : null);
hashCode = 31 * hashCode + Objects.hashCode(useDefaultProcessorFeatures());
hashCode = 31 * hashCode + Objects.hashCode(deletionProtection());
hashCode = 31 * hashCode + Objects.hashCode(maxAllocatedStorage());
hashCode = 31 * hashCode + Objects.hashCode(certificateRotationRestart());
hashCode = 31 * hashCode + Objects.hashCode(replicaModeAsString());
hashCode = 31 * hashCode + Objects.hashCode(enableCustomerOwnedIp());
hashCode = 31 * hashCode + Objects.hashCode(awsBackupRecoveryPointArn());
hashCode = 31 * hashCode + Objects.hashCode(automationModeAsString());
hashCode = 31 * hashCode + Objects.hashCode(resumeFullAutomationModeMinutes());
hashCode = 31 * hashCode + Objects.hashCode(networkType());
hashCode = 31 * hashCode + Objects.hashCode(storageThroughput());
hashCode = 31 * hashCode + Objects.hashCode(manageMasterUserPassword());
hashCode = 31 * hashCode + Objects.hashCode(rotateMasterUserPassword());
hashCode = 31 * hashCode + Objects.hashCode(masterUserSecretKmsKeyId());
hashCode = 31 * hashCode + Objects.hashCode(engine());
hashCode = 31 * hashCode + Objects.hashCode(dedicatedLogVolume());
hashCode = 31 * hashCode + Objects.hashCode(multiTenant());
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(allocatedStorage(), other.allocatedStorage())
&& Objects.equals(dbInstanceClass(), other.dbInstanceClass())
&& Objects.equals(dbSubnetGroupName(), other.dbSubnetGroupName())
&& hasDbSecurityGroups() == other.hasDbSecurityGroups()
&& Objects.equals(dbSecurityGroups(), other.dbSecurityGroups())
&& hasVpcSecurityGroupIds() == other.hasVpcSecurityGroupIds()
&& Objects.equals(vpcSecurityGroupIds(), other.vpcSecurityGroupIds())
&& Objects.equals(applyImmediately(), other.applyImmediately())
&& Objects.equals(masterUserPassword(), other.masterUserPassword())
&& Objects.equals(dbParameterGroupName(), other.dbParameterGroupName())
&& Objects.equals(backupRetentionPeriod(), other.backupRetentionPeriod())
&& Objects.equals(preferredBackupWindow(), other.preferredBackupWindow())
&& Objects.equals(preferredMaintenanceWindow(), other.preferredMaintenanceWindow())
&& Objects.equals(multiAZ(), other.multiAZ()) && Objects.equals(engineVersion(), other.engineVersion())
&& Objects.equals(allowMajorVersionUpgrade(), other.allowMajorVersionUpgrade())
&& Objects.equals(autoMinorVersionUpgrade(), other.autoMinorVersionUpgrade())
&& Objects.equals(licenseModel(), other.licenseModel()) && Objects.equals(iops(), other.iops())
&& Objects.equals(optionGroupName(), other.optionGroupName())
&& Objects.equals(newDBInstanceIdentifier(), other.newDBInstanceIdentifier())
&& Objects.equals(storageType(), other.storageType())
&& Objects.equals(tdeCredentialArn(), other.tdeCredentialArn())
&& Objects.equals(tdeCredentialPassword(), other.tdeCredentialPassword())
&& Objects.equals(caCertificateIdentifier(), other.caCertificateIdentifier())
&& Objects.equals(domain(), other.domain()) && Objects.equals(domainFqdn(), other.domainFqdn())
&& Objects.equals(domainOu(), other.domainOu())
&& Objects.equals(domainAuthSecretArn(), other.domainAuthSecretArn())
&& hasDomainDnsIps() == other.hasDomainDnsIps() && Objects.equals(domainDnsIps(), other.domainDnsIps())
&& Objects.equals(copyTagsToSnapshot(), other.copyTagsToSnapshot())
&& Objects.equals(monitoringInterval(), other.monitoringInterval())
&& Objects.equals(dbPortNumber(), other.dbPortNumber())
&& Objects.equals(publiclyAccessible(), other.publiclyAccessible())
&& Objects.equals(monitoringRoleArn(), other.monitoringRoleArn())
&& Objects.equals(domainIAMRoleName(), other.domainIAMRoleName())
&& Objects.equals(disableDomain(), other.disableDomain())
&& Objects.equals(promotionTier(), other.promotionTier())
&& Objects.equals(enableIAMDatabaseAuthentication(), other.enableIAMDatabaseAuthentication())
&& Objects.equals(enablePerformanceInsights(), other.enablePerformanceInsights())
&& Objects.equals(performanceInsightsKMSKeyId(), other.performanceInsightsKMSKeyId())
&& Objects.equals(performanceInsightsRetentionPeriod(), other.performanceInsightsRetentionPeriod())
&& Objects.equals(cloudwatchLogsExportConfiguration(), other.cloudwatchLogsExportConfiguration())
&& hasProcessorFeatures() == other.hasProcessorFeatures()
&& Objects.equals(processorFeatures(), other.processorFeatures())
&& Objects.equals(useDefaultProcessorFeatures(), other.useDefaultProcessorFeatures())
&& Objects.equals(deletionProtection(), other.deletionProtection())
&& Objects.equals(maxAllocatedStorage(), other.maxAllocatedStorage())
&& Objects.equals(certificateRotationRestart(), other.certificateRotationRestart())
&& Objects.equals(replicaModeAsString(), other.replicaModeAsString())
&& Objects.equals(enableCustomerOwnedIp(), other.enableCustomerOwnedIp())
&& Objects.equals(awsBackupRecoveryPointArn(), other.awsBackupRecoveryPointArn())
&& Objects.equals(automationModeAsString(), other.automationModeAsString())
&& Objects.equals(resumeFullAutomationModeMinutes(), other.resumeFullAutomationModeMinutes())
&& Objects.equals(networkType(), other.networkType())
&& Objects.equals(storageThroughput(), other.storageThroughput())
&& Objects.equals(manageMasterUserPassword(), other.manageMasterUserPassword())
&& Objects.equals(rotateMasterUserPassword(), other.rotateMasterUserPassword())
&& Objects.equals(masterUserSecretKmsKeyId(), other.masterUserSecretKmsKeyId())
&& Objects.equals(engine(), other.engine()) && Objects.equals(dedicatedLogVolume(), other.dedicatedLogVolume())
&& Objects.equals(multiTenant(), other.multiTenant());
}
/**
* 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("AllocatedStorage", allocatedStorage()).add("DBInstanceClass", dbInstanceClass())
.add("DBSubnetGroupName", dbSubnetGroupName())
.add("DBSecurityGroups", hasDbSecurityGroups() ? dbSecurityGroups() : null)
.add("VpcSecurityGroupIds", hasVpcSecurityGroupIds() ? vpcSecurityGroupIds() : null)
.add("ApplyImmediately", applyImmediately()).add("MasterUserPassword", masterUserPassword())
.add("DBParameterGroupName", dbParameterGroupName()).add("BackupRetentionPeriod", backupRetentionPeriod())
.add("PreferredBackupWindow", preferredBackupWindow())
.add("PreferredMaintenanceWindow", preferredMaintenanceWindow()).add("MultiAZ", multiAZ())
.add("EngineVersion", engineVersion()).add("AllowMajorVersionUpgrade", allowMajorVersionUpgrade())
.add("AutoMinorVersionUpgrade", autoMinorVersionUpgrade()).add("LicenseModel", licenseModel())
.add("Iops", iops()).add("OptionGroupName", optionGroupName())
.add("NewDBInstanceIdentifier", newDBInstanceIdentifier()).add("StorageType", storageType())
.add("TdeCredentialArn", tdeCredentialArn()).add("TdeCredentialPassword", tdeCredentialPassword())
.add("CACertificateIdentifier", caCertificateIdentifier()).add("Domain", domain())
.add("DomainFqdn", domainFqdn()).add("DomainOu", domainOu()).add("DomainAuthSecretArn", domainAuthSecretArn())
.add("DomainDnsIps", hasDomainDnsIps() ? domainDnsIps() : null).add("CopyTagsToSnapshot", copyTagsToSnapshot())
.add("MonitoringInterval", monitoringInterval()).add("DBPortNumber", dbPortNumber())
.add("PubliclyAccessible", publiclyAccessible()).add("MonitoringRoleArn", monitoringRoleArn())
.add("DomainIAMRoleName", domainIAMRoleName()).add("DisableDomain", disableDomain())
.add("PromotionTier", promotionTier()).add("EnableIAMDatabaseAuthentication", enableIAMDatabaseAuthentication())
.add("EnablePerformanceInsights", enablePerformanceInsights())
.add("PerformanceInsightsKMSKeyId", performanceInsightsKMSKeyId())
.add("PerformanceInsightsRetentionPeriod", performanceInsightsRetentionPeriod())
.add("CloudwatchLogsExportConfiguration", cloudwatchLogsExportConfiguration())
.add("ProcessorFeatures", hasProcessorFeatures() ? processorFeatures() : null)
.add("UseDefaultProcessorFeatures", useDefaultProcessorFeatures())
.add("DeletionProtection", deletionProtection()).add("MaxAllocatedStorage", maxAllocatedStorage())
.add("CertificateRotationRestart", certificateRotationRestart()).add("ReplicaMode", replicaModeAsString())
.add("EnableCustomerOwnedIp", enableCustomerOwnedIp())
.add("AwsBackupRecoveryPointArn", awsBackupRecoveryPointArn()).add("AutomationMode", automationModeAsString())
.add("ResumeFullAutomationModeMinutes", resumeFullAutomationModeMinutes()).add("NetworkType", networkType())
.add("StorageThroughput", storageThroughput()).add("ManageMasterUserPassword", manageMasterUserPassword())
.add("RotateMasterUserPassword", rotateMasterUserPassword())
.add("MasterUserSecretKmsKeyId", masterUserSecretKmsKeyId()).add("Engine", engine())
.add("DedicatedLogVolume", dedicatedLogVolume()).add("MultiTenant", multiTenant()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(dbInstanceIdentifier()));
case "AllocatedStorage":
return Optional.ofNullable(clazz.cast(allocatedStorage()));
case "DBInstanceClass":
return Optional.ofNullable(clazz.cast(dbInstanceClass()));
case "DBSubnetGroupName":
return Optional.ofNullable(clazz.cast(dbSubnetGroupName()));
case "DBSecurityGroups":
return Optional.ofNullable(clazz.cast(dbSecurityGroups()));
case "VpcSecurityGroupIds":
return Optional.ofNullable(clazz.cast(vpcSecurityGroupIds()));
case "ApplyImmediately":
return Optional.ofNullable(clazz.cast(applyImmediately()));
case "MasterUserPassword":
return Optional.ofNullable(clazz.cast(masterUserPassword()));
case "DBParameterGroupName":
return Optional.ofNullable(clazz.cast(dbParameterGroupName()));
case "BackupRetentionPeriod":
return Optional.ofNullable(clazz.cast(backupRetentionPeriod()));
case "PreferredBackupWindow":
return Optional.ofNullable(clazz.cast(preferredBackupWindow()));
case "PreferredMaintenanceWindow":
return Optional.ofNullable(clazz.cast(preferredMaintenanceWindow()));
case "MultiAZ":
return Optional.ofNullable(clazz.cast(multiAZ()));
case "EngineVersion":
return Optional.ofNullable(clazz.cast(engineVersion()));
case "AllowMajorVersionUpgrade":
return Optional.ofNullable(clazz.cast(allowMajorVersionUpgrade()));
case "AutoMinorVersionUpgrade":
return Optional.ofNullable(clazz.cast(autoMinorVersionUpgrade()));
case "LicenseModel":
return Optional.ofNullable(clazz.cast(licenseModel()));
case "Iops":
return Optional.ofNullable(clazz.cast(iops()));
case "OptionGroupName":
return Optional.ofNullable(clazz.cast(optionGroupName()));
case "NewDBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(newDBInstanceIdentifier()));
case "StorageType":
return Optional.ofNullable(clazz.cast(storageType()));
case "TdeCredentialArn":
return Optional.ofNullable(clazz.cast(tdeCredentialArn()));
case "TdeCredentialPassword":
return Optional.ofNullable(clazz.cast(tdeCredentialPassword()));
case "CACertificateIdentifier":
return Optional.ofNullable(clazz.cast(caCertificateIdentifier()));
case "Domain":
return Optional.ofNullable(clazz.cast(domain()));
case "DomainFqdn":
return Optional.ofNullable(clazz.cast(domainFqdn()));
case "DomainOu":
return Optional.ofNullable(clazz.cast(domainOu()));
case "DomainAuthSecretArn":
return Optional.ofNullable(clazz.cast(domainAuthSecretArn()));
case "DomainDnsIps":
return Optional.ofNullable(clazz.cast(domainDnsIps()));
case "CopyTagsToSnapshot":
return Optional.ofNullable(clazz.cast(copyTagsToSnapshot()));
case "MonitoringInterval":
return Optional.ofNullable(clazz.cast(monitoringInterval()));
case "DBPortNumber":
return Optional.ofNullable(clazz.cast(dbPortNumber()));
case "PubliclyAccessible":
return Optional.ofNullable(clazz.cast(publiclyAccessible()));
case "MonitoringRoleArn":
return Optional.ofNullable(clazz.cast(monitoringRoleArn()));
case "DomainIAMRoleName":
return Optional.ofNullable(clazz.cast(domainIAMRoleName()));
case "DisableDomain":
return Optional.ofNullable(clazz.cast(disableDomain()));
case "PromotionTier":
return Optional.ofNullable(clazz.cast(promotionTier()));
case "EnableIAMDatabaseAuthentication":
return Optional.ofNullable(clazz.cast(enableIAMDatabaseAuthentication()));
case "EnablePerformanceInsights":
return Optional.ofNullable(clazz.cast(enablePerformanceInsights()));
case "PerformanceInsightsKMSKeyId":
return Optional.ofNullable(clazz.cast(performanceInsightsKMSKeyId()));
case "PerformanceInsightsRetentionPeriod":
return Optional.ofNullable(clazz.cast(performanceInsightsRetentionPeriod()));
case "CloudwatchLogsExportConfiguration":
return Optional.ofNullable(clazz.cast(cloudwatchLogsExportConfiguration()));
case "ProcessorFeatures":
return Optional.ofNullable(clazz.cast(processorFeatures()));
case "UseDefaultProcessorFeatures":
return Optional.ofNullable(clazz.cast(useDefaultProcessorFeatures()));
case "DeletionProtection":
return Optional.ofNullable(clazz.cast(deletionProtection()));
case "MaxAllocatedStorage":
return Optional.ofNullable(clazz.cast(maxAllocatedStorage()));
case "CertificateRotationRestart":
return Optional.ofNullable(clazz.cast(certificateRotationRestart()));
case "ReplicaMode":
return Optional.ofNullable(clazz.cast(replicaModeAsString()));
case "EnableCustomerOwnedIp":
return Optional.ofNullable(clazz.cast(enableCustomerOwnedIp()));
case "AwsBackupRecoveryPointArn":
return Optional.ofNullable(clazz.cast(awsBackupRecoveryPointArn()));
case "AutomationMode":
return Optional.ofNullable(clazz.cast(automationModeAsString()));
case "ResumeFullAutomationModeMinutes":
return Optional.ofNullable(clazz.cast(resumeFullAutomationModeMinutes()));
case "NetworkType":
return Optional.ofNullable(clazz.cast(networkType()));
case "StorageThroughput":
return Optional.ofNullable(clazz.cast(storageThroughput()));
case "ManageMasterUserPassword":
return Optional.ofNullable(clazz.cast(manageMasterUserPassword()));
case "RotateMasterUserPassword":
return Optional.ofNullable(clazz.cast(rotateMasterUserPassword()));
case "MasterUserSecretKmsKeyId":
return Optional.ofNullable(clazz.cast(masterUserSecretKmsKeyId()));
case "Engine":
return Optional.ofNullable(clazz.cast(engine()));
case "DedicatedLogVolume":
return Optional.ofNullable(clazz.cast(dedicatedLogVolume()));
case "MultiTenant":
return Optional.ofNullable(clazz.cast(multiTenant()));
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 RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of DB instance to modify. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DB instance.
*
*
*
*
* @param dbInstanceIdentifier
* The identifier of DB instance to modify. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing DB instance.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstanceIdentifier(String dbInstanceIdentifier);
/**
*
* The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
*
*
* For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must be
* at least 10% greater than the current value. Values that are not at least 10% greater than the existing value
* are rounded up so that they are 10% greater than the current value.
*
*
* For the valid values for allocated storage for each engine, see CreateDBInstance.
*
*
* Constraints:
*
*
* -
*
* When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3,
* io1, or io2 storage type), you must also specify the Iops parameter.
* You can use the current value for Iops.
*
*
*
*
* @param allocatedStorage
* The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
*
* For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied
* must be at least 10% greater than the current value. Values that are not at least 10% greater than the
* existing value are rounded up so that they are 10% greater than the current value.
*
*
* For the valid values for allocated storage for each engine, see CreateDBInstance.
*
*
* Constraints:
*
*
* -
*
* When you increase the allocated storage for a DB instance that uses Provisioned IOPS (gp3, io1, or io2 storage type), you must also specify the Iops
* parameter. You can use the current value for Iops.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allocatedStorage(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 Web Services Regions, or for all database engines. For the full
* list of DB instance classes, and availability for your engine, see DB Instance
* Class in the Amazon RDS User Guide or Aurora DB
* instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
*
*
* If you modify the DB instance class, an outage occurs during the change. The change is applied during the
* next maintenance window, unless you specify ApplyImmediately in your request.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* If you are modifying the DB instance class and upgrading the engine version at the same time, the currently
* running engine version must be supported on the specified DB instance class. Otherwise, the operation returns
* an error. In this case, first run the operation to upgrade the engine version, and then run it again to
* modify the DB instance class.
*
*
*
*
* @param dbInstanceClass
* 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 Web Services Regions, or for all database engines. For
* the full list of DB instance classes, and availability for your engine, see DB
* Instance Class in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
*
* If you modify the DB instance class, an outage occurs during the change. The change is applied during
* the next maintenance window, unless you specify ApplyImmediately in your request.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* If you are modifying the DB instance class and upgrading the engine version at the same time, the
* currently running engine version must be supported on the specified DB instance class. Otherwise, the
* operation returns an error. In this case, first run the operation to upgrade the engine version, and
* then run it again to modify the DB instance class.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstanceClass(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. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance
* into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* Changing the subnet group causes an outage during the change. The change is applied during the next
* maintenance window, unless you enable ApplyImmediately.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB subnet group.
*
*
*
*
* Example: mydbsubnetgroup
*
*
* @param dbSubnetGroupName
* The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a
* different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB
* instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
* Changing the subnet group causes an outage during the change. The change is applied during the next
* maintenance window, unless you enable ApplyImmediately.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB subnet group.
*
*
*
*
* Example: mydbsubnetgroup
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSubnetGroupName(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.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB security groups.
*
*
*
*
* @param dbSecurityGroups
* 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.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB security groups.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSecurityGroups(Collection dbSecurityGroups);
/**
*
* 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.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB security groups.
*
*
*
*
* @param dbSecurityGroups
* 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.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing DB security groups.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSecurityGroups(String... dbSecurityGroups);
/**
*
* A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously
* applied as soon as possible.
*
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
* information, see ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing VPC security group IDs.
*
*
*
*
* @param vpcSecurityGroupIds
* A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is
* asynchronously applied as soon as possible.
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
* information, see ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing VPC security group IDs.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcSecurityGroupIds(Collection vpcSecurityGroupIds);
/**
*
* A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously
* applied as soon as possible.
*
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
* information, see ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing VPC security group IDs.
*
*
*
*
* @param vpcSecurityGroupIds
* A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is
* asynchronously applied as soon as possible.
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more
* information, see ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Constraints:
*
*
* -
*
* If supplied, must match existing VPC security group IDs.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcSecurityGroupIds(String... 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.
* By default, this parameter is disabled.
*
*
* If this parameter is disabled, 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. Review the table of parameters in Modifying a
* DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling
* ApplyImmediately for each modified parameter and to determine when the changes are applied.
*
*
* @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
* DB instance. By default, this parameter is disabled.
*
* If this parameter is disabled, 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. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or
* disabling ApplyImmediately for each modified parameter and to determine when the changes
* are applied.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applyImmediately(Boolean applyImmediately);
/**
*
* The new password for the master user.
*
*
* Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as
* possible. Between the time of the request and the completion of the request, the
* MasterUserPassword element exists in the PendingModifiedValues element of the
* operation response.
*
*
*
* Amazon RDS API operations never return the password, so this operation provides a way to regain access to a
* primary instance user if the password is lost. This includes restoring privileges that might have been
* accidentally revoked.
*
*
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
* ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Can't be specified if ManageMasterUserPassword is turned on.
*
*
* -
*
* Can include any printable ASCII character except "/",
* """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
*
*
*
*
* Length Constraints:
*
*
* -
*
* RDS for Db2 - Must contain from 8 to 255 characters.
*
*
* -
*
* RDS for MariaDB - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
*
*
* -
*
* RDS for MySQL - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Oracle - Must contain from 8 to 30 characters.
*
*
* -
*
* RDS for PostgreSQL - Must contain from 8 to 128 characters.
*
*
*
*
* @param masterUserPassword
* The new password for the master user.
*
* Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon
* as possible. Between the time of the request and the completion of the request, the
* MasterUserPassword element exists in the PendingModifiedValues element of
* the operation response.
*
*
*
* Amazon RDS API operations never return the password, so this operation provides a way to regain access
* to a primary instance user if the password is lost. This includes restoring privileges that might have
* been accidentally revoked.
*
*
*
* This setting doesn't apply to the following DB instances:
*
*
* -
*
* Amazon Aurora (The password for the master user is managed by the DB cluster. For more information,
* see ModifyDBCluster.)
*
*
* -
*
* RDS Custom
*
*
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Can't be specified if ManageMasterUserPassword is turned on.
*
*
* -
*
* Can include any printable ASCII character except "/",
* """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes)
* character.
*
*
*
*
* Length Constraints:
*
*
* -
*
* RDS for Db2 - Must contain from 8 to 255 characters.
*
*
* -
*
* RDS for MariaDB - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
*
*
* -
*
* RDS for MySQL - Must contain from 8 to 41 characters.
*
*
* -
*
* RDS for Oracle - Must contain from 8 to 30 characters.
*
*
* -
*
* RDS for PostgreSQL - Must contain from 8 to 128 characters.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder masterUserPassword(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. In this
* case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next
* maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group,
* these changes are applied immediately without a reboot.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the same DB parameter group family as the DB instance.
*
*
*
*
* @param dbParameterGroupName
* 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. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't
* applied during the next maintenance window. However, if you modify dynamic parameters in the newly
* associated DB parameter group, these changes are applied immediately without a reboot.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the same DB parameter group family as the DB instance.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbParameterGroupName(String dbParameterGroupName);
/**
*
* The number of days to retain automated backups. Setting this parameter to a positive number enables backups.
* Setting this parameter to 0 disables automated backups.
*
*
*
* Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few
* minutes, depending on the size and class of your DB instance.
*
*
*
* These changes are applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request. If you change the parameter from one non-zero value to another
* non-zero value, the change is asynchronously applied as soon as possible.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is
* managed by the DB cluster. For more information, see ModifyDBCluster.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
* -
*
* Can't be set to 0 for an RDS Custom for Oracle DB instance.
*
*
*
*
* @param backupRetentionPeriod
* The number of days to retain automated backups. Setting this parameter to a positive number enables
* backups. Setting this parameter to 0 disables automated backups.
*
* Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a
* few minutes, depending on the size and class of your DB instance.
*
*
*
* These changes are applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request. If you change the parameter from one non-zero value to another
* non-zero value, the change is asynchronously applied as soon as possible.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups
* is managed by the DB cluster. For more information, see ModifyDBCluster.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be a value from 0 to 35.
*
*
* -
*
* Can't be set to 0 if the DB instance is a source to read replicas.
*
*
* -
*
* Can't be set to 0 for an RDS Custom for Oracle DB instance.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder backupRetentionPeriod(Integer backupRetentionPeriod);
/**
*
* The daily time range during which automated backups are created if automated backups are enabled, as
* determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an
* outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window
* selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information,
* see Backup window in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @param preferredBackupWindow
* The daily time range during which automated backups are created if automated backups are enabled, as
* determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result
* in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute
* window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more
* information, see Backup window in the Amazon RDS User Guide.
*
* This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred maintenance window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder preferredBackupWindow(String preferredBackupWindow);
/**
*
* The weekly time range 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 causes a reboot of
* the DB instance. If you change 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.
*
*
* For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the format ddd:hh24:mi-ddd:hh24:mi.
*
*
* -
*
* The day values must be mon | tue | wed | thu | fri | sat | sun.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred backup window.
*
*
* -
*
* Must be at least 30 minutes.
*
*
*
*
* @param preferredMaintenanceWindow
* The weekly time range 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 causes a
* reboot of the DB instance. If you change 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.
*
* For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
*
*
* Default: Uses existing setting
*
*
* Constraints:
*
*
* -
*
* Must be in the format ddd:hh24:mi-ddd:hh24:mi.
*
*
* -
*
* The day values must be mon | tue | wed | thu | fri | sat | sun.
*
*
* -
*
* Must be in Universal Coordinated Time (UTC).
*
*
* -
*
* Must not conflict with the preferred backup window.
*
*
* -
*
* 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);
/**
*
* Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an
* outage. The change is applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param multiAZ
* Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in
* an outage. The change is applied during the next maintenance window unless the
* ApplyImmediately parameter is enabled for this request.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder multiAZ(Boolean multiAZ);
/**
*
* The version number of the database engine to upgrade to. Changing this parameter results in an outage and the
* change is applied during the next maintenance window unless the ApplyImmediately parameter is
* enabled for this request.
*
*
* For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group
* in the DB parameter group family for the new engine version must be specified. The new DB parameter group can
* be the default for that DB parameter group family.
*
*
* If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the
* current minor version is lower. For information about valid engine versions, see
* CreateDBInstance, or call DescribeDBEngineVersions.
*
*
* If the instance that you're modifying is acting as a read replica, the engine version that you specify must
* be the same or higher than the version that the source DB instance or cluster is running.
*
*
* In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
* PATCH_DB_FAILURE lifecycle.
*
*
* Constraints:
*
*
* -
*
* If you are upgrading the engine version and modifying the DB instance class at the same time, the currently
* running engine version must be supported on the specified DB instance class. Otherwise, the operation returns
* an error. In this case, first run the operation to upgrade the engine version, and then run it again to
* modify the DB instance class.
*
*
*
*
* @param engineVersion
* The version number of the database engine to upgrade to. Changing this parameter results in an outage
* and the change is applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request.
*
* For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter
* group in the DB parameter group family for the new engine version must be specified. The new DB
* parameter group can be the default for that DB parameter group family.
*
*
* If you specify only a major version, Amazon RDS updates the DB instance to the default minor version
* if the current minor version is lower. For information about valid engine versions, see
* CreateDBInstance, or call DescribeDBEngineVersions.
*
*
* If the instance that you're modifying is acting as a read replica, the engine version that you specify
* must be the same or higher than the version that the source DB instance or cluster is running.
*
*
* In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
* PATCH_DB_FAILURE lifecycle.
*
*
* Constraints:
*
*
* -
*
* If you are upgrading the engine version and modifying the DB instance class at the same time, the
* currently running engine version must be supported on the specified DB instance class. Otherwise, the
* operation returns an error. In this case, first run the operation to upgrade the engine version, and
* then run it again to modify the DB instance class.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder engineVersion(String engineVersion);
/**
*
* Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and
* the change is asynchronously applied as soon as possible.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Major version upgrades must be allowed when specifying a value for the EngineVersion parameter
* that's a different major version than the DB instance's current version.
*
*
*
*
* @param allowMajorVersionUpgrade
* Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an
* outage and the change is asynchronously applied as soon as possible.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Major version upgrades must be allowed when specifying a value for the EngineVersion
* parameter that's a different major version than the DB instance's current version.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade);
/**
*
* Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance
* window. An outage occurs when all the following conditions are met:
*
*
* -
*
* The automatic upgrade is enabled for the maintenance window.
*
*
* -
*
* A newer minor version is available.
*
*
* -
*
* RDS has enabled automatic patching for the engine version.
*
*
*
*
* If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't
* cause an outage.
*
*
* For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
*
*
* @param autoMinorVersionUpgrade
* Specifies whether minor version upgrades are applied automatically to the DB instance during the
* maintenance window. An outage occurs when all the following conditions are met:
*
* -
*
* The automatic upgrade is enabled for the maintenance window.
*
*
* -
*
* A newer minor version is available.
*
*
* -
*
* RDS has enabled automatic patching for the engine version.
*
*
*
*
* If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and
* doesn't cause an outage.
*
*
* For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade);
/**
*
* The license model for the DB instance.
*
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* RDS for Db2 - bring-your-own-license
*
*
* -
*
* RDS for MariaDB - general-public-license
*
*
* -
*
* RDS for Microsoft SQL Server - license-included
*
*
* -
*
* RDS for MySQL - general-public-license
*
*
* -
*
* RDS for Oracle - bring-your-own-license | license-included
*
*
* -
*
* RDS for PostgreSQL - postgresql-license
*
*
*
*
* @param licenseModel
* The license model for the DB instance.
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* RDS for Db2 - bring-your-own-license
*
*
* -
*
* RDS for MariaDB - general-public-license
*
*
* -
*
* RDS for Microsoft SQL Server - license-included
*
*
* -
*
* RDS for MySQL - general-public-license
*
*
* -
*
* RDS for Oracle - bring-your-own-license | license-included
*
*
* -
*
* RDS for PostgreSQL - postgresql-license
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder licenseModel(String licenseModel);
/**
*
* The new Provisioned IOPS (I/O operations per second) value for the RDS 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 enabled for this request. If you are migrating
* from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the
* change in storage type to take effect.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from
* using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration
* depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS),
* amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration
* times are under 24 hours, but the process can take up to several days in some cases. During the migration,
* the DB instance is available for use, but might experience performance degradation. While the migration takes
* place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the
* instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read
* replica for the instance, and creating a DB snapshot of the instance.
*
*
* Constraints:
*
*
* -
*
* For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at
* least 10% greater than the current value. Values that are not at least 10% greater than the existing value
* are rounded up so that they are 10% greater than the current value.
*
*
* -
*
* When you increase the Provisioned IOPS, you must also specify the AllocatedStorage parameter.
* You can use the current value for AllocatedStorage.
*
*
*
*
* Default: Uses existing setting
*
*
* @param iops
* The new Provisioned IOPS (I/O operations per second) value for the RDS 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 enabled for this request. If
* you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will
* require a reboot for the change in storage type to take effect.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can take time. The duration of the
* migration depends on several factors such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage
* operations. Typical migration times are under 24 hours, but the process can take up to several days in
* some cases. During the migration, the DB instance is available for use, but might experience
* performance degradation. While the migration takes place, nightly backups for the instance are
* suspended. No other Amazon RDS operations can take place for the instance, including modifying the
* instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and
* creating a DB snapshot of the instance.
*
*
* Constraints:
*
*
* -
*
* For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must
* be at least 10% greater than the current value. Values that are not at least 10% greater than the
* existing value are rounded up so that they are 10% greater than the current value.
*
*
* -
*
* When you increase the Provisioned IOPS, you must also specify the AllocatedStorage
* parameter. You can use the current value for AllocatedStorage.
*
*
*
*
* Default: Uses existing setting
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder iops(Integer iops);
/**
*
* The option group to associate the DB instance with.
*
*
* Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in
* an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new
* connections are rejected but existing connections aren't interrupted.
*
*
* The change is applied during the next maintenance window unless the ApplyImmediately parameter
* is enabled for this request.
*
*
* Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option
* group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param optionGroupName
* The option group to associate the DB instance with.
*
* Changing this parameter doesn't result in an outage, with one exception. If the parameter change
* results in an option group that enables OEM, it can cause a brief period, lasting less than a second,
* during which new connections are rejected but existing connections aren't interrupted.
*
*
* The change is applied during the next maintenance window unless the ApplyImmediately
* parameter is enabled for this request.
*
*
* Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an
* option group, and that option group can't be removed from a DB instance after it is associated with a
* DB instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder optionGroupName(String optionGroupName);
/**
*
* The new identifier for the DB instance when renaming a DB instance. When you change the DB instance
* identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur
* during the next maintenance window if you disable ApplyImmediately. This value is stored as a
* lowercase string.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: mydbinstance
*
*
* @param newDBInstanceIdentifier
* The new identifier for the DB instance when renaming a DB instance. When you change the DB instance
* identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will
* occur during the next maintenance window if you disable ApplyImmediately. This value is
* stored as a lowercase string.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't 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);
/**
*
* The storage type to associate with the DB instance.
*
*
* If you specify io1, io2, or gp3 you must also include a value for the
* Iops parameter.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from
* using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration
* depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS),
* amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration
* times are under 24 hours, but the process can take up to several days in some cases. During the migration,
* the DB instance is available for use, but might experience performance degradation. While the migration takes
* place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the
* instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read
* replica for the instance, and creating a DB snapshot of the instance.
*
*
* Valid Values: gp2 | gp3 | io1 | io2 | standard
*
*
* Default: io1, if the Iops parameter is specified. Otherwise, gp2.
*
*
* @param storageType
* The storage type to associate with the DB instance.
*
* If you specify io1, io2, or gp3 you must also include a value
* for the Iops parameter.
*
*
* If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or
* from using Provisioned IOPS to using standard storage, the process can take time. The duration of the
* migration depends on several factors such as database load, storage size, storage type (standard or
* Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage
* operations. Typical migration times are under 24 hours, but the process can take up to several days in
* some cases. During the migration, the DB instance is available for use, but might experience
* performance degradation. While the migration takes place, nightly backups for the instance are
* suspended. No other Amazon RDS operations can take place for the instance, including modifying the
* instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and
* creating a DB snapshot of the instance.
*
*
* Valid Values: gp2 | gp3 | io1 | io2 | standard
*
*
* Default: io1, if the Iops parameter is specified. Otherwise,
* gp2.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder storageType(String storageType);
/**
*
* The ARN from the key store with which to associate the instance for TDE encryption.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param tdeCredentialArn
* The ARN from the key store with which to associate the instance for TDE encryption.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tdeCredentialArn(String tdeCredentialArn);
/**
*
* The password for the given ARN from the key store in order to access the device.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param tdeCredentialPassword
* The password for the given ARN from the key store in order to access the device.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tdeCredentialPassword(String tdeCredentialPassword);
/**
*
* The CA certificate identifier to use for the DB instance's server certificate.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* For more information, see Using SSL/TLS to encrypt
* a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to
* encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
*
*
* @param caCertificateIdentifier
* The CA certificate identifier to use for the DB instance's server certificate.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* For more information, see Using SSL/TLS to
* encrypt a connection to a DB instance in the Amazon RDS User Guide and Using
* SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder caCertificateIdentifier(String caCertificateIdentifier);
/**
*
* The Active Directory directory ID to move the DB instance to. Specify none to remove the
* instance from its current domain. You must create the domain before this operation. Currently, you can create
* only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
*
*
* For more information, see Kerberos
* Authentication in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param domain
* The Active Directory directory ID to move the DB instance to. Specify none to remove the
* instance from its current domain. You must create the domain before this operation. Currently, you can
* create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active
* Directory Domain.
*
* For more information, see Kerberos
* Authentication in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domain(String domain);
/**
*
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
*
*
* @param domainFqdn
* The fully qualified domain name (FQDN) of an Active Directory domain.
*
* Constraints:
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: mymanagedADtest.mymanagedAD.mydomain
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainFqdn(String domainFqdn);
/**
*
* The Active Directory organizational unit for your DB instance to join.
*
*
* Constraints:
*
*
* -
*
* Must be in the distinguished name format.
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
*
*
* @param domainOu
* The Active Directory organizational unit for your DB instance to join.
*
* Constraints:
*
*
* -
*
* Must be in the distinguished name format.
*
*
* -
*
* Can't be longer than 64 characters.
*
*
*
*
* Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainOu(String domainOu);
/**
*
* The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
*
*
* Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
*
*
* @param domainAuthSecretArn
* The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
*
* Example:
* arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainAuthSecretArn(String domainAuthSecretArn);
/**
*
* The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
*
*
* Constraints:
*
*
* -
*
* Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the
* primary domain controller for both entries in the list.
*
*
*
*
* Example: 123.124.125.126,234.235.236.237
*
*
* @param domainDnsIps
* The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
*
* Constraints:
*
*
* -
*
* Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of
* the primary domain controller for both entries in the list.
*
*
*
*
* Example: 123.124.125.126,234.235.236.237
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainDnsIps(Collection domainDnsIps);
/**
*
* The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
*
*
* Constraints:
*
*
* -
*
* Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the
* primary domain controller for both entries in the list.
*
*
*
*
* Example: 123.124.125.126,234.235.236.237
*
*
* @param domainDnsIps
* The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
*
* Constraints:
*
*
* -
*
* Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of
* the primary domain controller for both entries in the list.
*
*
*
*
* Example: 123.124.125.126,234.235.236.237
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainDnsIps(String... domainDnsIps);
/**
*
* Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags
* aren't copied.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB
* cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more
* information, see ModifyDBCluster.
*
*
* @param copyTagsToSnapshot
* Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default,
* tags aren't copied.
*
* This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the
* DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For
* more information, see ModifyDBCluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot);
/**
*
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
* To disable collection of Enhanced Monitoring metrics, specify 0.
*
*
* If MonitoringRoleArn is specified, set MonitoringInterval to a value other than
* 0.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
*
*
* Default: 0
*
*
* @param monitoringInterval
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
* instance. To disable collection of Enhanced Monitoring metrics, specify 0.
*
* If MonitoringRoleArn is specified, set MonitoringInterval to a value other
* than 0.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
*
*
* Default: 0
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder monitoringInterval(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.
*
*
* If you change the DBPortNumber value, your database restarts regardless of the value of the
* ApplyImmediately parameter.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 1150-65535
*
*
* Default:
*
*
* -
*
* Amazon Aurora - 3306
*
*
* -
*
* RDS for Db2 - 50000
*
*
* -
*
* RDS for MariaDB - 3306
*
*
* -
*
* RDS for Microsoft SQL Server - 1433
*
*
* -
*
* RDS for MySQL - 3306
*
*
* -
*
* RDS for Oracle - 1521
*
*
* -
*
* RDS for PostgreSQL - 5432
*
*
*
*
* Constraints:
*
*
* -
*
* For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260,
* 3343, 3389, 47001, or 49152-49156.
*
*
*
*
* @param dbPortNumber
* 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.
*
*
* If you change the DBPortNumber value, your database restarts regardless of the value of
* the ApplyImmediately parameter.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values: 1150-65535
*
*
* Default:
*
*
* -
*
* Amazon Aurora - 3306
*
*
* -
*
* RDS for Db2 - 50000
*
*
* -
*
* RDS for MariaDB - 3306
*
*
* -
*
* RDS for Microsoft SQL Server - 1433
*
*
* -
*
* RDS for MySQL - 3306
*
*
* -
*
* RDS for Oracle - 1521
*
*
* -
*
* RDS for PostgreSQL - 5432
*
*
*
*
* Constraints:
*
*
* -
*
* For RDS for Microsoft SQL Server, the value can't be 1234, 1434,
* 3260, 3343, 3389, 47001, or
* 49152-49156.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbPortNumber(Integer dbPortNumber);
/**
*
* Specifies whether the DB instance is publicly accessible.
*
*
* When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private
* cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from
* within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB
* instance is ultimately controlled by the security group it uses. That public access isn't permitted if the
* security group assigned to the DB instance doesn't permit it.
*
*
* When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves
* to a private IP address.
*
*
* PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a
* public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
*
*
* Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of
* the ApplyImmediately parameter.
*
*
* @param publiclyAccessible
* Specifies whether the DB instance is publicly accessible.
*
* When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual
* private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you
* connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address.
* Access to the DB instance is ultimately controlled by the security group it uses. That public access
* isn't permitted if the security group assigned to the DB instance doesn't permit it.
*
*
* When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that
* resolves to a private IP address.
*
*
* PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of
* a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
*
*
* Changes to the PubliclyAccessible parameter are applied immediately regardless of the
* value of the ApplyImmediately parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder publiclyAccessible(Boolean publiclyAccessible);
/**
*
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
* example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,
* see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
*
*
* If MonitoringInterval is set to a value other than 0, supply a
* MonitoringRoleArn value.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param monitoringRoleArn
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch
* Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a
* monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
*
*
* If MonitoringInterval is set to a value other than 0, supply a
* MonitoringRoleArn value.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder monitoringRoleArn(String monitoringRoleArn);
/**
*
* The name of the IAM role to use when making API calls to the Directory Service.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param domainIAMRoleName
* The name of the IAM role to use when making API calls to the Directory Service.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainIAMRoleName(String domainIAMRoleName);
/**
*
* Specifies whether to remove the DB instance from the Active Directory domain.
*
*
* @param disableDomain
* Specifies whether to remove the DB instance from the Active Directory domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder disableDomain(Boolean disableDomain);
/**
*
* The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the
* existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Default: 1
*
*
* Valid Values: 0 - 15
*
*
* @param promotionTier
* The order of priority in which an Aurora Replica is promoted to the primary instance after a failure
* of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* 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);
/**
*
* Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
* database accounts. By default, mapping isn't enabled.
*
*
* This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is
* managed by the DB cluster.
*
*
* For more information about IAM database authentication, see IAM Database
* Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param enableIAMDatabaseAuthentication
* Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
* accounts to database accounts. By default, mapping isn't enabled.
*
* This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database
* accounts is managed by the DB cluster.
*
*
* For more information about IAM database authentication, see IAM
* Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication);
/**
*
* Specifies whether to enable Performance Insights for the DB instance.
*
*
* For more information, see Using Amazon Performance
* Insights in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param enablePerformanceInsights
* Specifies whether to enable Performance Insights for the DB instance.
*
* For more information, see Using Amazon
* Performance Insights in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enablePerformanceInsights(Boolean enablePerformanceInsights);
/**
*
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
*
*
* If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param performanceInsightsKMSKeyId
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
* KMS key.
*
*
* If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId);
/**
*
* The number of days to retain Performance Insights data.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* 7
*
*
* -
*
* month * 31, where month is a number of months from 1-23. Examples: 93 (3 months *
* 31), 341 (11 months * 31), 589 (19 months * 31)
*
*
* -
*
* 731
*
*
*
*
* Default: 7 days
*
*
* If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
*
*
* @param performanceInsightsRetentionPeriod
* The number of days to retain Performance Insights data.
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* Valid Values:
*
*
* -
*
* 7
*
*
* -
*
* month * 31, where month is a number of months from 1-23. Examples: 93 (3
* months * 31), 341 (11 months * 31), 589 (19 months * 31)
*
*
* -
*
* 731
*
*
*
*
* Default: 7 days
*
*
* If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an
* error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod);
/**
*
* The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
*
*
* A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance
* immediately. Therefore, the ApplyImmediately parameter has no effect.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param cloudwatchLogsExportConfiguration
* The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
*
* A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB
* instance immediately. Therefore, the ApplyImmediately parameter has no effect.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration);
/**
*
* The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
*
*
* A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance
* immediately. Therefore, the ApplyImmediately parameter has no effect.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
* This is a convenience method that creates an instance of the
* {@link CloudwatchLogsExportConfiguration.Builder} avoiding the need to create one manually via
* {@link CloudwatchLogsExportConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link CloudwatchLogsExportConfiguration.Builder#build()} is called
* immediately and its result is passed to
* {@link #cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration)}.
*
* @param cloudwatchLogsExportConfiguration
* a consumer that will call methods on {@link CloudwatchLogsExportConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration)
*/
default Builder cloudwatchLogsExportConfiguration(
Consumer cloudwatchLogsExportConfiguration) {
return cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration.builder()
.applyMutation(cloudwatchLogsExportConfiguration).build());
}
/**
*
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param processorFeatures
* The number of CPU cores and the number of threads per core for the DB instance class of the DB
* instance.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder processorFeatures(Collection processorFeatures);
/**
*
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param processorFeatures
* The number of CPU cores and the number of threads per core for the DB instance class of the DB
* instance.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder processorFeatures(ProcessorFeature... processorFeatures);
/**
*
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.ProcessorFeature.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.rds.model.ProcessorFeature#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.ProcessorFeature.Builder#build()} is called immediately and
* its result is passed to {@link #processorFeatures(List)}.
*
* @param processorFeatures
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rds.model.ProcessorFeature.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #processorFeatures(java.util.Collection)
*/
Builder processorFeatures(Consumer... processorFeatures);
/**
*
* Specifies whether the DB instance class of the DB instance uses its default processor features.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param useDefaultProcessorFeatures
* Specifies whether the DB instance class of the DB instance uses its default processor features.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures);
/**
*
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB
* Instance.
*
*
* This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for
* the DB cluster. For more information, see ModifyDBCluster. DB instances in a DB cluster can be
* deleted even when deletion protection is enabled for the DB cluster.
*
*
* @param deletionProtection
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when
* deletion protection is enabled. By default, deletion protection isn't enabled. For more information,
* see
* Deleting a DB Instance.
*
* This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion
* protection for the DB cluster. For more information, see ModifyDBCluster. DB instances in
* a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deletionProtection(Boolean deletionProtection);
/**
*
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
* instance.
*
*
* For more information about this setting, including limitations that apply to it, see
* Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param maxAllocatedStorage
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
* instance.
*
* For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User
* Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxAllocatedStorage(Integer maxAllocatedStorage);
/**
*
* Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
*
*
* By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not
* updated until the DB instance is restarted.
*
*
*
* Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
*
*
*
* If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB
* engine to rotate your SSL/TLS certificate:
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for RDS DB engines, see
* Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for Aurora DB engines, see
* Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
*
*
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param certificateRotationRestart
* Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
*
* By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is
* not updated until the DB instance is restarted.
*
*
*
* Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
*
*
*
* If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your
* DB engine to rotate your SSL/TLS certificate:
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for RDS DB engines, see
* Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
*
*
* -
*
* For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
*
*
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder certificateRotationRestart(Boolean certificateRotationRestart);
/**
*
* A value that sets the open mode of a replica database to either mounted or read-only.
*
*
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is
* cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to
* the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only
* workload. For more information, see Working with Oracle
* Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param replicaMode
* A value that sets the open mode of a replica database to either mounted or read-only.
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas
* is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit
* information to the mounted replica. Because it doesn't accept user connections, a mounted replica
* can't serve a read-only workload. For more information, see Working with
* Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @see ReplicaMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaMode
*/
Builder replicaMode(String replicaMode);
/**
*
* A value that sets the open mode of a replica database to either mounted or read-only.
*
*
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is
* cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to
* the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only
* workload. For more information, see Working with Oracle
* Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param replicaMode
* A value that sets the open mode of a replica database to either mounted or read-only.
*
* Currently, this parameter is only supported for Oracle DB instances.
*
*
*
* Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas
* is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit
* information to the mounted replica. Because it doesn't accept user connections, a mounted replica
* can't serve a read-only workload. For more information, see Working with
* Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*
*
* This setting doesn't apply to RDS Custom DB instances.
* @see ReplicaMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaMode
*/
Builder replicaMode(ReplicaMode replicaMode);
/**
*
* Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
*
*
* A CoIP provides local or external connectivity to resources in your Outpost subnets through your
* on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance
* from outside of its virtual private cloud (VPC) on your local network.
*
*
* For more information about RDS on Outposts, see Working with Amazon RDS on
* Amazon Web Services Outposts in the Amazon RDS User Guide.
*
*
* For more information about CoIPs, see Customer-owned IP
* addresses in the Amazon Web Services Outposts User Guide.
*
*
* @param enableCustomerOwnedIp
* Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
*
* A CoIP provides local or external connectivity to resources in your Outpost subnets through
* your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the
* DB instance from outside of its virtual private cloud (VPC) on your local network.
*
*
* For more information about RDS on Outposts, see Working with Amazon
* RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
*
*
* For more information about CoIPs, see Customer-owned
* IP addresses in the Amazon Web Services Outposts User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enableCustomerOwnedIp(Boolean enableCustomerOwnedIp);
/**
*
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
*
*
* This setting doesn't apply to RDS Custom DB instances.
*
*
* @param awsBackupRecoveryPointArn
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
*
* This setting doesn't apply to RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder awsBackupRecoveryPointArn(String awsBackupRecoveryPointArn);
/**
*
* The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring
* and instance recovery. If all paused, the instance pauses automation for the duration set by
* ResumeFullAutomationModeMinutes.
*
*
* @param automationMode
* The automation mode of the RDS Custom DB instance. If full, the DB instance automates
* monitoring and instance recovery. If all paused, the instance pauses automation for the
* duration set by ResumeFullAutomationModeMinutes.
* @see AutomationMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutomationMode
*/
Builder automationMode(String automationMode);
/**
*
* The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring
* and instance recovery. If all paused, the instance pauses automation for the duration set by
* ResumeFullAutomationModeMinutes.
*
*
* @param automationMode
* The automation mode of the RDS Custom DB instance. If full, the DB instance automates
* monitoring and instance recovery. If all paused, the instance pauses automation for the
* duration set by ResumeFullAutomationModeMinutes.
* @see AutomationMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutomationMode
*/
Builder automationMode(AutomationMode automationMode);
/**
*
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
*
*
* Default: 60
*
*
* Constraints:
*
*
* -
*
* Must be at least 60.
*
*
* -
*
* Must be no more than 1,440.
*
*
*
*
* @param resumeFullAutomationModeMinutes
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full
* automation.
*
* Default: 60
*
*
* Constraints:
*
*
* -
*
* Must be at least 60.
*
*
* -
*
* Must be no more than 1,440.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes);
/**
*
* The network type of the DB instance.
*
*
* The network type is determined by the DBSubnetGroup specified for the DB instance. A
* DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* Valid Values: IPV4 | DUAL
*
*
* @param networkType
* The network type of the DB instance.
*
* The network type is determined by the DBSubnetGroup specified for the DB instance. A
* DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
* DUAL).
*
*
* For more information, see
* Working with a DB instance in a VPC in the Amazon RDS User Guide.
*
*
* Valid Values: IPV4 | DUAL
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder networkType(String networkType);
/**
*
* The storage throughput value for the DB instance.
*
*
* This setting applies only to the gp3 storage type.
*
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
*
*
* @param storageThroughput
* The storage throughput value for the DB instance.
*
* This setting applies only to the gp3 storage type.
*
*
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder storageThroughput(Integer storageThroughput);
/**
*
* Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
*
*
* If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can
* turn on this management. In this case, you can't specify MasterUserPassword.
*
*
* If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you
* specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
* specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new
* password for the master user specified by MasterUserPassword.
*
*
* For more information, see Password management
* with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Can't manage the master user password with Amazon Web Services Secrets Manager if
* MasterUserPassword is specified.
*
*
*
*
* @param manageMasterUserPassword
* Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
*
* If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager,
* you can turn on this management. In this case, you can't specify MasterUserPassword.
*
*
* If the DB instance already manages the master user password with Amazon Web Services Secrets Manager,
* and you specify that the master user password is not managed with Amazon Web Services Secrets Manager,
* then you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and
* uses the new password for the master user specified by MasterUserPassword.
*
*
* For more information, see Password
* management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* Can't manage the master user password with Amazon Web Services Secrets Manager if
* MasterUserPassword is specified.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder manageMasterUserPassword(Boolean manageMasterUserPassword);
/**
*
* Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
* password.
*
*
* This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets
* Manager for the DB cluster. The secret value contains the updated password.
*
*
* For more information, see Password management
* with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* You must apply the change immediately when rotating the master user password.
*
*
*
*
* @param rotateMasterUserPassword
* Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master
* user password.
*
* This setting is valid only if the master user password is managed by RDS in Amazon Web Services
* Secrets Manager for the DB cluster. The secret value contains the updated password.
*
*
* For more information, see Password
* management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
*
*
* Constraints:
*
*
* -
*
* You must apply the change immediately when rotating the master user password.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rotateMasterUserPassword(Boolean rotateMasterUserPassword);
/**
*
* The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
* Amazon Web Services Secrets Manager.
*
*
* This setting is valid only if both of the following conditions are met:
*
*
* -
*
* The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
*
*
* If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't
* change the KMS key used to encrypt the secret.
*
*
* -
*
* You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web
* Services Secrets Manager.
*
*
* If you are turning on ManageMasterUserPassword and don't specify
* MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt
* the secret. If the secret is in a different Amazon Web Services account, then you can't use the
* aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
*
*
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
* To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
*
*
* 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 masterUserSecretKmsKeyId
* The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and
* managed in Amazon Web Services Secrets Manager.
*
* This setting is valid only if both of the following conditions are met:
*
*
* -
*
* The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
*
*
* If the DB instance already manages the master user password in Amazon Web Services Secrets Manager,
* you can't change the KMS key used to encrypt the secret.
*
*
* -
*
* You are turning on ManageMasterUserPassword to manage the master user password in Amazon
* Web Services Secrets Manager.
*
*
* If you are turning on ManageMasterUserPassword and don't specify
* MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to
* encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use
* the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed
* KMS key.
*
*
*
*
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
* KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias
* ARN.
*
*
* 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 masterUserSecretKmsKeyId(String masterUserSecretKmsKeyId);
/**
*
* The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to
* upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
*
*
* Note the following requirements:
*
*
* -
*
* Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.
*
*
* -
*
* Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
*
*
*
*
* Note the following limitations:
*
*
* -
*
* You can't convert a CDB to a non-CDB.
*
*
* -
*
* You can't convert a replica database.
*
*
* -
*
* You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
*
*
* -
*
* You can't convert the existing custom parameter or option group when it has options or parameters that are
* permanent or persistent. In this situation, the DB instance reverts to the default option and parameter
* group. To avoid reverting to the default, specify a new parameter group with
* --db-parameter-group-name and a new option group with --option-group-name.
*
*
*
*
* @param engine
* The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary
* to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
*
* Note the following requirements:
*
*
* -
*
* Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.
*
*
* -
*
* Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
*
*
*
*
* Note the following limitations:
*
*
* -
*
* You can't convert a CDB to a non-CDB.
*
*
* -
*
* You can't convert a replica database.
*
*
* -
*
* You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
*
*
* -
*
* You can't convert the existing custom parameter or option group when it has options or parameters that
* are permanent or persistent. In this situation, the DB instance reverts to the default option and
* parameter group. To avoid reverting to the default, specify a new parameter group with
* --db-parameter-group-name and a new option group with --option-group-name.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder engine(String engine);
/**
*
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
*
*
* @param dedicatedLogVolume
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dedicatedLogVolume(Boolean dedicatedLogVolume);
/**
*
* Specifies whether the to convert your DB instance from the single-tenant configuration to the multi-tenant
* configuration. This parameter is supported only for RDS for Oracle CDB instances.
*
*
* During the conversion, RDS creates an initial tenant database and associates the DB name, master user name,
* character set, and national character set metadata with this database. The tags associated with the instance
* also propagate to the initial tenant database. You can add more tenant databases to your DB instance by using
* the CreateTenantDatabase operation.
*
*
*
* The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later convert
* back to the single-tenant configuration. When you specify this parameter, you must also specify
* ApplyImmediately.
*
*
*
* @param multiTenant
* Specifies whether the to convert your DB instance from the single-tenant configuration to the
* multi-tenant configuration. This parameter is supported only for RDS for Oracle CDB instances.
*
* During the conversion, RDS creates an initial tenant database and associates the DB name, master user
* name, character set, and national character set metadata with this database. The tags associated with
* the instance also propagate to the initial tenant database. You can add more tenant databases to your
* DB instance by using the CreateTenantDatabase operation.
*
*
*
* The conversion to the multi-tenant configuration is permanent and irreversible, so you can't later
* convert back to the single-tenant configuration. When you specify this parameter, you must also
* specify ApplyImmediately.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder multiTenant(Boolean multiTenant);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbInstanceIdentifier;
private Integer allocatedStorage;
private String dbInstanceClass;
private String dbSubnetGroupName;
private List dbSecurityGroups = DefaultSdkAutoConstructList.getInstance();
private List vpcSecurityGroupIds = DefaultSdkAutoConstructList.getInstance();
private Boolean applyImmediately;
private String masterUserPassword;
private String dbParameterGroupName;
private Integer backupRetentionPeriod;
private String preferredBackupWindow;
private String preferredMaintenanceWindow;
private Boolean multiAZ;
private String engineVersion;
private Boolean allowMajorVersionUpgrade;
private Boolean autoMinorVersionUpgrade;
private String licenseModel;
private Integer iops;
private String optionGroupName;
private String newDBInstanceIdentifier;
private String storageType;
private String tdeCredentialArn;
private String tdeCredentialPassword;
private String caCertificateIdentifier;
private String domain;
private String domainFqdn;
private String domainOu;
private String domainAuthSecretArn;
private List domainDnsIps = DefaultSdkAutoConstructList.getInstance();
private Boolean copyTagsToSnapshot;
private Integer monitoringInterval;
private Integer dbPortNumber;
private Boolean publiclyAccessible;
private String monitoringRoleArn;
private String domainIAMRoleName;
private Boolean disableDomain;
private Integer promotionTier;
private Boolean enableIAMDatabaseAuthentication;
private Boolean enablePerformanceInsights;
private String performanceInsightsKMSKeyId;
private Integer performanceInsightsRetentionPeriod;
private CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration;
private List processorFeatures = DefaultSdkAutoConstructList.getInstance();
private Boolean useDefaultProcessorFeatures;
private Boolean deletionProtection;
private Integer maxAllocatedStorage;
private Boolean certificateRotationRestart;
private String replicaMode;
private Boolean enableCustomerOwnedIp;
private String awsBackupRecoveryPointArn;
private String automationMode;
private Integer resumeFullAutomationModeMinutes;
private String networkType;
private Integer storageThroughput;
private Boolean manageMasterUserPassword;
private Boolean rotateMasterUserPassword;
private String masterUserSecretKmsKeyId;
private String engine;
private Boolean dedicatedLogVolume;
private Boolean multiTenant;
private BuilderImpl() {
}
private BuilderImpl(ModifyDbInstanceRequest model) {
super(model);
dbInstanceIdentifier(model.dbInstanceIdentifier);
allocatedStorage(model.allocatedStorage);
dbInstanceClass(model.dbInstanceClass);
dbSubnetGroupName(model.dbSubnetGroupName);
dbSecurityGroups(model.dbSecurityGroups);
vpcSecurityGroupIds(model.vpcSecurityGroupIds);
applyImmediately(model.applyImmediately);
masterUserPassword(model.masterUserPassword);
dbParameterGroupName(model.dbParameterGroupName);
backupRetentionPeriod(model.backupRetentionPeriod);
preferredBackupWindow(model.preferredBackupWindow);
preferredMaintenanceWindow(model.preferredMaintenanceWindow);
multiAZ(model.multiAZ);
engineVersion(model.engineVersion);
allowMajorVersionUpgrade(model.allowMajorVersionUpgrade);
autoMinorVersionUpgrade(model.autoMinorVersionUpgrade);
licenseModel(model.licenseModel);
iops(model.iops);
optionGroupName(model.optionGroupName);
newDBInstanceIdentifier(model.newDBInstanceIdentifier);
storageType(model.storageType);
tdeCredentialArn(model.tdeCredentialArn);
tdeCredentialPassword(model.tdeCredentialPassword);
caCertificateIdentifier(model.caCertificateIdentifier);
domain(model.domain);
domainFqdn(model.domainFqdn);
domainOu(model.domainOu);
domainAuthSecretArn(model.domainAuthSecretArn);
domainDnsIps(model.domainDnsIps);
copyTagsToSnapshot(model.copyTagsToSnapshot);
monitoringInterval(model.monitoringInterval);
dbPortNumber(model.dbPortNumber);
publiclyAccessible(model.publiclyAccessible);
monitoringRoleArn(model.monitoringRoleArn);
domainIAMRoleName(model.domainIAMRoleName);
disableDomain(model.disableDomain);
promotionTier(model.promotionTier);
enableIAMDatabaseAuthentication(model.enableIAMDatabaseAuthentication);
enablePerformanceInsights(model.enablePerformanceInsights);
performanceInsightsKMSKeyId(model.performanceInsightsKMSKeyId);
performanceInsightsRetentionPeriod(model.performanceInsightsRetentionPeriod);
cloudwatchLogsExportConfiguration(model.cloudwatchLogsExportConfiguration);
processorFeatures(model.processorFeatures);
useDefaultProcessorFeatures(model.useDefaultProcessorFeatures);
deletionProtection(model.deletionProtection);
maxAllocatedStorage(model.maxAllocatedStorage);
certificateRotationRestart(model.certificateRotationRestart);
replicaMode(model.replicaMode);
enableCustomerOwnedIp(model.enableCustomerOwnedIp);
awsBackupRecoveryPointArn(model.awsBackupRecoveryPointArn);
automationMode(model.automationMode);
resumeFullAutomationModeMinutes(model.resumeFullAutomationModeMinutes);
networkType(model.networkType);
storageThroughput(model.storageThroughput);
manageMasterUserPassword(model.manageMasterUserPassword);
rotateMasterUserPassword(model.rotateMasterUserPassword);
masterUserSecretKmsKeyId(model.masterUserSecretKmsKeyId);
engine(model.engine);
dedicatedLogVolume(model.dedicatedLogVolume);
multiTenant(model.multiTenant);
}
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 Integer getAllocatedStorage() {
return allocatedStorage;
}
public final void setAllocatedStorage(Integer allocatedStorage) {
this.allocatedStorage = allocatedStorage;
}
@Override
public final Builder allocatedStorage(Integer allocatedStorage) {
this.allocatedStorage = allocatedStorage;
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 String getDbSubnetGroupName() {
return dbSubnetGroupName;
}
public final void setDbSubnetGroupName(String dbSubnetGroupName) {
this.dbSubnetGroupName = dbSubnetGroupName;
}
@Override
public final Builder dbSubnetGroupName(String dbSubnetGroupName) {
this.dbSubnetGroupName = dbSubnetGroupName;
return this;
}
public final Collection getDbSecurityGroups() {
if (dbSecurityGroups instanceof SdkAutoConstructList) {
return null;
}
return dbSecurityGroups;
}
public final void setDbSecurityGroups(Collection dbSecurityGroups) {
this.dbSecurityGroups = DBSecurityGroupNameListCopier.copy(dbSecurityGroups);
}
@Override
public final Builder dbSecurityGroups(Collection dbSecurityGroups) {
this.dbSecurityGroups = DBSecurityGroupNameListCopier.copy(dbSecurityGroups);
return this;
}
@Override
@SafeVarargs
public final Builder dbSecurityGroups(String... dbSecurityGroups) {
dbSecurityGroups(Arrays.asList(dbSecurityGroups));
return this;
}
public final Collection getVpcSecurityGroupIds() {
if (vpcSecurityGroupIds instanceof SdkAutoConstructList) {
return null;
}
return vpcSecurityGroupIds;
}
public final void setVpcSecurityGroupIds(Collection vpcSecurityGroupIds) {
this.vpcSecurityGroupIds = VpcSecurityGroupIdListCopier.copy(vpcSecurityGroupIds);
}
@Override
public final Builder vpcSecurityGroupIds(Collection vpcSecurityGroupIds) {
this.vpcSecurityGroupIds = VpcSecurityGroupIdListCopier.copy(vpcSecurityGroupIds);
return this;
}
@Override
@SafeVarargs
public final Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds) {
vpcSecurityGroupIds(Arrays.asList(vpcSecurityGroupIds));
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 getMasterUserPassword() {
return masterUserPassword;
}
public final void setMasterUserPassword(String masterUserPassword) {
this.masterUserPassword = masterUserPassword;
}
@Override
public final Builder masterUserPassword(String masterUserPassword) {
this.masterUserPassword = masterUserPassword;
return this;
}
public final String getDbParameterGroupName() {
return dbParameterGroupName;
}
public final void setDbParameterGroupName(String dbParameterGroupName) {
this.dbParameterGroupName = dbParameterGroupName;
}
@Override
public final Builder dbParameterGroupName(String dbParameterGroupName) {
this.dbParameterGroupName = dbParameterGroupName;
return this;
}
public final Integer getBackupRetentionPeriod() {
return backupRetentionPeriod;
}
public final void setBackupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
}
@Override
public final Builder backupRetentionPeriod(Integer backupRetentionPeriod) {
this.backupRetentionPeriod = backupRetentionPeriod;
return this;
}
public final String getPreferredBackupWindow() {
return preferredBackupWindow;
}
public final void setPreferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
}
@Override
public final Builder preferredBackupWindow(String preferredBackupWindow) {
this.preferredBackupWindow = preferredBackupWindow;
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 getMultiAZ() {
return multiAZ;
}
public final void setMultiAZ(Boolean multiAZ) {
this.multiAZ = multiAZ;
}
@Override
public final Builder multiAZ(Boolean multiAZ) {
this.multiAZ = multiAZ;
return this;
}
public final String getEngineVersion() {
return engineVersion;
}
public final void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
@Override
public final Builder engineVersion(String engineVersion) {
this.engineVersion = engineVersion;
return this;
}
public final Boolean getAllowMajorVersionUpgrade() {
return allowMajorVersionUpgrade;
}
public final void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
this.allowMajorVersionUpgrade = allowMajorVersionUpgrade;
}
@Override
public final Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
this.allowMajorVersionUpgrade = allowMajorVersionUpgrade;
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 getLicenseModel() {
return licenseModel;
}
public final void setLicenseModel(String licenseModel) {
this.licenseModel = licenseModel;
}
@Override
public final Builder licenseModel(String licenseModel) {
this.licenseModel = licenseModel;
return this;
}
public final Integer getIops() {
return iops;
}
public final void setIops(Integer iops) {
this.iops = iops;
}
@Override
public final Builder iops(Integer iops) {
this.iops = iops;
return this;
}
public final String getOptionGroupName() {
return optionGroupName;
}
public final void setOptionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
}
@Override
public final Builder optionGroupName(String optionGroupName) {
this.optionGroupName = optionGroupName;
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 getStorageType() {
return storageType;
}
public final void setStorageType(String storageType) {
this.storageType = storageType;
}
@Override
public final Builder storageType(String storageType) {
this.storageType = storageType;
return this;
}
public final String getTdeCredentialArn() {
return tdeCredentialArn;
}
public final void setTdeCredentialArn(String tdeCredentialArn) {
this.tdeCredentialArn = tdeCredentialArn;
}
@Override
public final Builder tdeCredentialArn(String tdeCredentialArn) {
this.tdeCredentialArn = tdeCredentialArn;
return this;
}
public final String getTdeCredentialPassword() {
return tdeCredentialPassword;
}
public final void setTdeCredentialPassword(String tdeCredentialPassword) {
this.tdeCredentialPassword = tdeCredentialPassword;
}
@Override
public final Builder tdeCredentialPassword(String tdeCredentialPassword) {
this.tdeCredentialPassword = tdeCredentialPassword;
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 String getDomain() {
return domain;
}
public final void setDomain(String domain) {
this.domain = domain;
}
@Override
public final Builder domain(String domain) {
this.domain = domain;
return this;
}
public final String getDomainFqdn() {
return domainFqdn;
}
public final void setDomainFqdn(String domainFqdn) {
this.domainFqdn = domainFqdn;
}
@Override
public final Builder domainFqdn(String domainFqdn) {
this.domainFqdn = domainFqdn;
return this;
}
public final String getDomainOu() {
return domainOu;
}
public final void setDomainOu(String domainOu) {
this.domainOu = domainOu;
}
@Override
public final Builder domainOu(String domainOu) {
this.domainOu = domainOu;
return this;
}
public final String getDomainAuthSecretArn() {
return domainAuthSecretArn;
}
public final void setDomainAuthSecretArn(String domainAuthSecretArn) {
this.domainAuthSecretArn = domainAuthSecretArn;
}
@Override
public final Builder domainAuthSecretArn(String domainAuthSecretArn) {
this.domainAuthSecretArn = domainAuthSecretArn;
return this;
}
public final Collection getDomainDnsIps() {
if (domainDnsIps instanceof SdkAutoConstructList) {
return null;
}
return domainDnsIps;
}
public final void setDomainDnsIps(Collection domainDnsIps) {
this.domainDnsIps = StringListCopier.copy(domainDnsIps);
}
@Override
public final Builder domainDnsIps(Collection domainDnsIps) {
this.domainDnsIps = StringListCopier.copy(domainDnsIps);
return this;
}
@Override
@SafeVarargs
public final Builder domainDnsIps(String... domainDnsIps) {
domainDnsIps(Arrays.asList(domainDnsIps));
return this;
}
public final Boolean getCopyTagsToSnapshot() {
return copyTagsToSnapshot;
}
public final void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot) {
this.copyTagsToSnapshot = copyTagsToSnapshot;
}
@Override
public final Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot) {
this.copyTagsToSnapshot = copyTagsToSnapshot;
return this;
}
public final Integer getMonitoringInterval() {
return monitoringInterval;
}
public final void setMonitoringInterval(Integer monitoringInterval) {
this.monitoringInterval = monitoringInterval;
}
@Override
public final Builder monitoringInterval(Integer monitoringInterval) {
this.monitoringInterval = monitoringInterval;
return this;
}
public final Integer getDbPortNumber() {
return dbPortNumber;
}
public final void setDbPortNumber(Integer dbPortNumber) {
this.dbPortNumber = dbPortNumber;
}
@Override
public final Builder dbPortNumber(Integer dbPortNumber) {
this.dbPortNumber = dbPortNumber;
return this;
}
public final Boolean getPubliclyAccessible() {
return publiclyAccessible;
}
public final void setPubliclyAccessible(Boolean publiclyAccessible) {
this.publiclyAccessible = publiclyAccessible;
}
@Override
public final Builder publiclyAccessible(Boolean publiclyAccessible) {
this.publiclyAccessible = publiclyAccessible;
return this;
}
public final String getMonitoringRoleArn() {
return monitoringRoleArn;
}
public final void setMonitoringRoleArn(String monitoringRoleArn) {
this.monitoringRoleArn = monitoringRoleArn;
}
@Override
public final Builder monitoringRoleArn(String monitoringRoleArn) {
this.monitoringRoleArn = monitoringRoleArn;
return this;
}
public final String getDomainIAMRoleName() {
return domainIAMRoleName;
}
public final void setDomainIAMRoleName(String domainIAMRoleName) {
this.domainIAMRoleName = domainIAMRoleName;
}
@Override
public final Builder domainIAMRoleName(String domainIAMRoleName) {
this.domainIAMRoleName = domainIAMRoleName;
return this;
}
public final Boolean getDisableDomain() {
return disableDomain;
}
public final void setDisableDomain(Boolean disableDomain) {
this.disableDomain = disableDomain;
}
@Override
public final Builder disableDomain(Boolean disableDomain) {
this.disableDomain = disableDomain;
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 getEnableIAMDatabaseAuthentication() {
return enableIAMDatabaseAuthentication;
}
public final void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) {
this.enableIAMDatabaseAuthentication = enableIAMDatabaseAuthentication;
}
@Override
public final Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication) {
this.enableIAMDatabaseAuthentication = enableIAMDatabaseAuthentication;
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;
}
public final Integer getPerformanceInsightsRetentionPeriod() {
return performanceInsightsRetentionPeriod;
}
public final void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod) {
this.performanceInsightsRetentionPeriod = performanceInsightsRetentionPeriod;
}
@Override
public final Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod) {
this.performanceInsightsRetentionPeriod = performanceInsightsRetentionPeriod;
return this;
}
public final CloudwatchLogsExportConfiguration.Builder getCloudwatchLogsExportConfiguration() {
return cloudwatchLogsExportConfiguration != null ? cloudwatchLogsExportConfiguration.toBuilder() : null;
}
public final void setCloudwatchLogsExportConfiguration(
CloudwatchLogsExportConfiguration.BuilderImpl cloudwatchLogsExportConfiguration) {
this.cloudwatchLogsExportConfiguration = cloudwatchLogsExportConfiguration != null ? cloudwatchLogsExportConfiguration
.build() : null;
}
@Override
public final Builder cloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration) {
this.cloudwatchLogsExportConfiguration = cloudwatchLogsExportConfiguration;
return this;
}
public final List getProcessorFeatures() {
List result = ProcessorFeatureListCopier.copyToBuilder(this.processorFeatures);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setProcessorFeatures(Collection processorFeatures) {
this.processorFeatures = ProcessorFeatureListCopier.copyFromBuilder(processorFeatures);
}
@Override
public final Builder processorFeatures(Collection processorFeatures) {
this.processorFeatures = ProcessorFeatureListCopier.copy(processorFeatures);
return this;
}
@Override
@SafeVarargs
public final Builder processorFeatures(ProcessorFeature... processorFeatures) {
processorFeatures(Arrays.asList(processorFeatures));
return this;
}
@Override
@SafeVarargs
public final Builder processorFeatures(Consumer... processorFeatures) {
processorFeatures(Stream.of(processorFeatures).map(c -> ProcessorFeature.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Boolean getUseDefaultProcessorFeatures() {
return useDefaultProcessorFeatures;
}
public final void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures) {
this.useDefaultProcessorFeatures = useDefaultProcessorFeatures;
}
@Override
public final Builder useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures) {
this.useDefaultProcessorFeatures = useDefaultProcessorFeatures;
return this;
}
public final Boolean getDeletionProtection() {
return deletionProtection;
}
public final void setDeletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
}
@Override
public final Builder deletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
return this;
}
public final Integer getMaxAllocatedStorage() {
return maxAllocatedStorage;
}
public final void setMaxAllocatedStorage(Integer maxAllocatedStorage) {
this.maxAllocatedStorage = maxAllocatedStorage;
}
@Override
public final Builder maxAllocatedStorage(Integer maxAllocatedStorage) {
this.maxAllocatedStorage = maxAllocatedStorage;
return this;
}
public final Boolean getCertificateRotationRestart() {
return certificateRotationRestart;
}
public final void setCertificateRotationRestart(Boolean certificateRotationRestart) {
this.certificateRotationRestart = certificateRotationRestart;
}
@Override
public final Builder certificateRotationRestart(Boolean certificateRotationRestart) {
this.certificateRotationRestart = certificateRotationRestart;
return this;
}
public final String getReplicaMode() {
return replicaMode;
}
public final void setReplicaMode(String replicaMode) {
this.replicaMode = replicaMode;
}
@Override
public final Builder replicaMode(String replicaMode) {
this.replicaMode = replicaMode;
return this;
}
@Override
public final Builder replicaMode(ReplicaMode replicaMode) {
this.replicaMode(replicaMode == null ? null : replicaMode.toString());
return this;
}
public final Boolean getEnableCustomerOwnedIp() {
return enableCustomerOwnedIp;
}
public final void setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp) {
this.enableCustomerOwnedIp = enableCustomerOwnedIp;
}
@Override
public final Builder enableCustomerOwnedIp(Boolean enableCustomerOwnedIp) {
this.enableCustomerOwnedIp = enableCustomerOwnedIp;
return this;
}
public final String getAwsBackupRecoveryPointArn() {
return awsBackupRecoveryPointArn;
}
public final void setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn) {
this.awsBackupRecoveryPointArn = awsBackupRecoveryPointArn;
}
@Override
public final Builder awsBackupRecoveryPointArn(String awsBackupRecoveryPointArn) {
this.awsBackupRecoveryPointArn = awsBackupRecoveryPointArn;
return this;
}
public final String getAutomationMode() {
return automationMode;
}
public final void setAutomationMode(String automationMode) {
this.automationMode = automationMode;
}
@Override
public final Builder automationMode(String automationMode) {
this.automationMode = automationMode;
return this;
}
@Override
public final Builder automationMode(AutomationMode automationMode) {
this.automationMode(automationMode == null ? null : automationMode.toString());
return this;
}
public final Integer getResumeFullAutomationModeMinutes() {
return resumeFullAutomationModeMinutes;
}
public final void setResumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes) {
this.resumeFullAutomationModeMinutes = resumeFullAutomationModeMinutes;
}
@Override
public final Builder resumeFullAutomationModeMinutes(Integer resumeFullAutomationModeMinutes) {
this.resumeFullAutomationModeMinutes = resumeFullAutomationModeMinutes;
return this;
}
public final String getNetworkType() {
return networkType;
}
public final void setNetworkType(String networkType) {
this.networkType = networkType;
}
@Override
public final Builder networkType(String networkType) {
this.networkType = networkType;
return this;
}
public final Integer getStorageThroughput() {
return storageThroughput;
}
public final void setStorageThroughput(Integer storageThroughput) {
this.storageThroughput = storageThroughput;
}
@Override
public final Builder storageThroughput(Integer storageThroughput) {
this.storageThroughput = storageThroughput;
return this;
}
public final Boolean getManageMasterUserPassword() {
return manageMasterUserPassword;
}
public final void setManageMasterUserPassword(Boolean manageMasterUserPassword) {
this.manageMasterUserPassword = manageMasterUserPassword;
}
@Override
public final Builder manageMasterUserPassword(Boolean manageMasterUserPassword) {
this.manageMasterUserPassword = manageMasterUserPassword;
return this;
}
public final Boolean getRotateMasterUserPassword() {
return rotateMasterUserPassword;
}
public final void setRotateMasterUserPassword(Boolean rotateMasterUserPassword) {
this.rotateMasterUserPassword = rotateMasterUserPassword;
}
@Override
public final Builder rotateMasterUserPassword(Boolean rotateMasterUserPassword) {
this.rotateMasterUserPassword = rotateMasterUserPassword;
return this;
}
public final String getMasterUserSecretKmsKeyId() {
return masterUserSecretKmsKeyId;
}
public final void setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId) {
this.masterUserSecretKmsKeyId = masterUserSecretKmsKeyId;
}
@Override
public final Builder masterUserSecretKmsKeyId(String masterUserSecretKmsKeyId) {
this.masterUserSecretKmsKeyId = masterUserSecretKmsKeyId;
return this;
}
public final String getEngine() {
return engine;
}
public final void setEngine(String engine) {
this.engine = engine;
}
@Override
public final Builder engine(String engine) {
this.engine = engine;
return this;
}
public final Boolean getDedicatedLogVolume() {
return dedicatedLogVolume;
}
public final void setDedicatedLogVolume(Boolean dedicatedLogVolume) {
this.dedicatedLogVolume = dedicatedLogVolume;
}
@Override
public final Builder dedicatedLogVolume(Boolean dedicatedLogVolume) {
this.dedicatedLogVolume = dedicatedLogVolume;
return this;
}
public final Boolean getMultiTenant() {
return multiTenant;
}
public final void setMultiTenant(Boolean multiTenant) {
this.multiTenant = multiTenant;
}
@Override
public final Builder multiTenant(Boolean multiTenant) {
this.multiTenant = multiTenant;
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;
}
}
}