database_tags
Expands all tag keys and values for databases
in a region
Overview
Name | database_tags |
Type | Resource |
Description | Resource Type definition for AWS::Lightsail::Database |
Id | aws.lightsail.database_tags |
Fields
Name | Datatype | Description |
---|---|---|
relational_database_name | string | The name to use for your new Lightsail database resource. |
database_arn | string | |
availability_zone | string | The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. |
relational_database_blueprint_id | string | The blueprint ID for your new database. A blueprint describes the major engine version of a database. |
relational_database_bundle_id | string | The bundle ID for your new database. A bundle describes the performance specifications for your database. |
master_database_name | string | The name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource. |
master_username | string | The name for the master user. |
master_user_password | string | The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces. |
preferred_backup_window | string | The daily time range during which automated backups are created for your new database if automated backups are enabled. |
preferred_maintenance_window | string | The weekly time range during which system maintenance can occur on your new database. |
publicly_accessible | boolean | Specifies the accessibility options for your new database. 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. |
ca_certificate_identifier | string | Indicates the certificate that needs to be associated with the database. |
backup_retention | boolean | When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage. |
rotate_master_user_password | boolean | When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password. |
relational_database_parameters | array | Update one or more parameters of the relational database. |
tag_key | string | Tag key. |
tag_value | string | Tag value. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Expands tags for all databases
in a region.
SELECT
region,
relational_database_name,
database_arn,
availability_zone,
relational_database_blueprint_id,
relational_database_bundle_id,
master_database_name,
master_username,
master_user_password,
preferred_backup_window,
preferred_maintenance_window,
publicly_accessible,
ca_certificate_identifier,
backup_retention,
rotate_master_user_password,
relational_database_parameters,
tag_key,
tag_value
FROM aws.lightsail.database_tags
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the database_tags
resource, see databases