DBInstance.Builder (AWS SDK for Java

All Superinterfaces:

CopyableBuilder<DBInstance.Builder,DBInstance>, SdkBuilder<DBInstance.Builder,DBInstance>

Enclosing class:

DBInstance
```
public static interface DBInstance.Builder
extends CopyableBuilder<DBInstance.Builder,DBInstance>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DBInstance.Builder`	`allocatedStorage(Integer allocatedStorage)` Specifies the allocated storage size specified in gigabytes.
`DBInstance.Builder`	`autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Indicates that minor version patches are applied automatically.
`DBInstance.Builder`	`availabilityZone(String availabilityZone)` Specifies the name of the Availability Zone the DB instance is located in.
`DBInstance.Builder`	`backupRetentionPeriod(Integer backupRetentionPeriod)` Specifies the number of days for which automatic DB snapshots are retained.
`DBInstance.Builder`	`caCertificateIdentifier(String caCertificateIdentifier)` The identifier of the CA certificate for this DB instance.
`DBInstance.Builder`	`characterSetName(String characterSetName)` If present, specifies the name of the character set that this instance is associated with.
`DBInstance.Builder`	`copyTagsToSnapshot(Boolean copyTagsToSnapshot)` Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
`DBInstance.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)` If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
`DBInstance.Builder`	`dbInstanceArn(String dbInstanceArn)` The Amazon Resource Name (ARN) for the DB instance.
`DBInstance.Builder`	`dbInstanceClass(String dbInstanceClass)` Contains the name of the compute and memory capacity class of the DB instance.
`DBInstance.Builder`	`dbInstanceIdentifier(String dbInstanceIdentifier)` Contains a user-supplied database identifier.
`DBInstance.Builder`	`dbInstancePort(Integer dbInstancePort)` Specifies the port that the DB instance listens on.
`DBInstance.Builder`	`dbInstanceStatus(String dbInstanceStatus)` Specifies the current state of this database.
`DBInstance.Builder`	`dbiResourceId(String dbiResourceId)` The AWS Region-unique, immutable identifier for the DB instance.
`DBInstance.Builder`	`dbName(String dbName)` The meaning of this parameter differs according to the database engine you use.
`DBInstance.Builder`	`dbParameterGroups(Collection<DBParameterGroupStatus> dbParameterGroups)` Provides the list of DB parameter groups applied to this DB instance.
`DBInstance.Builder`	`dbParameterGroups(Consumer<DBParameterGroupStatus.Builder>... dbParameterGroups)` Provides the list of DB parameter groups applied to this DB instance.
`DBInstance.Builder`	`dbParameterGroups(DBParameterGroupStatus... dbParameterGroups)` Provides the list of DB parameter groups applied to this DB instance.
`DBInstance.Builder`	`dbSecurityGroups(Collection<DBSecurityGroupMembership> dbSecurityGroups)` Provides List of DB security group elements containing only `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.
`DBInstance.Builder`	`dbSecurityGroups(Consumer<DBSecurityGroupMembership.Builder>... dbSecurityGroups)` Provides List of DB security group elements containing only `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.
`DBInstance.Builder`	`dbSecurityGroups(DBSecurityGroupMembership... dbSecurityGroups)` Provides List of DB security group elements containing only `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.
`default DBInstance.Builder`	`dbSubnetGroup(Consumer<DBSubnetGroup.Builder> dbSubnetGroup)` Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
`DBInstance.Builder`	`dbSubnetGroup(DBSubnetGroup dbSubnetGroup)` Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
`DBInstance.Builder`	`domainMemberships(Collection<DomainMembership> domainMemberships)` The Active Directory Domain membership records associated with the DB instance.
`DBInstance.Builder`	`domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)` The Active Directory Domain membership records associated with the DB instance.
`DBInstance.Builder`	`domainMemberships(DomainMembership... domainMemberships)` The Active Directory Domain membership records associated with the DB instance.
`default DBInstance.Builder`	`endpoint(Consumer<Endpoint.Builder> endpoint)` Specifies the connection endpoint.
`DBInstance.Builder`	`endpoint(Endpoint endpoint)` Specifies the connection endpoint.
`DBInstance.Builder`	`engine(String engine)` Provides the name of the database engine to be used for this DB instance.
`DBInstance.Builder`	`engineVersion(String engineVersion)` Indicates the database engine version.
`DBInstance.Builder`	`enhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)` The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
`DBInstance.Builder`	`iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)` True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
`DBInstance.Builder`	`instanceCreateTime(Instant instanceCreateTime)` Provides the date and time the DB instance was created.
`DBInstance.Builder`	`iops(Integer iops)` Specifies the Provisioned IOPS (I/O operations per second) value.
`DBInstance.Builder`	`kmsKeyId(String kmsKeyId)` If `StorageEncrypted` is true, the AWS KMS key identifier for the encrypted DB instance.
`DBInstance.Builder`	`latestRestorableTime(Instant latestRestorableTime)` Specifies the latest time to which a database can be restored with point-in-time restore.
`DBInstance.Builder`	`licenseModel(String licenseModel)` License model information for this DB instance.
`DBInstance.Builder`	`masterUsername(String masterUsername)` Contains the master username for the DB instance.
`DBInstance.Builder`	`monitoringInterval(Integer monitoringInterval)` The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
`DBInstance.Builder`	`monitoringRoleArn(String monitoringRoleArn)` The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
`DBInstance.Builder`	`multiAZ(Boolean multiAZ)` Specifies if the DB instance is a Multi-AZ deployment.
`DBInstance.Builder`	`optionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)` Provides the list of option group memberships for this DB instance.
`DBInstance.Builder`	`optionGroupMemberships(Consumer<OptionGroupMembership.Builder>... optionGroupMemberships)` Provides the list of option group memberships for this DB instance.
`DBInstance.Builder`	`optionGroupMemberships(OptionGroupMembership... optionGroupMemberships)` Provides the list of option group memberships for this DB instance.
`default DBInstance.Builder`	`pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)` Specifies that changes to the DB instance are pending.
`DBInstance.Builder`	`pendingModifiedValues(PendingModifiedValues pendingModifiedValues)` Specifies that changes to the DB instance are pending.
`DBInstance.Builder`	`performanceInsightsEnabled(Boolean performanceInsightsEnabled)` True if Performance Insights is enabled for the DB instance, and otherwise false.
`DBInstance.Builder`	`performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)` The AWS KMS key identifier for encryption of Performance Insights data.
`DBInstance.Builder`	`preferredBackupWindow(String preferredBackupWindow)` Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
`DBInstance.Builder`	`preferredMaintenanceWindow(String preferredMaintenanceWindow)` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`DBInstance.Builder`	`promotionTier(Integer promotionTier)` A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
`DBInstance.Builder`	`publiclyAccessible(Boolean publiclyAccessible)` Specifies the accessibility options for the DB instance.
`DBInstance.Builder`	`readReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)` Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
`DBInstance.Builder`	`readReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)` Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
`DBInstance.Builder`	`readReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)` Contains one or more identifiers of the Read Replicas associated with this DB instance.
`DBInstance.Builder`	`readReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)` Contains one or more identifiers of the Read Replicas associated with this DB instance.
`DBInstance.Builder`	`readReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)` Contains the identifier of the source DB instance if this DB instance is a Read Replica.
`DBInstance.Builder`	`secondaryAvailabilityZone(String secondaryAvailabilityZone)` If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
`DBInstance.Builder`	`statusInfos(Collection<DBInstanceStatusInfo> statusInfos)` The status of a Read Replica.
`DBInstance.Builder`	`statusInfos(Consumer<DBInstanceStatusInfo.Builder>... statusInfos)` The status of a Read Replica.
`DBInstance.Builder`	`statusInfos(DBInstanceStatusInfo... statusInfos)` The status of a Read Replica.
`DBInstance.Builder`	`storageEncrypted(Boolean storageEncrypted)` Specifies whether the DB instance is encrypted.
`DBInstance.Builder`	`storageType(String storageType)` Specifies the storage type associated with DB instance.
`DBInstance.Builder`	`tdeCredentialArn(String tdeCredentialArn)` The ARN from the key store with which the instance is associated for TDE encryption.
`DBInstance.Builder`	`timezone(String timezone)` The time zone of the DB instance.
`DBInstance.Builder`	`vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)` Provides a list of VPC security group elements that the DB instance belongs to.
`DBInstance.Builder`	`vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)` Provides a list of VPC security group elements that the DB instance belongs to.
`DBInstance.Builder`	`vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)` Provides a list of VPC security group elements that the DB instance belongs to.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - dbInstanceIdentifier
```
DBInstance.Builder dbInstanceIdentifier(String dbInstanceIdentifier)
```
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    
    Parameters:
    
    dbInstanceIdentifier - Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbInstanceClass
```
DBInstance.Builder dbInstanceClass(String dbInstanceClass)
```
    Contains the name of the compute and memory capacity class of the DB instance.
    
    Parameters:
    
    dbInstanceClass - Contains the name of the compute and memory capacity class of the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engine
```
DBInstance.Builder engine(String engine)
```
    Provides the name of the database engine to be used for this DB instance.
    
    Parameters:
    
    engine - Provides the name of the database engine to be used for this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbInstanceStatus
```
DBInstance.Builder dbInstanceStatus(String dbInstanceStatus)
```
    Specifies the current state of this database.
    
    Parameters:
    
    dbInstanceStatus - Specifies the current state of this database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - masterUsername
```
DBInstance.Builder masterUsername(String masterUsername)
```
    Contains the master username for the DB instance.
    
    Parameters:
    
    masterUsername - Contains the master username for the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbName
```
DBInstance.Builder dbName(String dbName)
```
    The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL
    
    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
    
    Type: String
    
    Oracle
    
    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
    
    Parameters:
    
    dbName - The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL
    
    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
    
    Type: String
    
    Oracle
    
    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - endpoint
```
DBInstance.Builder endpoint(Endpoint endpoint)
```
    Specifies the connection endpoint.
    
    Parameters:
    
    endpoint - Specifies the connection endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - endpoint
```
default DBInstance.Builder endpoint(Consumer<Endpoint.Builder> endpoint)
```
    Specifies the connection endpoint.
    This is a convenience that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpoint(Endpoint).
    
    Parameters:
    
    endpoint - a consumer that will call methods on Endpoint.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    endpoint(Endpoint)
  - allocatedStorage
```
DBInstance.Builder allocatedStorage(Integer allocatedStorage)
```
    Specifies the allocated storage size specified in gigabytes.
    
    Parameters:
    
    allocatedStorage - Specifies the allocated storage size specified in gigabytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceCreateTime
```
DBInstance.Builder instanceCreateTime(Instant instanceCreateTime)
```
    Provides the date and time the DB instance was created.
    
    Parameters:
    
    instanceCreateTime - Provides the date and time the DB instance was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - preferredBackupWindow
```
DBInstance.Builder preferredBackupWindow(String preferredBackupWindow)
```
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    
    Parameters:
    
    preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backupRetentionPeriod
```
DBInstance.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
```
    Specifies the number of days for which automatic DB snapshots are retained.
    
    Parameters:
    
    backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSecurityGroups
```
DBInstance.Builder dbSecurityGroups(Collection<DBSecurityGroupMembership> dbSecurityGroups)
```
    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
    
    Parameters:
    
    dbSecurityGroups - Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSecurityGroups
```
DBInstance.Builder dbSecurityGroups(DBSecurityGroupMembership... dbSecurityGroups)
```
    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
    
    Parameters:
    
    dbSecurityGroups - Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSecurityGroups
```
DBInstance.Builder dbSecurityGroups(Consumer<DBSecurityGroupMembership.Builder>... dbSecurityGroups)
```
    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #dbSecurityGroups(List).
    
    Parameters:
    
    dbSecurityGroups - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #dbSecurityGroups(List)
  - vpcSecurityGroups
```
DBInstance.Builder vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
```
    Provides a list of VPC security group elements that the DB instance belongs to.
    
    Parameters:
    
    vpcSecurityGroups - Provides a list of VPC security group elements that the DB instance belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcSecurityGroups
```
DBInstance.Builder vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
```
    Provides a list of VPC security group elements that the DB instance belongs to.
    
    Parameters:
    
    vpcSecurityGroups - Provides a list of VPC security group elements that the DB instance belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcSecurityGroups
```
DBInstance.Builder vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
```
    Provides a list of VPC security group elements that the DB instance belongs to.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #vpcSecurityGroups(List).
    
    Parameters:
    
    vpcSecurityGroups - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #vpcSecurityGroups(List)
  - dbParameterGroups
```
DBInstance.Builder dbParameterGroups(Collection<DBParameterGroupStatus> dbParameterGroups)
```
    Provides the list of DB parameter groups applied to this DB instance.
    
    Parameters:
    
    dbParameterGroups - Provides the list of DB parameter groups applied to this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbParameterGroups
```
DBInstance.Builder dbParameterGroups(DBParameterGroupStatus... dbParameterGroups)
```
    Provides the list of DB parameter groups applied to this DB instance.
    
    Parameters:
    
    dbParameterGroups - Provides the list of DB parameter groups applied to this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbParameterGroups
```
DBInstance.Builder dbParameterGroups(Consumer<DBParameterGroupStatus.Builder>... dbParameterGroups)
```
    Provides the list of DB parameter groups applied to this DB instance.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #dbParameterGroups(List).
    
    Parameters:
    
    dbParameterGroups - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #dbParameterGroups(List)
  - availabilityZone
```
DBInstance.Builder availabilityZone(String availabilityZone)
```
    Specifies the name of the Availability Zone the DB instance is located in.
    
    Parameters:
    
    availabilityZone - Specifies the name of the Availability Zone the DB instance is located in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSubnetGroup
```
DBInstance.Builder dbSubnetGroup(DBSubnetGroup dbSubnetGroup)
```
    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
    
    Parameters:
    
    dbSubnetGroup - Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSubnetGroup
```
default DBInstance.Builder dbSubnetGroup(Consumer<DBSubnetGroup.Builder> dbSubnetGroup)
```
    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
    This is a convenience that creates an instance of the DBSubnetGroup.Builder avoiding the need to create one manually via DBSubnetGroup.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dbSubnetGroup(DBSubnetGroup).
    
    Parameters:
    
    dbSubnetGroup - a consumer that will call methods on DBSubnetGroup.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    dbSubnetGroup(DBSubnetGroup)
  - preferredMaintenanceWindow
```
DBInstance.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Parameters:
    
    preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - pendingModifiedValues
```
DBInstance.Builder pendingModifiedValues(PendingModifiedValues pendingModifiedValues)
```
    Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
    
    Parameters:
    
    pendingModifiedValues - Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - pendingModifiedValues
```
default DBInstance.Builder pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)
```
    Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
    This is a convenience that creates an instance of the PendingModifiedValues.Builder avoiding the need to create one manually via PendingModifiedValues.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingModifiedValues(PendingModifiedValues).
    
    Parameters:
    
    pendingModifiedValues - a consumer that will call methods on PendingModifiedValues.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    pendingModifiedValues(PendingModifiedValues)
  - latestRestorableTime
```
DBInstance.Builder latestRestorableTime(Instant latestRestorableTime)
```
    Specifies the latest time to which a database can be restored with point-in-time restore.
    
    Parameters:
    
    latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - multiAZ
```
DBInstance.Builder multiAZ(Boolean multiAZ)
```
    Specifies if the DB instance is a Multi-AZ deployment.
    
    Parameters:
    
    multiAZ - Specifies if the DB instance is a Multi-AZ deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engineVersion
```
DBInstance.Builder engineVersion(String engineVersion)
```
    Indicates the database engine version.
    
    Parameters:
    
    engineVersion - Indicates the database engine version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - autoMinorVersionUpgrade
```
DBInstance.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
```
    Indicates that minor version patches are applied automatically.
    
    Parameters:
    
    autoMinorVersionUpgrade - Indicates that minor version patches are applied automatically.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - readReplicaSourceDBInstanceIdentifier
```
DBInstance.Builder readReplicaSourceDBInstanceIdentifier(String readReplicaSourceDBInstanceIdentifier)
```
    Contains the identifier of the source DB instance if this DB instance is a Read Replica.
    
    Parameters:
    
    readReplicaSourceDBInstanceIdentifier - Contains the identifier of the source DB instance if this DB instance is a Read Replica.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - readReplicaDBInstanceIdentifiers
```
DBInstance.Builder readReplicaDBInstanceIdentifiers(Collection<String> readReplicaDBInstanceIdentifiers)
```
    Contains one or more identifiers of the Read Replicas associated with this DB instance.
    
    Parameters:
    
    readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - readReplicaDBInstanceIdentifiers
```
DBInstance.Builder readReplicaDBInstanceIdentifiers(String... readReplicaDBInstanceIdentifiers)
```
    Contains one or more identifiers of the Read Replicas associated with this DB instance.
    
    Parameters:
    
    readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the Read Replicas associated with this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - readReplicaDBClusterIdentifiers
```
DBInstance.Builder readReplicaDBClusterIdentifiers(Collection<String> readReplicaDBClusterIdentifiers)
```
    Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
    
    Parameters:
    
    readReplicaDBClusterIdentifiers - Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - readReplicaDBClusterIdentifiers
```
DBInstance.Builder readReplicaDBClusterIdentifiers(String... readReplicaDBClusterIdentifiers)
```
    Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
    
    Parameters:
    
    readReplicaDBClusterIdentifiers - Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - licenseModel
```
DBInstance.Builder licenseModel(String licenseModel)
```
    License model information for this DB instance.
    
    Parameters:
    
    licenseModel - License model information for this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - iops
```
DBInstance.Builder iops(Integer iops)
```
    Specifies the Provisioned IOPS (I/O operations per second) value.
    
    Parameters:
    
    iops - Specifies the Provisioned IOPS (I/O operations per second) value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - optionGroupMemberships
```
DBInstance.Builder optionGroupMemberships(Collection<OptionGroupMembership> optionGroupMemberships)
```
    Provides the list of option group memberships for this DB instance.
    
    Parameters:
    
    optionGroupMemberships - Provides the list of option group memberships for this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - optionGroupMemberships
```
DBInstance.Builder optionGroupMemberships(OptionGroupMembership... optionGroupMemberships)
```
    Provides the list of option group memberships for this DB instance.
    
    Parameters:
    
    optionGroupMemberships - Provides the list of option group memberships for this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - optionGroupMemberships
```
DBInstance.Builder optionGroupMemberships(Consumer<OptionGroupMembership.Builder>... optionGroupMemberships)
```
    Provides the list of option group memberships for this DB instance.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #optionGroupMemberships(List).
    
    Parameters:
    
    optionGroupMemberships - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #optionGroupMemberships(List)
  - characterSetName
```
DBInstance.Builder characterSetName(String characterSetName)
```
    If present, specifies the name of the character set that this instance is associated with.
    
    Parameters:
    
    characterSetName - If present, specifies the name of the character set that this instance is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - secondaryAvailabilityZone
```
DBInstance.Builder secondaryAvailabilityZone(String secondaryAvailabilityZone)
```
    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
    
    Parameters:
    
    secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - publiclyAccessible
```
DBInstance.Builder publiclyAccessible(Boolean publiclyAccessible)
```
    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC:true
    - VPC:false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
    Parameters:
    publiclyAccessible - Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    
    Default VPC:true
    
    VPC:false
    
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - statusInfos
```
DBInstance.Builder statusInfos(Collection<DBInstanceStatusInfo> statusInfos)
```
    The status of a Read Replica. If the instance is not a Read Replica, this is blank.
    
    Parameters:
    
    statusInfos - The status of a Read Replica. If the instance is not a Read Replica, this is blank.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - statusInfos
```
DBInstance.Builder statusInfos(DBInstanceStatusInfo... statusInfos)
```
    The status of a Read Replica. If the instance is not a Read Replica, this is blank.
    
    Parameters:
    
    statusInfos - The status of a Read Replica. If the instance is not a Read Replica, this is blank.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - statusInfos
```
DBInstance.Builder statusInfos(Consumer<DBInstanceStatusInfo.Builder>... statusInfos)
```
    The status of a Read Replica. If the instance is not a Read Replica, this is blank.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #statusInfos(List).
    
    Parameters:
    
    statusInfos - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #statusInfos(List)
  - storageType
```
DBInstance.Builder storageType(String storageType)
```
    Specifies the storage type associated with DB instance.
    
    Parameters:
    
    storageType - Specifies the storage type associated with DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tdeCredentialArn
```
DBInstance.Builder tdeCredentialArn(String tdeCredentialArn)
```
    The ARN from the key store with which the instance is associated for TDE encryption.
    
    Parameters:
    
    tdeCredentialArn - The ARN from the key store with which the instance is associated for TDE encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbInstancePort
```
DBInstance.Builder dbInstancePort(Integer dbInstancePort)
```
    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
    
    Parameters:
    
    dbInstancePort - Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbClusterIdentifier
```
DBInstance.Builder dbClusterIdentifier(String dbClusterIdentifier)
```
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    
    Parameters:
    
    dbClusterIdentifier - If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - storageEncrypted
```
DBInstance.Builder storageEncrypted(Boolean storageEncrypted)
```
    Specifies whether the DB instance is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether the DB instance is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - kmsKeyId
```
DBInstance.Builder kmsKeyId(String kmsKeyId)
```
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbiResourceId
```
DBInstance.Builder dbiResourceId(String dbiResourceId)
```
    The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
    
    Parameters:
    
    dbiResourceId - The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - caCertificateIdentifier
```
DBInstance.Builder caCertificateIdentifier(String caCertificateIdentifier)
```
    The identifier of the CA certificate for this DB instance.
    
    Parameters:
    
    caCertificateIdentifier - The identifier of the CA certificate for this DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domainMemberships
```
DBInstance.Builder domainMemberships(Collection<DomainMembership> domainMemberships)
```
    The Active Directory Domain membership records associated with the DB instance.
    
    Parameters:
    
    domainMemberships - The Active Directory Domain membership records associated with the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domainMemberships
```
DBInstance.Builder domainMemberships(DomainMembership... domainMemberships)
```
    The Active Directory Domain membership records associated with the DB instance.
    
    Parameters:
    
    domainMemberships - The Active Directory Domain membership records associated with the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domainMemberships
```
DBInstance.Builder domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)
```
    The Active Directory Domain membership records associated with the DB instance.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #domainMemberships(List).
    
    Parameters:
    
    domainMemberships - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #domainMemberships(List)
  - copyTagsToSnapshot
```
DBInstance.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
```
    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
    
    Parameters:
    
    copyTagsToSnapshot - Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - monitoringInterval
```
DBInstance.Builder monitoringInterval(Integer monitoringInterval)
```
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
    
    Parameters:
    
    monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enhancedMonitoringResourceArn
```
DBInstance.Builder enhancedMonitoringResourceArn(String enhancedMonitoringResourceArn)
```
    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
    
    Parameters:
    
    enhancedMonitoringResourceArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - monitoringRoleArn
```
DBInstance.Builder monitoringRoleArn(String monitoringRoleArn)
```
    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
    
    Parameters:
    
    monitoringRoleArn - The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - promotionTier
```
DBInstance.Builder promotionTier(Integer promotionTier)
```
    A value that specifies the order 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.
    
    Parameters:
    
    promotionTier - A value that specifies the order 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbInstanceArn
```
DBInstance.Builder dbInstanceArn(String dbInstanceArn)
```
    The Amazon Resource Name (ARN) for the DB instance.
    
    Parameters:
    
    dbInstanceArn - The Amazon Resource Name (ARN) for the DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timezone
```
DBInstance.Builder timezone(String timezone)
```
    The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
    
    Parameters:
    
    timezone - The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - iamDatabaseAuthenticationEnabled
```
DBInstance.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
```
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    IAM database authentication can be enabled for the following database engines
    - For MySQL 5.6, minor version 5.6.34 or higher
    - For MySQL 5.7, minor version 5.7.16 or higher
    - Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
    Parameters:
    iamDatabaseAuthenticationEnabled - True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    IAM database authentication can be enabled for the following database engines
    
    For MySQL 5.6, minor version 5.6.34 or higher
    
    For MySQL 5.7, minor version 5.7.16 or higher
    
    Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - performanceInsightsEnabled
```
DBInstance.Builder performanceInsightsEnabled(Boolean performanceInsightsEnabled)
```
    True if Performance Insights is enabled for the DB instance, and otherwise false.
    
    Parameters:
    
    performanceInsightsEnabled - True if Performance Insights is enabled for the DB instance, and otherwise false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - performanceInsightsKMSKeyId
```
DBInstance.Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
```
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
    
    Parameters:
    
    performanceInsightsKMSKeyId - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface DBInstance.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

dbInstanceIdentifier

dbInstanceClass

engine

dbInstanceStatus

masterUsername

dbName

endpoint

endpoint

allocatedStorage

instanceCreateTime

preferredBackupWindow

backupRetentionPeriod

dbSecurityGroups

dbSecurityGroups

dbSecurityGroups

vpcSecurityGroups

vpcSecurityGroups

vpcSecurityGroups

dbParameterGroups

dbParameterGroups

dbParameterGroups

availabilityZone

dbSubnetGroup

dbSubnetGroup

preferredMaintenanceWindow

pendingModifiedValues

pendingModifiedValues

latestRestorableTime

multiAZ

engineVersion

autoMinorVersionUpgrade

readReplicaSourceDBInstanceIdentifier

readReplicaDBInstanceIdentifiers

readReplicaDBInstanceIdentifiers

readReplicaDBClusterIdentifiers

readReplicaDBClusterIdentifiers

licenseModel

iops

optionGroupMemberships

optionGroupMemberships

optionGroupMemberships

characterSetName

secondaryAvailabilityZone

publiclyAccessible

statusInfos

statusInfos

statusInfos

storageType

tdeCredentialArn

dbInstancePort

dbClusterIdentifier

storageEncrypted

kmsKeyId

dbiResourceId

caCertificateIdentifier

domainMemberships

domainMemberships

domainMemberships

copyTagsToSnapshot

monitoringInterval

enhancedMonitoringResourceArn

monitoringRoleArn

promotionTier

dbInstanceArn

timezone

iamDatabaseAuthenticationEnabled

performanceInsightsEnabled

performanceInsightsKMSKeyId