Database class

Manages a Lightsail database. Use this resource to create and manage fully managed database instances with automated backups, monitoring, and maintenance in Lightsail.

> Note: Lightsail is currently only supported in a limited number of AWS Regions, please see "Regions and Availability Zones" for more details

Example Usage

Basic MySQL Blueprint

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lightsail.Database("example", {
    relationalDatabaseName: "example-database",
    availabilityZone: "us-east-1a",
    masterDatabaseName: "exampledb",
    masterPassword: "examplepassword123",
    masterUsername: "exampleuser",
    blueprintId: "mysql_8_0",
    bundleId: "micro_1_0",
});
import pulumi
import pulumi_aws as aws

example = aws.lightsail.Database("example",
    relational_database_name="example-database",
    availability_zone="us-east-1a",
    master_database_name="exampledb",
    master_password="examplepassword123",
    master_username="exampleuser",
    blueprint_id="mysql_8_0",
    bundle_id="micro_1_0")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LightSail.Database("example", new()
    {
        RelationalDatabaseName = "example-database",
        AvailabilityZone = "us-east-1a",
        MasterDatabaseName = "exampledb",
        MasterPassword = "examplepassword123",
        MasterUsername = "exampleuser",
        BlueprintId = "mysql_8_0",
        BundleId = "micro_1_0",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lightsail.NewDatabase(ctx, "example", &lightsail.DatabaseArgs{
			RelationalDatabaseName: pulumi.String("example-database"),
			AvailabilityZone:       pulumi.String("us-east-1a"),
			MasterDatabaseName:     pulumi.String("exampledb"),
			MasterPassword:         pulumi.String("examplepassword123"),
			MasterUsername:         pulumi.String("exampleuser"),
			BlueprintId:            pulumi.String("mysql_8_0"),
			BundleId:               pulumi.String("micro_1_0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lightsail_database" "example" {
  relational_database_name = "example-database"
  availability_zone        = "us-east-1a"
  master_database_name     = "exampledb"
  master_password          = "examplepassword123"
  master_username          = "exampleuser"
  blueprint_id             = "mysql_8_0"
  bundle_id                = "micro_1_0"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Database;
import com.pulumi.aws.lightsail.DatabaseArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Database("example", DatabaseArgs.builder()
            .relationalDatabaseName("example-database")
            .availabilityZone("us-east-1a")
            .masterDatabaseName("exampledb")
            .masterPassword("examplepassword123")
            .masterUsername("exampleuser")
            .blueprintId("mysql_8_0")
            .bundleId("micro_1_0")
            .build());

    }
}
resources:
  example:
    type: aws:lightsail:Database
    properties:
      relationalDatabaseName: example-database
      availabilityZone: us-east-1a
      masterDatabaseName: exampledb
      masterPassword: examplepassword123
      masterUsername: exampleuser
      blueprintId: mysql_8_0
      bundleId: micro_1_0

Basic PostgreSQL Blueprint

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lightsail.Database("example", {
    relationalDatabaseName: "example-database",
    availabilityZone: "us-east-1a",
    masterDatabaseName: "exampledb",
    masterPassword: "examplepassword123",
    masterUsername: "exampleuser",
    blueprintId: "postgres_12",
    bundleId: "micro_1_0",
});
import pulumi
import pulumi_aws as aws

example = aws.lightsail.Database("example",
    relational_database_name="example-database",
    availability_zone="us-east-1a",
    master_database_name="exampledb",
    master_password="examplepassword123",
    master_username="exampleuser",
    blueprint_id="postgres_12",
    bundle_id="micro_1_0")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LightSail.Database("example", new()
    {
        RelationalDatabaseName = "example-database",
        AvailabilityZone = "us-east-1a",
        MasterDatabaseName = "exampledb",
        MasterPassword = "examplepassword123",
        MasterUsername = "exampleuser",
        BlueprintId = "postgres_12",
        BundleId = "micro_1_0",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lightsail.NewDatabase(ctx, "example", &lightsail.DatabaseArgs{
			RelationalDatabaseName: pulumi.String("example-database"),
			AvailabilityZone:       pulumi.String("us-east-1a"),
			MasterDatabaseName:     pulumi.String("exampledb"),
			MasterPassword:         pulumi.String("examplepassword123"),
			MasterUsername:         pulumi.String("exampleuser"),
			BlueprintId:            pulumi.String("postgres_12"),
			BundleId:               pulumi.String("micro_1_0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lightsail_database" "example" {
  relational_database_name = "example-database"
  availability_zone        = "us-east-1a"
  master_database_name     = "exampledb"
  master_password          = "examplepassword123"
  master_username          = "exampleuser"
  blueprint_id             = "postgres_12"
  bundle_id                = "micro_1_0"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Database;
import com.pulumi.aws.lightsail.DatabaseArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Database("example", DatabaseArgs.builder()
            .relationalDatabaseName("example-database")
            .availabilityZone("us-east-1a")
            .masterDatabaseName("exampledb")
            .masterPassword("examplepassword123")
            .masterUsername("exampleuser")
            .blueprintId("postgres_12")
            .bundleId("micro_1_0")
            .build());

    }
}
resources:
  example:
    type: aws:lightsail:Database
    properties:
      relationalDatabaseName: example-database
      availabilityZone: us-east-1a
      masterDatabaseName: exampledb
      masterPassword: examplepassword123
      masterUsername: exampleuser
      blueprintId: postgres_12
      bundleId: micro_1_0

Custom Backup and Maintenance Windows

Below is an example that sets a custom backup and maintenance window. Times are specified in UTC. This example will allow daily backups to take place between 16:00 and 16:30 each day. This example also requires any maintenance tasks (anything that would cause an outage, including changing some attributes) to take place on Tuesdays between 17:00 and 17:30. An action taken against this database that would cause an outage will wait until this time window to make the requested changes.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lightsail.Database("example", {
    relationalDatabaseName: "example-database",
    availabilityZone: "us-east-1a",
    masterDatabaseName: "exampledb",
    masterPassword: "examplepassword123",
    masterUsername: "exampleuser",
    blueprintId: "postgres_12",
    bundleId: "micro_1_0",
    preferredBackupWindow: "16:00-16:30",
    preferredMaintenanceWindow: "Tue:17:00-Tue:17:30",
});
import pulumi
import pulumi_aws as aws

example = aws.lightsail.Database("example",
    relational_database_name="example-database",
    availability_zone="us-east-1a",
    master_database_name="exampledb",
    master_password="examplepassword123",
    master_username="exampleuser",
    blueprint_id="postgres_12",
    bundle_id="micro_1_0",
    preferred_backup_window="16:00-16:30",
    preferred_maintenance_window="Tue:17:00-Tue:17:30")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LightSail.Database("example", new()
    {
        RelationalDatabaseName = "example-database",
        AvailabilityZone = "us-east-1a",
        MasterDatabaseName = "exampledb",
        MasterPassword = "examplepassword123",
        MasterUsername = "exampleuser",
        BlueprintId = "postgres_12",
        BundleId = "micro_1_0",
        PreferredBackupWindow = "16:00-16:30",
        PreferredMaintenanceWindow = "Tue:17:00-Tue:17:30",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lightsail.NewDatabase(ctx, "example", &lightsail.DatabaseArgs{
			RelationalDatabaseName:     pulumi.String("example-database"),
			AvailabilityZone:           pulumi.String("us-east-1a"),
			MasterDatabaseName:         pulumi.String("exampledb"),
			MasterPassword:             pulumi.String("examplepassword123"),
			MasterUsername:             pulumi.String("exampleuser"),
			BlueprintId:                pulumi.String("postgres_12"),
			BundleId:                   pulumi.String("micro_1_0"),
			PreferredBackupWindow:      pulumi.String("16:00-16:30"),
			PreferredMaintenanceWindow: pulumi.String("Tue:17:00-Tue:17:30"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lightsail_database" "example" {
  relational_database_name     = "example-database"
  availability_zone            = "us-east-1a"
  master_database_name         = "exampledb"
  master_password              = "examplepassword123"
  master_username              = "exampleuser"
  blueprint_id                 = "postgres_12"
  bundle_id                    = "micro_1_0"
  preferred_backup_window      = "16:00-16:30"
  preferred_maintenance_window = "Tue:17:00-Tue:17:30"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Database;
import com.pulumi.aws.lightsail.DatabaseArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Database("example", DatabaseArgs.builder()
            .relationalDatabaseName("example-database")
            .availabilityZone("us-east-1a")
            .masterDatabaseName("exampledb")
            .masterPassword("examplepassword123")
            .masterUsername("exampleuser")
            .blueprintId("postgres_12")
            .bundleId("micro_1_0")
            .preferredBackupWindow("16:00-16:30")
            .preferredMaintenanceWindow("Tue:17:00-Tue:17:30")
            .build());

    }
}
resources:
  example:
    type: aws:lightsail:Database
    properties:
      relationalDatabaseName: example-database
      availabilityZone: us-east-1a
      masterDatabaseName: exampledb
      masterPassword: examplepassword123
      masterUsername: exampleuser
      blueprintId: postgres_12
      bundleId: micro_1_0
      preferredBackupWindow: 16:00-16:30
      preferredMaintenanceWindow: Tue:17:00-Tue:17:30

Final Snapshots

To enable creating a final snapshot of your database on deletion, use the finalSnapshotName argument to provide a name to be used for the snapshot.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lightsail.Database("example", {
    relationalDatabaseName: "example-database",
    availabilityZone: "us-east-1a",
    masterDatabaseName: "exampledb",
    masterPassword: "examplepassword123",
    masterUsername: "exampleuser",
    blueprintId: "postgres_12",
    bundleId: "micro_1_0",
    preferredBackupWindow: "16:00-16:30",
    preferredMaintenanceWindow: "Tue:17:00-Tue:17:30",
    finalSnapshotName: "example-final-snapshot",
});
import pulumi
import pulumi_aws as aws

example = aws.lightsail.Database("example",
    relational_database_name="example-database",
    availability_zone="us-east-1a",
    master_database_name="exampledb",
    master_password="examplepassword123",
    master_username="exampleuser",
    blueprint_id="postgres_12",
    bundle_id="micro_1_0",
    preferred_backup_window="16:00-16:30",
    preferred_maintenance_window="Tue:17:00-Tue:17:30",
    final_snapshot_name="example-final-snapshot")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LightSail.Database("example", new()
    {
        RelationalDatabaseName = "example-database",
        AvailabilityZone = "us-east-1a",
        MasterDatabaseName = "exampledb",
        MasterPassword = "examplepassword123",
        MasterUsername = "exampleuser",
        BlueprintId = "postgres_12",
        BundleId = "micro_1_0",
        PreferredBackupWindow = "16:00-16:30",
        PreferredMaintenanceWindow = "Tue:17:00-Tue:17:30",
        FinalSnapshotName = "example-final-snapshot",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lightsail.NewDatabase(ctx, "example", &lightsail.DatabaseArgs{
			RelationalDatabaseName:     pulumi.String("example-database"),
			AvailabilityZone:           pulumi.String("us-east-1a"),
			MasterDatabaseName:         pulumi.String("exampledb"),
			MasterPassword:             pulumi.String("examplepassword123"),
			MasterUsername:             pulumi.String("exampleuser"),
			BlueprintId:                pulumi.String("postgres_12"),
			BundleId:                   pulumi.String("micro_1_0"),
			PreferredBackupWindow:      pulumi.String("16:00-16:30"),
			PreferredMaintenanceWindow: pulumi.String("Tue:17:00-Tue:17:30"),
			FinalSnapshotName:          pulumi.String("example-final-snapshot"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lightsail_database" "example" {
  relational_database_name     = "example-database"
  availability_zone            = "us-east-1a"
  master_database_name         = "exampledb"
  master_password              = "examplepassword123"
  master_username              = "exampleuser"
  blueprint_id                 = "postgres_12"
  bundle_id                    = "micro_1_0"
  preferred_backup_window      = "16:00-16:30"
  preferred_maintenance_window = "Tue:17:00-Tue:17:30"
  final_snapshot_name          = "example-final-snapshot"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Database;
import com.pulumi.aws.lightsail.DatabaseArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Database("example", DatabaseArgs.builder()
            .relationalDatabaseName("example-database")
            .availabilityZone("us-east-1a")
            .masterDatabaseName("exampledb")
            .masterPassword("examplepassword123")
            .masterUsername("exampleuser")
            .blueprintId("postgres_12")
            .bundleId("micro_1_0")
            .preferredBackupWindow("16:00-16:30")
            .preferredMaintenanceWindow("Tue:17:00-Tue:17:30")
            .finalSnapshotName("example-final-snapshot")
            .build());

    }
}
resources:
  example:
    type: aws:lightsail:Database
    properties:
      relationalDatabaseName: example-database
      availabilityZone: us-east-1a
      masterDatabaseName: exampledb
      masterPassword: examplepassword123
      masterUsername: exampleuser
      blueprintId: postgres_12
      bundleId: micro_1_0
      preferredBackupWindow: 16:00-16:30
      preferredMaintenanceWindow: Tue:17:00-Tue:17:30
      finalSnapshotName: example-final-snapshot

Apply Immediately

To enable applying changes immediately instead of waiting for a maintenance window, use the applyImmediately argument.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lightsail.Database("example", {
    relationalDatabaseName: "example-database",
    availabilityZone: "us-east-1a",
    masterDatabaseName: "exampledb",
    masterPassword: "examplepassword123",
    masterUsername: "exampleuser",
    blueprintId: "postgres_12",
    bundleId: "micro_1_0",
    applyImmediately: true,
});
import pulumi
import pulumi_aws as aws

example = aws.lightsail.Database("example",
    relational_database_name="example-database",
    availability_zone="us-east-1a",
    master_database_name="exampledb",
    master_password="examplepassword123",
    master_username="exampleuser",
    blueprint_id="postgres_12",
    bundle_id="micro_1_0",
    apply_immediately=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LightSail.Database("example", new()
    {
        RelationalDatabaseName = "example-database",
        AvailabilityZone = "us-east-1a",
        MasterDatabaseName = "exampledb",
        MasterPassword = "examplepassword123",
        MasterUsername = "exampleuser",
        BlueprintId = "postgres_12",
        BundleId = "micro_1_0",
        ApplyImmediately = true,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lightsail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lightsail.NewDatabase(ctx, "example", &lightsail.DatabaseArgs{
			RelationalDatabaseName: pulumi.String("example-database"),
			AvailabilityZone:       pulumi.String("us-east-1a"),
			MasterDatabaseName:     pulumi.String("exampledb"),
			MasterPassword:         pulumi.String("examplepassword123"),
			MasterUsername:         pulumi.String("exampleuser"),
			BlueprintId:            pulumi.String("postgres_12"),
			BundleId:               pulumi.String("micro_1_0"),
			ApplyImmediately:       pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lightsail_database" "example" {
  relational_database_name = "example-database"
  availability_zone        = "us-east-1a"
  master_database_name     = "exampledb"
  master_password          = "examplepassword123"
  master_username          = "exampleuser"
  blueprint_id             = "postgres_12"
  bundle_id                = "micro_1_0"
  apply_immediately        = true
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lightsail.Database;
import com.pulumi.aws.lightsail.DatabaseArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Database("example", DatabaseArgs.builder()
            .relationalDatabaseName("example-database")
            .availabilityZone("us-east-1a")
            .masterDatabaseName("exampledb")
            .masterPassword("examplepassword123")
            .masterUsername("exampleuser")
            .blueprintId("postgres_12")
            .bundleId("micro_1_0")
            .applyImmediately(true)
            .build());

    }
}
resources:
  example:
    type: aws:lightsail:Database
    properties:
      relationalDatabaseName: example-database
      availabilityZone: us-east-1a
      masterDatabaseName: exampledb
      masterPassword: examplepassword123
      masterUsername: exampleuser
      blueprintId: postgres_12
      bundleId: micro_1_0
      applyImmediately: true

Import

Using pulumi import, import Lightsail Databases using their name. For example:

$ pulumi import aws:lightsail/database:Database example example-database

Constructors

Database(String name, {DatabaseArgs? args, CustomResourceOptions? options})
Creates a new Database. name The Pulumi resource name. args Arguments used to configure this Database. The set of arguments for Database. options Resource options controlling this resource's behavior.
Database.reference(String urn)
Creates a typed reference to an existing Database resource.

Properties

applyImmediately ↔ Output<bool>
Whether to apply changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.
latefinal
arn ↔ Output<String>
ARN of the database (matches id).
latefinal
availabilityZone ↔ Output<String>
Availability Zone in which to create your database. Use the us-east-2a case-sensitive format.
latefinal
backupRetentionEnabled ↔ Output<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.
latefinal
blueprintId ↔ Output<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
latefinal
bundleId ↔ Output<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.
latefinal
caCertificateIdentifier ↔ Output<String>
Certificate associated with the database.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
cpuCount ↔ Output<int>
Number of vCPUs for the database.
latefinal
createdAt ↔ Output<String>
Date and time when the database was created.
latefinal
diskSize ↔ Output<double>
Size of the disk for the database.
latefinal
engine ↔ Output<String>
Database software (for example, MySQL).
latefinal
engineVersion ↔ Output<String>
Database engine version (for example, 5.7.23).
latefinal
finalSnapshotName ↔ Output<String?>
Name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
masterDatabaseName ↔ Output<String>
Name of the master database created when the Lightsail database resource is created.
latefinal
masterEndpointAddress ↔ Output<String>
Master endpoint FQDN for the database.
latefinal
masterEndpointPort ↔ Output<int>
Master endpoint network port for the database.
latefinal
masterPassword ↔ Output<String>
Password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".
latefinal
masterUsername ↔ Output<String>
Master user name for your database.
latefinal
preferredBackupWindow ↔ Output<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).
latefinal
preferredMaintenanceWindow ↔ Output<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
latefinal
publiclyAccessible ↔ Output<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.
latefinal
ramSize ↔ Output<double>
Amount of RAM in GB for the database.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
relationalDatabaseName ↔ Output<String>
Name to use for your Lightsail database resource. Names be unique within each AWS Region in your Lightsail account.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryAvailabilityZone ↔ Output<String>
Secondary Availability Zone of a high availability database. The secondary database is used for failover support of a high availability database.
latefinal
skipFinalSnapshot ↔ Output<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.
latefinal
supportCode ↔ Output<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.
latefinal
tags ↔ Output<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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DatabaseState? state, CustomResourceOptions? options}) → Database
Gets an existing Database resource's state with the given name and id.