Package software.amazon.awssdk.services.lightsail.model

Interface RelationalDatabase.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RelationalDatabase.Builder,RelationalDatabase>, SdkBuilder<RelationalDatabase.Builder,RelationalDatabase>, SdkPojo
Enclosing class:
RelationalDatabase
public static interface RelationalDatabase.Builder extends SdkPojo, CopyableBuilder<RelationalDatabase.Builder,RelationalDatabase>

  • Method Details

    • name

      RelationalDatabase.Builder name(String name)

      The unique name of the database resource in Lightsail.

      Parameters:
      name - The unique name of the database resource in Lightsail.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      RelationalDatabase.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the database.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportCode

      RelationalDatabase.Builder supportCode(String supportCode)

      The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

      Parameters:
      supportCode - The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      RelationalDatabase.Builder createdAt(Instant createdAt)

      The timestamp when the database was created. Formatted in Unix time.

      Parameters:
      createdAt - The timestamp when the database was created. Formatted in Unix time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      RelationalDatabase.Builder location(ResourceLocation location)

      The Region name and Availability Zone where the database is located.

      Parameters:
      location - The Region name and Availability Zone where the database is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      default RelationalDatabase.Builder location(Consumer<ResourceLocation.Builder> location)

      The Region name and Availability Zone where the database is located.

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

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

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

    • resourceType

      RelationalDatabase.Builder resourceType(String resourceType)

      The Lightsail resource type for the database (for example, RelationalDatabase).

      Parameters:
      resourceType - The Lightsail resource type for the database (for example, RelationalDatabase).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      RelationalDatabase.Builder resourceType(ResourceType resourceType)

      The Lightsail resource type for the database (for example, RelationalDatabase).

      Parameters:
      resourceType - The Lightsail resource type for the database (for example, RelationalDatabase).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      RelationalDatabase.Builder tags(Collection<Tag> tags)

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      Parameters:
      tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RelationalDatabase.Builder tags(Tag... tags)

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      Parameters:
      tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RelationalDatabase.Builder tags(Consumer<Tag.Builder>... tags)

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • relationalDatabaseBlueprintId

      RelationalDatabase.Builder relationalDatabaseBlueprintId(String relationalDatabaseBlueprintId)

      The blueprint ID for the database. A blueprint describes the major engine version of a database.

      Parameters:
      relationalDatabaseBlueprintId - The blueprint ID for the database. A blueprint describes the major engine version of a database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relationalDatabaseBundleId

      RelationalDatabase.Builder relationalDatabaseBundleId(String relationalDatabaseBundleId)

      The bundle ID for the database. A bundle describes the performance specifications for your database.

      Parameters:
      relationalDatabaseBundleId - The bundle ID for the database. A bundle describes the performance specifications for your database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterDatabaseName

      RelationalDatabase.Builder masterDatabaseName(String masterDatabaseName)

      The name of the master database created when the Lightsail database resource is created.

      Parameters:
      masterDatabaseName - The name of the master database created when the Lightsail database resource is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hardware

      RelationalDatabase.Builder hardware(RelationalDatabaseHardware hardware)

      Describes the hardware of the database.

      Parameters:
      hardware - Describes the hardware of the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hardware

      default RelationalDatabase.Builder hardware(Consumer<RelationalDatabaseHardware.Builder> hardware)

      Describes the hardware of the database.

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

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

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

    • state

      RelationalDatabase.Builder state(String state)

      Describes the current state of the database.

      Parameters:
      state - Describes the current state of the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAvailabilityZone

      RelationalDatabase.Builder secondaryAvailabilityZone(String secondaryAvailabilityZone)

      Describes the secondary Availability Zone of a high availability database.

      The secondary database is used for failover support of a high availability database.

      Parameters:
      secondaryAvailabilityZone - Describes the secondary Availability Zone of a high availability database.

      The secondary database is used for failover support of a high availability database.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backupRetentionEnabled

      RelationalDatabase.Builder backupRetentionEnabled(Boolean backupRetentionEnabled)

      A Boolean value indicating whether automated backup retention is enabled for the database.

      Parameters:
      backupRetentionEnabled - A Boolean value indicating whether automated backup retention is enabled for the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingModifiedValues

      RelationalDatabase.Builder pendingModifiedValues(PendingModifiedRelationalDatabaseValues pendingModifiedValues)

      Describes pending database value modifications.

      Parameters:
      pendingModifiedValues - Describes pending database value modifications.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingModifiedValues

      default RelationalDatabase.Builder pendingModifiedValues(Consumer<PendingModifiedRelationalDatabaseValues.Builder> pendingModifiedValues)

      Describes pending database value modifications.

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

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

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

    • engine

      RelationalDatabase.Builder engine(String engine)

      The database software (for example, MySQL).

      Parameters:
      engine - The database software (for example, MySQL).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      RelationalDatabase.Builder engineVersion(String engineVersion)

      The database engine version (for example, 5.7.23).

      Parameters:
      engineVersion - The database engine version (for example, 5.7.23).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • latestRestorableTime

      RelationalDatabase.Builder latestRestorableTime(Instant latestRestorableTime)

      The latest point in time to which the database can be restored. Formatted in Unix time.

      Parameters:
      latestRestorableTime - The latest point in time to which the database can be restored. Formatted in Unix time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterUsername

      RelationalDatabase.Builder masterUsername(String masterUsername)

      The master user name of the database.

      Parameters:
      masterUsername - The master user name of the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterApplyStatus

      RelationalDatabase.Builder parameterApplyStatus(String parameterApplyStatus)

      The status of parameter updates for the database.

      Parameters:
      parameterApplyStatus - The status of parameter updates for the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredBackupWindow

      RelationalDatabase.Builder preferredBackupWindow(String preferredBackupWindow)

      The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

      Parameters:
      preferredBackupWindow - The daily time range during which automated backups are created for the database (for example, 16:00-16:30).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredMaintenanceWindow

      RelationalDatabase.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

      The weekly time range during which system maintenance can occur on the database.

      In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

      Parameters:
      preferredMaintenanceWindow - The weekly time range during which system maintenance can occur on the database.

      In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publiclyAccessible

      RelationalDatabase.Builder publiclyAccessible(Boolean publiclyAccessible)

      A Boolean value indicating whether the database is publicly accessible.

      Parameters:
      publiclyAccessible - A Boolean value indicating whether the database is publicly accessible.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterEndpoint

      RelationalDatabase.Builder masterEndpoint(RelationalDatabaseEndpoint masterEndpoint)

      The master endpoint for the database.

      Parameters:
      masterEndpoint - The master endpoint for the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterEndpoint

      default RelationalDatabase.Builder masterEndpoint(Consumer<RelationalDatabaseEndpoint.Builder> masterEndpoint)

      The master endpoint for the database.

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

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

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

    • pendingMaintenanceActions

      RelationalDatabase.Builder pendingMaintenanceActions(Collection<PendingMaintenanceAction> pendingMaintenanceActions)

      Describes the pending maintenance actions for the database.

      Parameters:
      pendingMaintenanceActions - Describes the pending maintenance actions for the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingMaintenanceActions

      RelationalDatabase.Builder pendingMaintenanceActions(PendingMaintenanceAction... pendingMaintenanceActions)

      Describes the pending maintenance actions for the database.

      Parameters:
      pendingMaintenanceActions - Describes the pending maintenance actions for the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingMaintenanceActions

      RelationalDatabase.Builder pendingMaintenanceActions(Consumer<PendingMaintenanceAction.Builder>... pendingMaintenanceActions)

      Describes the pending maintenance actions for the database.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingMaintenanceActions(List<PendingMaintenanceAction>).

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

    • caCertificateIdentifier

      RelationalDatabase.Builder caCertificateIdentifier(String caCertificateIdentifier)

      The certificate associated with the database.

      Parameters:
      caCertificateIdentifier - The certificate associated with the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.