Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. Database

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.Database

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Lightsail::Database

    Create Database Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             relational_database_blueprint_id: Optional[str] = None,
             master_username: Optional[str] = None,
             relational_database_name: Optional[str] = None,
             master_database_name: Optional[str] = None,
             relational_database_bundle_id: Optional[str] = None,
             master_user_password: Optional[str] = None,
             backup_retention: Optional[bool] = None,
             publicly_accessible: Optional[bool] = None,
             preferred_backup_window: Optional[str] = None,
             availability_zone: Optional[str] = None,
             preferred_maintenance_window: Optional[str] = None,
             ca_certificate_identifier: Optional[str] = None,
             relational_database_parameters: Optional[Sequence[DatabaseRelationalDatabaseParameterArgs]] = None,
             rotate_master_user_password: Optional[bool] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)

    type: aws-native:lightsail:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Database Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Database resource accepts the following input properties:

    MasterDatabaseName 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.
    MasterUsername string
    The name for the master user.
    RelationalDatabaseBlueprintId string
    The blueprint ID for your new database. A blueprint describes the major engine version of a database.
    RelationalDatabaseBundleId string
    The bundle ID for your new database. A bundle describes the performance specifications for your database.
    RelationalDatabaseName string
    The name to use for your new Lightsail database resource.
    AvailabilityZone string
    The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
    BackupRetention bool
    When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
    CaCertificateIdentifier string
    Indicates the certificate that needs to be associated with the database.
    MasterUserPassword string
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
    PreferredBackupWindow string
    The daily time range during which automated backups are created for your new database if automated backups are enabled.
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur on your new database.
    PubliclyAccessible bool
    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.
    RelationalDatabaseParameters List<Pulumi.AwsNative.Lightsail.Inputs.DatabaseRelationalDatabaseParameter>
    Update one or more parameters of the relational database.
    RotateMasterUserPassword bool
    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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    MasterDatabaseName 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.
    MasterUsername string
    The name for the master user.
    RelationalDatabaseBlueprintId string
    The blueprint ID for your new database. A blueprint describes the major engine version of a database.
    RelationalDatabaseBundleId string
    The bundle ID for your new database. A bundle describes the performance specifications for your database.
    RelationalDatabaseName string
    The name to use for your new Lightsail database resource.
    AvailabilityZone string
    The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
    BackupRetention bool
    When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
    CaCertificateIdentifier string
    Indicates the certificate that needs to be associated with the database.
    MasterUserPassword string
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
    PreferredBackupWindow string
    The daily time range during which automated backups are created for your new database if automated backups are enabled.
    PreferredMaintenanceWindow string
    The weekly time range during which system maintenance can occur on your new database.
    PubliclyAccessible bool
    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.
    RelationalDatabaseParameters []DatabaseRelationalDatabaseParameterArgs
    Update one or more parameters of the relational database.
    RotateMasterUserPassword bool
    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.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    masterDatabaseName 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.
    masterUsername String
    The name for the master user.
    relationalDatabaseBlueprintId String
    The blueprint ID for your new database. A blueprint describes the major engine version of a database.
    relationalDatabaseBundleId String
    The bundle ID for your new database. A bundle describes the performance specifications for your database.
    relationalDatabaseName String
    The name to use for your new Lightsail database resource.
    availabilityZone String
    The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
    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.
    caCertificateIdentifier String
    Indicates the certificate that needs to be associated with the database.
    masterUserPassword String
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
    preferredBackupWindow String
    The daily time range during which automated backups are created for your new database if automated backups are enabled.
    preferredMaintenanceWindow String
    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.
    relationalDatabaseParameters List<DatabaseRelationalDatabaseParameter>
    Update one or more parameters of the relational database.
    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.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    masterDatabaseName 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.
    masterUsername string
    The name for the master user.
    relationalDatabaseBlueprintId string
    The blueprint ID for your new database. A blueprint describes the major engine version of a database.
    relationalDatabaseBundleId string
    The bundle ID for your new database. A bundle describes the performance specifications for your database.
    relationalDatabaseName string
    The name to use for your new Lightsail database resource.
    availabilityZone string
    The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
    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.
    caCertificateIdentifier string
    Indicates the certificate that needs to be associated with the database.
    masterUserPassword string
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
    preferredBackupWindow string
    The daily time range during which automated backups are created for your new database if automated backups are enabled.
    preferredMaintenanceWindow string
    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.
    relationalDatabaseParameters DatabaseRelationalDatabaseParameter[]
    Update one or more parameters of the relational database.
    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.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    master_database_name str
    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 str
    The name for the master user.
    relational_database_blueprint_id str
    The blueprint ID for your new database. A blueprint describes the major engine version of a database.
    relational_database_bundle_id str
    The bundle ID for your new database. A bundle describes the performance specifications for your database.
    relational_database_name str
    The name to use for your new Lightsail database resource.
    availability_zone str
    The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
    backup_retention bool
    When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
    ca_certificate_identifier str
    Indicates the certificate that needs to be associated with the database.
    master_user_password str
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
    preferred_backup_window str
    The daily time range during which automated backups are created for your new database if automated backups are enabled.
    preferred_maintenance_window str
    The weekly time range during which system maintenance can occur on your new database.
    publicly_accessible bool
    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.
    relational_database_parameters Sequence[DatabaseRelationalDatabaseParameterArgs]
    Update one or more parameters of the relational database.
    rotate_master_user_password bool
    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.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    masterDatabaseName 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.
    masterUsername String
    The name for the master user.
    relationalDatabaseBlueprintId String
    The blueprint ID for your new database. A blueprint describes the major engine version of a database.
    relationalDatabaseBundleId String
    The bundle ID for your new database. A bundle describes the performance specifications for your database.
    relationalDatabaseName String
    The name to use for your new Lightsail database resource.
    availabilityZone String
    The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.
    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.
    caCertificateIdentifier String
    Indicates the certificate that needs to be associated with the database.
    masterUserPassword String
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces.
    preferredBackupWindow String
    The daily time range during which automated backups are created for your new database if automated backups are enabled.
    preferredMaintenanceWindow String
    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.
    relationalDatabaseParameters List<Property Map>
    Update one or more parameters of the relational database.
    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.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:

    DatabaseArn string
    The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    Id string
    The provider-assigned unique ID for this managed resource.
    DatabaseArn string
    The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    Id string
    The provider-assigned unique ID for this managed resource.
    databaseArn String
    The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    id String
    The provider-assigned unique ID for this managed resource.
    databaseArn string
    The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    id string
    The provider-assigned unique ID for this managed resource.
    database_arn str
    The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    id str
    The provider-assigned unique ID for this managed resource.
    databaseArn String
    The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DatabaseRelationalDatabaseParameter, DatabaseRelationalDatabaseParameterArgs

    AllowedValues string
    Specifies the valid range of values for the parameter.
    ApplyMethod string
    Indicates when parameter updates are applied. Can be immediate or pending-reboot.
    ApplyType string
    Specifies the engine-specific parameter type.
    DataType string
    Specifies the valid data type for the parameter.
    Description string
    Provides a description of the parameter.
    IsModifiable bool
    A Boolean value indicating whether the parameter can be modified.
    ParameterName string
    Specifies the name of the parameter.
    ParameterValue string
    Specifies the value of the parameter.
    AllowedValues string
    Specifies the valid range of values for the parameter.
    ApplyMethod string
    Indicates when parameter updates are applied. Can be immediate or pending-reboot.
    ApplyType string
    Specifies the engine-specific parameter type.
    DataType string
    Specifies the valid data type for the parameter.
    Description string
    Provides a description of the parameter.
    IsModifiable bool
    A Boolean value indicating whether the parameter can be modified.
    ParameterName string
    Specifies the name of the parameter.
    ParameterValue string
    Specifies the value of the parameter.
    allowedValues String
    Specifies the valid range of values for the parameter.
    applyMethod String
    Indicates when parameter updates are applied. Can be immediate or pending-reboot.
    applyType String
    Specifies the engine-specific parameter type.
    dataType String
    Specifies the valid data type for the parameter.
    description String
    Provides a description of the parameter.
    isModifiable Boolean
    A Boolean value indicating whether the parameter can be modified.
    parameterName String
    Specifies the name of the parameter.
    parameterValue String
    Specifies the value of the parameter.
    allowedValues string
    Specifies the valid range of values for the parameter.
    applyMethod string
    Indicates when parameter updates are applied. Can be immediate or pending-reboot.
    applyType string
    Specifies the engine-specific parameter type.
    dataType string
    Specifies the valid data type for the parameter.
    description string
    Provides a description of the parameter.
    isModifiable boolean
    A Boolean value indicating whether the parameter can be modified.
    parameterName string
    Specifies the name of the parameter.
    parameterValue string
    Specifies the value of the parameter.
    allowed_values str
    Specifies the valid range of values for the parameter.
    apply_method str
    Indicates when parameter updates are applied. Can be immediate or pending-reboot.
    apply_type str
    Specifies the engine-specific parameter type.
    data_type str
    Specifies the valid data type for the parameter.
    description str
    Provides a description of the parameter.
    is_modifiable bool
    A Boolean value indicating whether the parameter can be modified.
    parameter_name str
    Specifies the name of the parameter.
    parameter_value str
    Specifies the value of the parameter.
    allowedValues String
    Specifies the valid range of values for the parameter.
    applyMethod String
    Indicates when parameter updates are applied. Can be immediate or pending-reboot.
    applyType String
    Specifies the engine-specific parameter type.
    dataType String
    Specifies the valid data type for the parameter.
    description String
    Provides a description of the parameter.
    isModifiable Boolean
    A Boolean value indicating whether the parameter can be modified.
    parameterName String
    Specifies the name of the parameter.
    parameterValue String
    Specifies the value of the parameter.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native