1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. DatabaseSnapshot

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

AWS Cloud Control v1.53.0 published on Monday, Feb 9, 2026 by Pulumi
aws-native logo

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

AWS Cloud Control v1.53.0 published on Monday, Feb 9, 2026 by Pulumi

    Resource Type definition for AWS::Lightsail::DatabaseSnapshot

    Create DatabaseSnapshot Resource

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

    Constructor syntax

    new DatabaseSnapshot(name: string, args: DatabaseSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def DatabaseSnapshot(resource_name: str,
                         args: DatabaseSnapshotArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def DatabaseSnapshot(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         relational_database_name: Optional[str] = None,
                         relational_database_snapshot_name: Optional[str] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDatabaseSnapshot(ctx *Context, name string, args DatabaseSnapshotArgs, opts ...ResourceOption) (*DatabaseSnapshot, error)
    public DatabaseSnapshot(string name, DatabaseSnapshotArgs args, CustomResourceOptions? opts = null)
    public DatabaseSnapshot(String name, DatabaseSnapshotArgs args)
    public DatabaseSnapshot(String name, DatabaseSnapshotArgs args, CustomResourceOptions options)
    
    type: aws-native:lightsail:DatabaseSnapshot
    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 DatabaseSnapshotArgs
    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 DatabaseSnapshotArgs
    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 DatabaseSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseSnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DatabaseSnapshot 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 DatabaseSnapshot resource accepts the following input properties:

    RelationalDatabaseName string
    The name of the database on which to base your new snapshot.
    RelationalDatabaseSnapshotName string
    The name for your new database snapshot.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    RelationalDatabaseName string
    The name of the database on which to base your new snapshot.
    RelationalDatabaseSnapshotName string
    The name for your new database snapshot.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    relationalDatabaseName String
    The name of the database on which to base your new snapshot.
    relationalDatabaseSnapshotName String
    The name for your new database snapshot.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    relationalDatabaseName string
    The name of the database on which to base your new snapshot.
    relationalDatabaseSnapshotName string
    The name for your new database snapshot.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    relational_database_name str
    The name of the database on which to base your new snapshot.
    relational_database_snapshot_name str
    The name for your new database snapshot.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    relationalDatabaseName String
    The name of the database on which to base your new snapshot.
    relationalDatabaseSnapshotName String
    The name for your new database snapshot.
    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 DatabaseSnapshot resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the database snapshot.
    CreatedAt string
    The timestamp when the database snapshot was created.
    Engine string
    The software of the database snapshot (for example, MySQL).
    EngineVersion string
    The database engine version for the database snapshot (for example, 5.7.23).
    FromRelationalDatabaseArn string
    The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    FromRelationalDatabaseBlueprintId string
    The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
    FromRelationalDatabaseBundleId string
    The bundle ID of the database from which the database snapshot was created.
    FromRelationalDatabaseName string
    The name of the source database from which the database snapshot was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location Pulumi.AwsNative.Lightsail.Outputs.LocationProperties
    The Region name and Availability Zone where the database snapshot is located.
    Name string
    The name of the database snapshot.
    ResourceType Pulumi.AwsNative.Lightsail.DatabaseSnapshotResourceType
    The Lightsail resource type.
    SizeInGb int
    The size of the disk in GB (for example, 32) for the database snapshot.
    State string
    The state of the database snapshot.
    SupportCode string
    The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    Arn string
    The Amazon Resource Name (ARN) of the database snapshot.
    CreatedAt string
    The timestamp when the database snapshot was created.
    Engine string
    The software of the database snapshot (for example, MySQL).
    EngineVersion string
    The database engine version for the database snapshot (for example, 5.7.23).
    FromRelationalDatabaseArn string
    The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    FromRelationalDatabaseBlueprintId string
    The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
    FromRelationalDatabaseBundleId string
    The bundle ID of the database from which the database snapshot was created.
    FromRelationalDatabaseName string
    The name of the source database from which the database snapshot was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location LocationProperties
    The Region name and Availability Zone where the database snapshot is located.
    Name string
    The name of the database snapshot.
    ResourceType DatabaseSnapshotResourceType
    The Lightsail resource type.
    SizeInGb int
    The size of the disk in GB (for example, 32) for the database snapshot.
    State string
    The state of the database snapshot.
    SupportCode string
    The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    arn String
    The Amazon Resource Name (ARN) of the database snapshot.
    createdAt String
    The timestamp when the database snapshot was created.
    engine String
    The software of the database snapshot (for example, MySQL).
    engineVersion String
    The database engine version for the database snapshot (for example, 5.7.23).
    fromRelationalDatabaseArn String
    The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    fromRelationalDatabaseBlueprintId String
    The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
    fromRelationalDatabaseBundleId String
    The bundle ID of the database from which the database snapshot was created.
    fromRelationalDatabaseName String
    The name of the source database from which the database snapshot was created.
    id String
    The provider-assigned unique ID for this managed resource.
    location LocationProperties
    The Region name and Availability Zone where the database snapshot is located.
    name String
    The name of the database snapshot.
    resourceType DatabaseSnapshotResourceType
    The Lightsail resource type.
    sizeInGb Integer
    The size of the disk in GB (for example, 32) for the database snapshot.
    state String
    The state of the database snapshot.
    supportCode String
    The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    arn string
    The Amazon Resource Name (ARN) of the database snapshot.
    createdAt string
    The timestamp when the database snapshot was created.
    engine string
    The software of the database snapshot (for example, MySQL).
    engineVersion string
    The database engine version for the database snapshot (for example, 5.7.23).
    fromRelationalDatabaseArn string
    The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    fromRelationalDatabaseBlueprintId string
    The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
    fromRelationalDatabaseBundleId string
    The bundle ID of the database from which the database snapshot was created.
    fromRelationalDatabaseName string
    The name of the source database from which the database snapshot was created.
    id string
    The provider-assigned unique ID for this managed resource.
    location LocationProperties
    The Region name and Availability Zone where the database snapshot is located.
    name string
    The name of the database snapshot.
    resourceType DatabaseSnapshotResourceType
    The Lightsail resource type.
    sizeInGb number
    The size of the disk in GB (for example, 32) for the database snapshot.
    state string
    The state of the database snapshot.
    supportCode string
    The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    arn str
    The Amazon Resource Name (ARN) of the database snapshot.
    created_at str
    The timestamp when the database snapshot was created.
    engine str
    The software of the database snapshot (for example, MySQL).
    engine_version str
    The database engine version for the database snapshot (for example, 5.7.23).
    from_relational_database_arn str
    The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    from_relational_database_blueprint_id str
    The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
    from_relational_database_bundle_id str
    The bundle ID of the database from which the database snapshot was created.
    from_relational_database_name str
    The name of the source database from which the database snapshot was created.
    id str
    The provider-assigned unique ID for this managed resource.
    location LocationProperties
    The Region name and Availability Zone where the database snapshot is located.
    name str
    The name of the database snapshot.
    resource_type DatabaseSnapshotResourceType
    The Lightsail resource type.
    size_in_gb int
    The size of the disk in GB (for example, 32) for the database snapshot.
    state str
    The state of the database snapshot.
    support_code str
    The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    arn String
    The Amazon Resource Name (ARN) of the database snapshot.
    createdAt String
    The timestamp when the database snapshot was created.
    engine String
    The software of the database snapshot (for example, MySQL).
    engineVersion String
    The database engine version for the database snapshot (for example, 5.7.23).
    fromRelationalDatabaseArn String
    The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    fromRelationalDatabaseBlueprintId String
    The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
    fromRelationalDatabaseBundleId String
    The bundle ID of the database from which the database snapshot was created.
    fromRelationalDatabaseName String
    The name of the source database from which the database snapshot was created.
    id String
    The provider-assigned unique ID for this managed resource.
    location Property Map
    The Region name and Availability Zone where the database snapshot is located.
    name String
    The name of the database snapshot.
    resourceType "RelationalDatabaseSnapshot"
    The Lightsail resource type.
    sizeInGb Number
    The size of the disk in GB (for example, 32) for the database snapshot.
    state String
    The state of the database snapshot.
    supportCode String
    The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.

    Supporting Types

    DatabaseSnapshotResourceType, DatabaseSnapshotResourceTypeArgs

    RelationalDatabaseSnapshot
    RelationalDatabaseSnapshot
    DatabaseSnapshotResourceTypeRelationalDatabaseSnapshot
    RelationalDatabaseSnapshot
    RelationalDatabaseSnapshot
    RelationalDatabaseSnapshot
    RelationalDatabaseSnapshot
    RelationalDatabaseSnapshot
    RELATIONAL_DATABASE_SNAPSHOT
    RelationalDatabaseSnapshot
    "RelationalDatabaseSnapshot"
    RelationalDatabaseSnapshot

    LocationProperties, LocationPropertiesArgs

    The AWS Region and Availability Zone where the disk snapshot was created.
    AvailabilityZone string
    The Availability Zone where the disk snapshot was created.
    RegionName string
    The AWS Region where the disk snapshot was created.
    AvailabilityZone string
    The Availability Zone where the disk snapshot was created.
    RegionName string
    The AWS Region where the disk snapshot was created.
    availabilityZone String
    The Availability Zone where the disk snapshot was created.
    regionName String
    The AWS Region where the disk snapshot was created.
    availabilityZone string
    The Availability Zone where the disk snapshot was created.
    regionName string
    The AWS Region where the disk snapshot was created.
    availability_zone str
    The Availability Zone where the disk snapshot was created.
    region_name str
    The AWS Region where the disk snapshot was created.
    availabilityZone String
    The Availability Zone where the disk snapshot was created.
    regionName String
    The AWS Region where the disk snapshot was created.

    Tag, TagArgs

    A set of tags to apply to the resource.
    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.53.0 published on Monday, Feb 9, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate