@Generated(value="software.amazon.awssdk:codegen") public final class RelationalDatabase extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RelationalDatabase.Builder,RelationalDatabase>
Describes a database.
Modifier and Type | Class and Description |
---|---|
static interface |
RelationalDatabase.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The Amazon Resource Name (ARN) of the database.
|
Boolean |
backupRetentionEnabled()
A Boolean value indicating whether automated backup retention is enabled for the database.
|
static RelationalDatabase.Builder |
builder() |
String |
caCertificateIdentifier()
The certificate associated with the database.
|
Instant |
createdAt()
The timestamp when the database was created.
|
String |
engine()
The database software (for example,
MySQL ). |
String |
engineVersion()
The database engine version (for example,
5.7.23 ). |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
RelationalDatabaseHardware |
hardware()
Describes the hardware of the database.
|
int |
hashCode() |
boolean |
hasPendingMaintenanceActions()
Returns true if the PendingMaintenanceActions property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
Instant |
latestRestorableTime()
The latest point in time to which the database can be restored.
|
ResourceLocation |
location()
The Region name and Availability Zone where the database is located.
|
String |
masterDatabaseName()
The name of the master database created when the Lightsail database resource is created.
|
RelationalDatabaseEndpoint |
masterEndpoint()
The master endpoint for the database.
|
String |
masterUsername()
The master user name of the database.
|
String |
name()
The unique name of the database resource in Lightsail.
|
String |
parameterApplyStatus()
The status of parameter updates for the database.
|
List<PendingMaintenanceAction> |
pendingMaintenanceActions()
Describes the pending maintenance actions for the database.
|
PendingModifiedRelationalDatabaseValues |
pendingModifiedValues()
Describes pending database value modifications.
|
String |
preferredBackupWindow()
The daily time range during which automated backups are created for the database (for example,
16:00-16:30 ). |
String |
preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur on the database.
|
Boolean |
publiclyAccessible()
A Boolean value indicating whether the database is publicly accessible.
|
String |
relationalDatabaseBlueprintId()
The blueprint ID for the database.
|
String |
relationalDatabaseBundleId()
The bundle ID for the database.
|
ResourceType |
resourceType()
The Lightsail resource type for the database (for example,
RelationalDatabase ). |
String |
resourceTypeAsString()
The Lightsail resource type for the database (for example,
RelationalDatabase ). |
List<SdkField<?>> |
sdkFields() |
String |
secondaryAvailabilityZone()
Describes the secondary Availability Zone of a high availability database.
|
static Class<? extends RelationalDatabase.Builder> |
serializableBuilderClass() |
String |
state()
Describes the current state of the database.
|
String |
supportCode()
The support code for the database.
|
List<Tag> |
tags()
The tag keys and optional values for the resource.
|
RelationalDatabase.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String name()
The unique name of the database resource in Lightsail.
public final String arn()
The Amazon Resource Name (ARN) of the database.
public final 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.
public final Instant createdAt()
The timestamp when the database was created. Formatted in Unix time.
public final ResourceLocation location()
The Region name and Availability Zone where the database is located.
public final ResourceType resourceType()
The Lightsail resource type for the database (for example, RelationalDatabase
).
If the service returns an enum value that is not available in the current SDK version, resourceType
will
return ResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
resourceTypeAsString()
.
RelationalDatabase
).ResourceType
public final String resourceTypeAsString()
The Lightsail resource type for the database (for example, RelationalDatabase
).
If the service returns an enum value that is not available in the current SDK version, resourceType
will
return ResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
resourceTypeAsString()
.
RelationalDatabase
).ResourceType
public final boolean hasTags()
public final List<Tag> tags()
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final String relationalDatabaseBlueprintId()
The blueprint ID for the database. A blueprint describes the major engine version of a database.
public final String relationalDatabaseBundleId()
The bundle ID for the database. A bundle describes the performance specifications for your database.
public final String masterDatabaseName()
The name of the master database created when the Lightsail database resource is created.
public final RelationalDatabaseHardware hardware()
Describes the hardware of the database.
public final String state()
Describes the current state of the database.
public final 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.
The secondary database is used for failover support of a high availability database.
public final Boolean backupRetentionEnabled()
A Boolean value indicating whether automated backup retention is enabled for the database.
public final PendingModifiedRelationalDatabaseValues pendingModifiedValues()
Describes pending database value modifications.
public final String engine()
The database software (for example, MySQL
).
MySQL
).public final String engineVersion()
The database engine version (for example, 5.7.23
).
5.7.23
).public final Instant latestRestorableTime()
The latest point in time to which the database can be restored. Formatted in Unix time.
public final String masterUsername()
The master user name of the database.
public final String parameterApplyStatus()
The status of parameter updates for the database.
public final String preferredBackupWindow()
The daily time range during which automated backups are created for the database (for example,
16:00-16:30
).
16:00-16:30
).public final 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
.
In the format ddd:hh24:mi-ddd:hh24:mi
. For example, Tue:17:00-Tue:17:30
.
public final Boolean publiclyAccessible()
A Boolean value indicating whether the database is publicly accessible.
public final RelationalDatabaseEndpoint masterEndpoint()
The master endpoint for the database.
public final boolean hasPendingMaintenanceActions()
public final List<PendingMaintenanceAction> pendingMaintenanceActions()
Describes the pending maintenance actions for the database.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasPendingMaintenanceActions()
to see if a value was sent in this field.
public final String caCertificateIdentifier()
The certificate associated with the database.
public RelationalDatabase.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RelationalDatabase.Builder,RelationalDatabase>
public static RelationalDatabase.Builder builder()
public static Class<? extends RelationalDatabase.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()