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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description RelationalDatabase.Builderarn(String arn)The Amazon Resource Name (ARN) of the database.RelationalDatabase.BuilderbackupRetentionEnabled(Boolean backupRetentionEnabled)A Boolean value indicating whether automated backup retention is enabled for the database.RelationalDatabase.BuildercaCertificateIdentifier(String caCertificateIdentifier)The certificate associated with the database.RelationalDatabase.BuildercreatedAt(Instant createdAt)The timestamp when the database was created.RelationalDatabase.Builderengine(String engine)The database software (for example,MySQL).RelationalDatabase.BuilderengineVersion(String engineVersion)The database engine version (for example,5.7.23).default RelationalDatabase.Builderhardware(Consumer<RelationalDatabaseHardware.Builder> hardware)Describes the hardware of the database.RelationalDatabase.Builderhardware(RelationalDatabaseHardware hardware)Describes the hardware of the database.RelationalDatabase.BuilderlatestRestorableTime(Instant latestRestorableTime)The latest point in time to which the database can be restored.default RelationalDatabase.Builderlocation(Consumer<ResourceLocation.Builder> location)The Region name and Availability Zone where the database is located.RelationalDatabase.Builderlocation(ResourceLocation location)The Region name and Availability Zone where the database is located.RelationalDatabase.BuildermasterDatabaseName(String masterDatabaseName)The name of the master database created when the Lightsail database resource is created.default RelationalDatabase.BuildermasterEndpoint(Consumer<RelationalDatabaseEndpoint.Builder> masterEndpoint)The master endpoint for the database.RelationalDatabase.BuildermasterEndpoint(RelationalDatabaseEndpoint masterEndpoint)The master endpoint for the database.RelationalDatabase.BuildermasterUsername(String masterUsername)The master user name of the database.RelationalDatabase.Buildername(String name)The unique name of the database resource in Lightsail.RelationalDatabase.BuilderparameterApplyStatus(String parameterApplyStatus)The status of parameter updates for the database.RelationalDatabase.BuilderpendingMaintenanceActions(Collection<PendingMaintenanceAction> pendingMaintenanceActions)Describes the pending maintenance actions for the database.RelationalDatabase.BuilderpendingMaintenanceActions(Consumer<PendingMaintenanceAction.Builder>... pendingMaintenanceActions)Describes the pending maintenance actions for the database.RelationalDatabase.BuilderpendingMaintenanceActions(PendingMaintenanceAction... pendingMaintenanceActions)Describes the pending maintenance actions for the database.default RelationalDatabase.BuilderpendingModifiedValues(Consumer<PendingModifiedRelationalDatabaseValues.Builder> pendingModifiedValues)Describes pending database value modifications.RelationalDatabase.BuilderpendingModifiedValues(PendingModifiedRelationalDatabaseValues pendingModifiedValues)Describes pending database value modifications.RelationalDatabase.BuilderpreferredBackupWindow(String preferredBackupWindow)The daily time range during which automated backups are created for the database (for example,16:00-16:30).RelationalDatabase.BuilderpreferredMaintenanceWindow(String preferredMaintenanceWindow)The weekly time range during which system maintenance can occur on the database.RelationalDatabase.BuilderpubliclyAccessible(Boolean publiclyAccessible)A Boolean value indicating whether the database is publicly accessible.RelationalDatabase.BuilderrelationalDatabaseBlueprintId(String relationalDatabaseBlueprintId)The blueprint ID for the database.RelationalDatabase.BuilderrelationalDatabaseBundleId(String relationalDatabaseBundleId)The bundle ID for the database.RelationalDatabase.BuilderresourceType(String resourceType)The Lightsail resource type for the database (for example,RelationalDatabase).RelationalDatabase.BuilderresourceType(ResourceType resourceType)The Lightsail resource type for the database (for example,RelationalDatabase).RelationalDatabase.BuildersecondaryAvailabilityZone(String secondaryAvailabilityZone)Describes the secondary Availability Zone of a high availability database.RelationalDatabase.Builderstate(String state)Describes the current state of the database.RelationalDatabase.BuildersupportCode(String supportCode)The support code for the database.RelationalDatabase.Buildertags(Collection<Tag> tags)The tag keys and optional values for the resource.RelationalDatabase.Buildertags(Consumer<Tag.Builder>... tags)The tag keys and optional values for the resource.RelationalDatabase.Buildertags(Tag... tags)The tag keys and optional values for the resource.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
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 theResourceLocation.Builderavoiding the need to create one manually viaResourceLocation.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolocation(ResourceLocation).- Parameters:
location- a consumer that will call methods onResourceLocation.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
location(ResourceLocation)
-
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,ResourceType
-
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:
ResourceType,ResourceType
-
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 theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
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 theRelationalDatabaseHardware.Builderavoiding the need to create one manually viaRelationalDatabaseHardware.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohardware(RelationalDatabaseHardware).- Parameters:
hardware- a consumer that will call methods onRelationalDatabaseHardware.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
hardware(RelationalDatabaseHardware)
-
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 thePendingModifiedRelationalDatabaseValues.Builderavoiding the need to create one manually viaPendingModifiedRelationalDatabaseValues.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topendingModifiedValues(PendingModifiedRelationalDatabaseValues).- Parameters:
pendingModifiedValues- a consumer that will call methods onPendingModifiedRelationalDatabaseValues.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
pendingModifiedValues(PendingModifiedRelationalDatabaseValues)
-
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 theRelationalDatabaseEndpoint.Builderavoiding the need to create one manually viaRelationalDatabaseEndpoint.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tomasterEndpoint(RelationalDatabaseEndpoint).- Parameters:
masterEndpoint- a consumer that will call methods onRelationalDatabaseEndpoint.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
masterEndpoint(RelationalDatabaseEndpoint)
-
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 thePendingMaintenanceAction.Builderavoiding the need to create one manually viaPendingMaintenanceAction.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#pendingMaintenanceActions(List.) - Parameters:
pendingMaintenanceActions- a consumer that will call methods onPendingMaintenanceAction.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#pendingMaintenanceActions(java.util.Collection)
-
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.
-
-