aws-native.lightsail.getDiskSnapshot

AWS Cloud Control v1.38.0, Nov 5 25

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

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

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

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getDiskSnapshot

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 getDiskSnapshot(args: GetDiskSnapshotArgs, opts?: InvokeOptions): Promise<GetDiskSnapshotResult>
function getDiskSnapshotOutput(args: GetDiskSnapshotOutputArgs, opts?: InvokeOptions): Output<GetDiskSnapshotResult>

def get_disk_snapshot(disk_snapshot_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDiskSnapshotResult
def get_disk_snapshot_output(disk_snapshot_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDiskSnapshotResult]

func LookupDiskSnapshot(ctx *Context, args *LookupDiskSnapshotArgs, opts ...InvokeOption) (*LookupDiskSnapshotResult, error)
func LookupDiskSnapshotOutput(ctx *Context, args *LookupDiskSnapshotOutputArgs, opts ...InvokeOption) LookupDiskSnapshotResultOutput

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

public static class GetDiskSnapshot 
{
    public static Task<GetDiskSnapshotResult> InvokeAsync(GetDiskSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetDiskSnapshotResult> Invoke(GetDiskSnapshotInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDiskSnapshotResult> getDiskSnapshot(GetDiskSnapshotArgs args, InvokeOptions options)
public static Output<GetDiskSnapshotResult> getDiskSnapshot(GetDiskSnapshotArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:lightsail:getDiskSnapshot
  arguments:
    # arguments dictionary

The following arguments are supported:

DiskSnapshotName string: The name of the disk snapshot (e.g., my-disk-snapshot).

DiskSnapshotName string: The name of the disk snapshot (e.g., my-disk-snapshot).

diskSnapshotName String: The name of the disk snapshot (e.g., my-disk-snapshot).

diskSnapshotName string: The name of the disk snapshot (e.g., my-disk-snapshot).

disk_snapshot_name str: The name of the disk snapshot (e.g., my-disk-snapshot).

diskSnapshotName String: The name of the disk snapshot (e.g., my-disk-snapshot).

getDiskSnapshot Result

The following output properties are available:

CreatedAt string: The timestamp when the disk snapshot was created.
DiskSnapshotArn string: The Amazon Resource Name (ARN) of the disk snapshot.
FromDiskName string: The name of the source disk from which the disk snapshot was created.
IsFromAutoSnapshot bool: A Boolean value indicating whether the snapshot was created from an automatic snapshot.
Location Pulumi.AwsNative.Lightsail.Outputs.LocationProperties: The AWS Region and Availability Zone where the disk snapshot was created.
Progress string: The progress of the disk snapshot creation operation.
ResourceType Pulumi.AwsNative.Lightsail.DiskSnapshotResourceType: The Lightsail resource type (DiskSnapshot).
SizeInGb int: The size of the disk snapshot in GB.
State Pulumi.AwsNative.Lightsail.DiskSnapshotState: The status of the disk snapshot operation.
SupportCode string: The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail.
Tags List<Pulumi.AwsNative.Outputs.Tag>: An array of key-value pairs to apply to this resource.

CreatedAt string: The timestamp when the disk snapshot was created.
DiskSnapshotArn string: The Amazon Resource Name (ARN) of the disk snapshot.
FromDiskName string: The name of the source disk from which the disk snapshot was created.
IsFromAutoSnapshot bool: A Boolean value indicating whether the snapshot was created from an automatic snapshot.
Location LocationProperties: The AWS Region and Availability Zone where the disk snapshot was created.
Progress string: The progress of the disk snapshot creation operation.
ResourceType DiskSnapshotResourceType: The Lightsail resource type (DiskSnapshot).
SizeInGb int: The size of the disk snapshot in GB.
State DiskSnapshotStateEnum: The status of the disk snapshot operation.
SupportCode string: The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail.
Tags Tag: An array of key-value pairs to apply to this resource.

createdAt String: The timestamp when the disk snapshot was created.
diskSnapshotArn String: The Amazon Resource Name (ARN) of the disk snapshot.
fromDiskName String: The name of the source disk from which the disk snapshot was created.
isFromAutoSnapshot Boolean: A Boolean value indicating whether the snapshot was created from an automatic snapshot.
location LocationProperties: The AWS Region and Availability Zone where the disk snapshot was created.
progress String: The progress of the disk snapshot creation operation.
resourceType DiskSnapshotResourceType: The Lightsail resource type (DiskSnapshot).
sizeInGb Integer: The size of the disk snapshot in GB.
state DiskSnapshotState: The status of the disk snapshot operation.
supportCode String: The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail.
tags List<Tag>: An array of key-value pairs to apply to this resource.

createdAt string: The timestamp when the disk snapshot was created.
diskSnapshotArn string: The Amazon Resource Name (ARN) of the disk snapshot.
fromDiskName string: The name of the source disk from which the disk snapshot was created.
isFromAutoSnapshot boolean: A Boolean value indicating whether the snapshot was created from an automatic snapshot.
location LocationProperties: The AWS Region and Availability Zone where the disk snapshot was created.
progress string: The progress of the disk snapshot creation operation.
resourceType DiskSnapshotResourceType: The Lightsail resource type (DiskSnapshot).
sizeInGb number: The size of the disk snapshot in GB.
state DiskSnapshotState: The status of the disk snapshot operation.
supportCode string: The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail.
tags Tag[]: An array of key-value pairs to apply to this resource.

created_at str: The timestamp when the disk snapshot was created.
disk_snapshot_arn str: The Amazon Resource Name (ARN) of the disk snapshot.
from_disk_name str: The name of the source disk from which the disk snapshot was created.
is_from_auto_snapshot bool: A Boolean value indicating whether the snapshot was created from an automatic snapshot.
location LocationProperties: The AWS Region and Availability Zone where the disk snapshot was created.
progress str: The progress of the disk snapshot creation operation.
resource_type DiskSnapshotResourceType: The Lightsail resource type (DiskSnapshot).
size_in_gb int: The size of the disk snapshot in GB.
state DiskSnapshotState: The status of the disk snapshot operation.
support_code str: The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail.
tags Sequence[root_Tag]: An array of key-value pairs to apply to this resource.

createdAt String: The timestamp when the disk snapshot was created.
diskSnapshotArn String: The Amazon Resource Name (ARN) of the disk snapshot.
fromDiskName String: The name of the source disk from which the disk snapshot was created.
isFromAutoSnapshot Boolean: A Boolean value indicating whether the snapshot was created from an automatic snapshot.
location Property Map: The AWS Region and Availability Zone where the disk snapshot was created.
progress String: The progress of the disk snapshot creation operation.
resourceType "DiskSnapshot": The Lightsail resource type (DiskSnapshot).
sizeInGb Number: The size of the disk snapshot in GB.
state "pending" | "completed" | "error" | "unknown": The status of the disk snapshot operation.
supportCode String: The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail.
tags List<Property Map>: An array of key-value pairs to apply to this resource.

Supporting Types

DiskSnapshotResourceType

DiskSnapshotState

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.