DatabaseState class
Input properties used for looking up and filtering Database resources.
Constructors
-
DatabaseState({Input<
bool?> ? applyImmediately, Input<String?> ? arn, Input<String?> ? availabilityZone, Input<bool?> ? backupRetentionEnabled, Input<String?> ? blueprintId, Input<String?> ? bundleId, Input<String?> ? caCertificateIdentifier, Input<int?> ? cpuCount, Input<String?> ? createdAt, Input<double?> ? diskSize, Input<String?> ? engine, Input<String?> ? engineVersion, Input<String?> ? finalSnapshotName, Input<String?> ? masterDatabaseName, Input<String?> ? masterEndpointAddress, Input<int?> ? masterEndpointPort, Input<String?> ? masterPassword, Input<String?> ? masterUsername, Input<String?> ? preferredBackupWindow, Input<String?> ? preferredMaintenanceWindow, Input<bool?> ? publiclyAccessible, Input<double?> ? ramSize, Input<String?> ? region, Input<String?> ? relationalDatabaseName, Input<String?> ? secondaryAvailabilityZone, Input<bool?> ? skipFinalSnapshot, Input<String?> ? supportCode, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll})String, String> ?> -
Creates a new DatabaseState.
applyImmediatelyWhether to apply changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.arnARN of the database (matchesid).availabilityZoneAvailability Zone in which to create your database. Use the us-east-2a case-sensitive format.backupRetentionEnabledWhether to enable automated backup retention for your database. When false, disables automated backup retention for your database. Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database.blueprintIdBlueprint ID for your database. A blueprint describes the major engine version of a database. You can get a list of database blueprints IDs by using the AWS CLI command:aws lightsail get-relational-database-blueprintsbundleIdBundle ID for your database. A bundle describes the performance specifications for your database (see list below). You can get a list of database bundle IDs by using the AWS CLI command:aws lightsail get-relational-database-bundles.caCertificateIdentifierCertificate associated with the database.cpuCountNumber of vCPUs for the database.createdAtDate and time when the database was created.diskSizeSize of the disk for the database.engineDatabase software (for example, MySQL).engineVersionDatabase engine version (for example, 5.7.23).finalSnapshotNameName of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.masterDatabaseNameName of the master database created when the Lightsail database resource is created.masterEndpointAddressMaster endpoint FQDN for the database.masterEndpointPortMaster endpoint network port for the database.masterPasswordPassword for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".masterUsernameMaster user name for your database.preferredBackupWindowDaily time range during which automated backups are created for your database if automated backups are enabled. Must be in the hh24:mi-hh24:mi format. Example:16:00-16:30. Specified in Coordinated Universal Time (UTC).preferredMaintenanceWindowWeekly time range during which system maintenance can occur on your database. Must be in the ddd:hh24:mi-ddd:hh24:mi format. Specified in Coordinated Universal Time (UTC). Example:Tue:17:00-Tue:17:30publiclyAccessibleWhether the database is accessible to resources outside of your Lightsail account. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.ramSizeAmount of RAM in GB for the database.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.relationalDatabaseNameName to use for your Lightsail database resource. Names be unique within each AWS Region in your Lightsail account.secondaryAvailabilityZoneSecondary Availability Zone of a high availability database. The secondary database is used for failover support of a high availability database.skipFinalSnapshotWhether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.supportCodeSupport 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.tagsMap of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.const -
DatabaseState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
applyImmediately
→ Input<
bool?> ? -
Whether to apply changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.
final
-
arn
→ Input<
String?> ? -
ARN of the database (matches
id).final -
availabilityZone
→ Input<
String?> ? -
Availability Zone in which to create your database. Use the us-east-2a case-sensitive format.
final
-
backupRetentionEnabled
→ Input<
bool?> ? -
Whether to enable automated backup retention for your database. When false, disables automated backup retention for your database. Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database.
final
-
blueprintId
→ Input<
String?> ? -
Blueprint ID for your database. A blueprint describes the major engine version of a database. You can get a list of database blueprints IDs by using the AWS CLI command:
aws lightsail get-relational-database-blueprintsfinal -
bundleId
→ Input<
String?> ? -
Bundle ID for your database. A bundle describes the performance specifications for your database (see list below). You can get a list of database bundle IDs by using the AWS CLI command:
aws lightsail get-relational-database-bundles.final -
caCertificateIdentifier
→ Input<
String?> ? -
Certificate associated with the database.
final
-
cpuCount
→ Input<
int?> ? -
Number of vCPUs for the database.
final
-
createdAt
→ Input<
String?> ? -
Date and time when the database was created.
final
-
diskSize
→ Input<
double?> ? -
Size of the disk for the database.
final
-
engine
→ Input<
String?> ? -
Database software (for example, MySQL).
final
-
engineVersion
→ Input<
String?> ? -
Database engine version (for example, 5.7.23).
final
-
finalSnapshotName
→ Input<
String?> ? -
Name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
masterDatabaseName
→ Input<
String?> ? -
Name of the master database created when the Lightsail database resource is created.
final
-
masterEndpointAddress
→ Input<
String?> ? -
Master endpoint FQDN for the database.
final
-
masterEndpointPort
→ Input<
int?> ? -
Master endpoint network port for the database.
final
-
masterPassword
→ Input<
String?> ? -
Password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".
final
-
masterUsername
→ Input<
String?> ? -
Master user name for your database.
final
-
preferredBackupWindow
→ Input<
String?> ? -
Daily time range during which automated backups are created for your database if automated backups are enabled. Must be in the hh24:mi-hh24:mi format. Example:
16:00-16:30. Specified in Coordinated Universal Time (UTC).final -
preferredMaintenanceWindow
→ Input<
String?> ? -
Weekly time range during which system maintenance can occur on your database. Must be in the ddd:hh24:mi-ddd:hh24:mi format. Specified in Coordinated Universal Time (UTC). Example:
Tue:17:00-Tue:17:30final -
publiclyAccessible
→ Input<
bool?> ? -
Whether the database is accessible to resources outside of your Lightsail account. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
final
-
ramSize
→ Input<
double?> ? -
Amount of RAM in GB for the database.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
relationalDatabaseName
→ Input<
String?> ? -
Name to use for your Lightsail database resource. Names be unique within each AWS Region in your Lightsail account.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
secondaryAvailabilityZone
→ Input<
String?> ? -
Secondary Availability Zone of a high availability database. The secondary database is used for failover support of a high availability database.
final
-
skipFinalSnapshot
→ Input<
bool?> ? -
Whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.
final
-
supportCode
→ Input<
String?> ? -
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.
final
-
Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited