DatabaseArgs class

The set of arguments for Database. The set of arguments for Database.

Constructors

DatabaseArgs({Input<bool?>? applyImmediately, Input<String?>? availabilityZone, Input<bool?>? backupRetentionEnabled, required Input<String> blueprintId, required Input<String> bundleId, Input<String?>? finalSnapshotName, required Input<String> masterDatabaseName, required Input<String> masterPassword, required Input<String> masterUsername, Input<String?>? preferredBackupWindow, Input<String?>? preferredMaintenanceWindow, Input<bool?>? publiclyAccessible, Input<String?>? region, required Input<String> relationalDatabaseName, Input<bool?>? skipFinalSnapshot, Input<Map<String, String>?>? tags})
Creates a new DatabaseArgs. applyImmediately Whether to apply changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage. availabilityZone Availability Zone in which to create your database. Use the us-east-2a case-sensitive format. backupRetentionEnabled 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. blueprintId 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-blueprints bundleId 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. finalSnapshotName Name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter. masterDatabaseName Name of the master database created when the Lightsail database resource is created. masterPassword Password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@". masterUsername Master user name for your database. preferredBackupWindow 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). preferredMaintenanceWindow 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:30 publiclyAccessible 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. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. relationalDatabaseName Name to use for your Lightsail database resource. Names be unique within each AWS Region in your Lightsail account. skipFinalSnapshot 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. tags 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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
const
DatabaseArgs.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
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-blueprints
final
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
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
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:30
final
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
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
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
tags → Input<Map<String, String>?>?
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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
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