Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lightsail-database.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Lightsail::Database. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git

Properties

RelationalDatabaseName string | Aws_CF_FunctionString required

The name to use for your new Lightsail database resource.

RelationalDatabaseBlueprintId string | Aws_CF_FunctionString required

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

RelationalDatabaseBundleId string | Aws_CF_FunctionString required

The bundle ID for your new database. A bundle describes the performance specifications for your database.

MasterDatabaseName string | Aws_CF_FunctionString required

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.

MasterUsername string | Aws_CF_FunctionString required

The name for the master user.

AvailabilityZone string | Aws_CF_FunctionString

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

MasterUserPassword string | Aws_CF_FunctionString

The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.

PreferredBackupWindow string | Aws_CF_FunctionString

The daily time range during which automated backups are created for your new database if automated backups are enabled.

PreferredMaintenanceWindow string | Aws_CF_FunctionString

The weekly time range during which system maintenance can occur on your new database.

PubliclyAccessible 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.

CaCertificateIdentifier string | Aws_CF_FunctionString

Indicates the certificate that needs to be associated with the database.

BackupRetention 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.

RotateMasterUserPassword 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.

RelationalDatabaseParameters RelationalDatabaseParameter[]

Update one or more parameters of the relational database.

uniqueItems=true
Tags Tag[]

An array of key-value pairs to apply to this resource.

uniqueItems=true

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

RelationalDatabaseParameter object

Describes the parameters of the database.

AllowedValues string | Aws_CF_FunctionString

Specifies the valid range of values for the parameter.

ApplyMethod string | Aws_CF_FunctionString

Indicates when parameter updates are applied. Can be immediate or pending-reboot.

ApplyType string | Aws_CF_FunctionString

Specifies the engine-specific parameter type.

DataType string | Aws_CF_FunctionString

Specifies the valid data type for the parameter.

Description string | Aws_CF_FunctionString

Provides a description of the parameter.

IsModifiable boolean

A Boolean value indicating whether the parameter can be modified.

ParameterName string | Aws_CF_FunctionString

Specifies the name of the parameter.

ParameterValue string | Aws_CF_FunctionString

Specifies the value of the parameter.