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

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

    Using getDatabaseSnapshot

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabaseSnapshot(args: GetDatabaseSnapshotArgs, opts?: InvokeOptions): Promise<GetDatabaseSnapshotResult>
    function getDatabaseSnapshotOutput(args: GetDatabaseSnapshotOutputArgs, opts?: InvokeOptions): Output<GetDatabaseSnapshotResult>
    def get_database_snapshot(relational_database_snapshot_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDatabaseSnapshotResult
    def get_database_snapshot_output(relational_database_snapshot_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseSnapshotResult]
    func LookupDatabaseSnapshot(ctx *Context, args *LookupDatabaseSnapshotArgs, opts ...InvokeOption) (*LookupDatabaseSnapshotResult, error)
    func LookupDatabaseSnapshotOutput(ctx *Context, args *LookupDatabaseSnapshotOutputArgs, opts ...InvokeOption) LookupDatabaseSnapshotResultOutput

    > Note: This function is named LookupDatabaseSnapshot in the Go SDK.

    public static class GetDatabaseSnapshot 
    {
        public static Task<GetDatabaseSnapshotResult> InvokeAsync(GetDatabaseSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetDatabaseSnapshotResult> Invoke(GetDatabaseSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatabaseSnapshotResult> getDatabaseSnapshot(GetDatabaseSnapshotArgs args, InvokeOptions options)
    public static Output<GetDatabaseSnapshotResult> getDatabaseSnapshot(GetDatabaseSnapshotArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:lightsail:getDatabaseSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    RelationalDatabaseSnapshotName string
    The name for your new database snapshot.
    RelationalDatabaseSnapshotName string
    The name for your new database snapshot.
    relationalDatabaseSnapshotName String
    The name for your new database snapshot.
    relationalDatabaseSnapshotName string
    The name for your new database snapshot.
    relational_database_snapshot_name str
    The name for your new database snapshot.
    relationalDatabaseSnapshotName String
    The name for your new database snapshot.

    getDatabaseSnapshot Result

    The following output properties are available:

    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.
    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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    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.
    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.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    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.
    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.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    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.
    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.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    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.
    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.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    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.
    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.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    DatabaseSnapshotResourceType

    LocationProperties

    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

    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