DBInstance.Builder (AWS Java SDK :: Services

All Superinterfaces:

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

Enclosing class:

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DBInstance.Builder`	`autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Does not apply.
`DBInstance.Builder`	`availabilityZone(String availabilityZone)` Specifies the name of the Availability Zone that the instance is located in.
`DBInstance.Builder`	`backupRetentionPeriod(Integer backupRetentionPeriod)` Specifies the number of days for which automatic snapshots are retained.
`DBInstance.Builder`	`caCertificateIdentifier(String caCertificateIdentifier)` The identifier of the CA certificate for this DB instance.
`DBInstance.Builder`	`copyTagsToSnapshot(Boolean copyTagsToSnapshot)` A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
`DBInstance.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)` Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
`DBInstance.Builder`	`dbInstanceArn(String dbInstanceArn)` The Amazon Resource Name (ARN) for the instance.
`DBInstance.Builder`	`dbInstanceClass(String dbInstanceClass)` Contains the name of the compute and memory capacity class of the instance.
`DBInstance.Builder`	`dbInstanceIdentifier(String dbInstanceIdentifier)` Contains a user-provided database identifier.
`DBInstance.Builder`	`dbInstanceStatus(String dbInstanceStatus)` Specifies the current state of this database.
`DBInstance.Builder`	`dbiResourceId(String dbiResourceId)` The Amazon Web Services Region-unique, immutable identifier for the instance.
`default DBInstance.Builder`	`dbSubnetGroup(Consumer<DBSubnetGroup.Builder> dbSubnetGroup)` Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
`DBInstance.Builder`	`dbSubnetGroup(DBSubnetGroup dbSubnetGroup)` Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
`DBInstance.Builder`	`enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)` A list of log types that this instance is configured to export to CloudWatch Logs.
`DBInstance.Builder`	`enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)` A list of log types that this instance is configured to export to CloudWatch Logs.
`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 instance.
`DBInstance.Builder`	`engineVersion(String engineVersion)` Indicates the database engine version.
`DBInstance.Builder`	`instanceCreateTime(Instant instanceCreateTime)` Provides the date and time that the instance was created.
`DBInstance.Builder`	`kmsKeyId(String kmsKeyId)` If `StorageEncrypted` is `true`, the KMS key identifier for the encrypted instance.
`DBInstance.Builder`	`latestRestorableTime(Instant latestRestorableTime)` Specifies the latest time to which a database can be restored with point-in-time restore.
`default DBInstance.Builder`	`pendingModifiedValues(Consumer<PendingModifiedValues.Builder> pendingModifiedValues)` Specifies that changes to the instance are pending.
`DBInstance.Builder`	`pendingModifiedValues(PendingModifiedValues pendingModifiedValues)` Specifies that changes to the instance are pending.
`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 Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
`DBInstance.Builder`	`publiclyAccessible(Boolean publiclyAccessible)` Not supported.
`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 or not the instance is encrypted.
`DBInstance.Builder`	`vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)` Provides a list of VPC security group elements that the instance belongs to.
`DBInstance.Builder`	`vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)` Provides a list of VPC security group elements that the instance belongs to.
`DBInstance.Builder`	`vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)` Provides a list of VPC security group elements that the instance belongs to.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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-provided database identifier. This identifier is the unique key that identifies an instance.
    
    Parameters:
    
    dbInstanceIdentifier - Contains a user-provided database identifier. This identifier is the unique key that identifies an 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 instance.
    
    Parameters:
    
    dbInstanceClass - Contains the name of the compute and memory capacity class of the 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 instance.
    
    Parameters:
    
    engine - Provides the name of the database engine to be used for this 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.
  - 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 method 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)
  - instanceCreateTime
```
DBInstance.Builder instanceCreateTime(Instant instanceCreateTime)
```
    Provides the date and time that the instance was created.
    
    Parameters:
    
    instanceCreateTime - Provides the date and time that the 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 snapshots are retained.
    
    Parameters:
    
    backupRetentionPeriod - Specifies the number of days for which automatic snapshots are retained.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcSecurityGroups
```
DBInstance.Builder vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
```
    Provides a list of VPC security group elements that the instance belongs to.
    
    Parameters:
    
    vpcSecurityGroups - Provides a list of VPC security group elements that the 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 instance belongs to.
    
    Parameters:
    
    vpcSecurityGroups - Provides a list of VPC security group elements that the 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 instance belongs to.
    This is a convenience method that creates an instance of the VpcSecurityGroupMembership.Builder avoiding the need to create one manually via VpcSecurityGroupMembership.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #vpcSecurityGroups(List).
    
    Parameters:
    
    vpcSecurityGroups - a consumer that will call methods on VpcSecurityGroupMembership.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #vpcSecurityGroups(java.util.Collection)
  - availabilityZone
```
DBInstance.Builder availabilityZone(String availabilityZone)
```
    Specifies the name of the Availability Zone that the instance is located in.
    
    Parameters:
    
    availabilityZone - Specifies the name of the Availability Zone that the 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 that is associated with the instance, including the name, description, and subnets in the subnet group.
    
    Parameters:
    
    dbSubnetGroup - Specifies information on the subnet group that is associated with the 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 that is associated with the instance, including the name, description, and subnets in the subnet group.
    This is a convenience method 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 instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
    
    Parameters:
    
    pendingModifiedValues - Specifies that changes to the instance are pending. This element is included only 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 instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
    This is a convenience method 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.
  - 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)
```
    Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
    
    Parameters:
    
    autoMinorVersionUpgrade - Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - publiclyAccessible
```
DBInstance.Builder publiclyAccessible(Boolean publiclyAccessible)
```
    Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
    
    Parameters:
    
    publiclyAccessible - Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
    
    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 method that creates an instance of the DBInstanceStatusInfo.Builder avoiding the need to create one manually via DBInstanceStatusInfo.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #statusInfos(List).
    
    Parameters:
    
    statusInfos - a consumer that will call methods on DBInstanceStatusInfo.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #statusInfos(java.util.Collection)
  - dbClusterIdentifier
```
DBInstance.Builder dbClusterIdentifier(String dbClusterIdentifier)
```
    Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
    
    Parameters:
    
    dbClusterIdentifier - Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - storageEncrypted
```
DBInstance.Builder storageEncrypted(Boolean storageEncrypted)
```
    Specifies whether or not the instance is encrypted.
    
    Parameters:
    
    storageEncrypted - Specifies whether or not the 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 KMS key identifier for the encrypted instance.
    
    Parameters:
    
    kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbiResourceId
```
DBInstance.Builder dbiResourceId(String dbiResourceId)
```
    The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
    
    Parameters:
    
    dbiResourceId - The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the 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.
  - copyTagsToSnapshot
```
DBInstance.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
```
    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
    
    Parameters:
    
    copyTagsToSnapshot - A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
    
    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 Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
    
    Parameters:
    
    promotionTier - A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
    
    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 instance.
    
    Parameters:
    
    dbInstanceArn - The Amazon Resource Name (ARN) for the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enabledCloudwatchLogsExports
```
DBInstance.Builder enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
```
    A list of log types that this instance is configured to export to CloudWatch Logs.
    
    Parameters:
    
    enabledCloudwatchLogsExports - A list of log types that this instance is configured to export to CloudWatch Logs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enabledCloudwatchLogsExports
```
DBInstance.Builder enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
```
    A list of log types that this instance is configured to export to CloudWatch Logs.
    
    Parameters:
    
    enabledCloudwatchLogsExports - A list of log types that this instance is configured to export to CloudWatch Logs.
    
    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.core.SdkPojo

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

endpoint

endpoint

instanceCreateTime

preferredBackupWindow

backupRetentionPeriod

vpcSecurityGroups

vpcSecurityGroups

vpcSecurityGroups

availabilityZone

dbSubnetGroup

dbSubnetGroup

preferredMaintenanceWindow

pendingModifiedValues

pendingModifiedValues

latestRestorableTime

engineVersion

autoMinorVersionUpgrade

publiclyAccessible

statusInfos

statusInfos

statusInfos

dbClusterIdentifier

storageEncrypted

kmsKeyId

dbiResourceId

caCertificateIdentifier

copyTagsToSnapshot

promotionTier

dbInstanceArn

enabledCloudwatchLogsExports

enabledCloudwatchLogsExports