Package software.amazon.awssdk.services.docdb.model

Interface DBInstance.Builder

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 Details

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

    • 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<VpcSecurityGroupMembership>).

      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:

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

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

    • 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<DBInstanceStatusInfo>).

      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:

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

    • certificateDetails

      DBInstance.Builder certificateDetails(CertificateDetails certificateDetails)

      The details of the DB instance's server certificate.

      Parameters:
      certificateDetails - The details of the DB instance's server certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificateDetails

      default DBInstance.Builder certificateDetails(Consumer<CertificateDetails.Builder> certificateDetails)

      The details of the DB instance's server certificate.

      This is a convenience method that creates an instance of the CertificateDetails.Builder avoiding the need to create one manually via CertificateDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificateDetails(CertificateDetails).

      Parameters:
      certificateDetails - a consumer that will call methods on CertificateDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • performanceInsightsEnabled

      DBInstance.Builder performanceInsightsEnabled(Boolean performanceInsightsEnabled)

      Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

      Parameters:
      performanceInsightsEnabled - Set to true if Amazon RDS 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 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 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.