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

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

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.DiskSnapshot

Get Started
aws-native logo

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

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Lightsail::DiskSnapshot

    Create DiskSnapshot Resource

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

    Constructor syntax

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

@overload
def DiskSnapshot(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 disk_name: Optional[str] = None,
                 disk_snapshot_name: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDiskSnapshot(ctx *Context, name string, args DiskSnapshotArgs, opts ...ResourceOption) (*DiskSnapshot, error)
    public DiskSnapshot(string name, DiskSnapshotArgs args, CustomResourceOptions? opts = null)
    public DiskSnapshot(String name, DiskSnapshotArgs args)
public DiskSnapshot(String name, DiskSnapshotArgs args, CustomResourceOptions options)

    type: aws-native:lightsail:DiskSnapshot
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 DiskSnapshotArgs
    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 DiskSnapshotArgs
    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 DiskSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DiskSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DiskSnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    DiskName string
    The name of the source disk from which the snapshot was created.
    DiskSnapshotName string
    The name of the disk snapshot (e.g., my-disk-snapshot).
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    DiskName string
    The name of the source disk from which the snapshot was created.
    DiskSnapshotName string
    The name of the disk snapshot (e.g., my-disk-snapshot).
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    diskName String
    The name of the source disk from which the snapshot was created.
    diskSnapshotName String
    The name of the disk snapshot (e.g., my-disk-snapshot).
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    diskName string
    The name of the source disk from which the snapshot was created.
    diskSnapshotName string
    The name of the disk snapshot (e.g., my-disk-snapshot).
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    disk_name str
    The name of the source disk from which the snapshot was created.
    disk_snapshot_name str
    The name of the disk snapshot (e.g., my-disk-snapshot).
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    diskName String
    The name of the source disk from which the snapshot was created.
    diskSnapshotName String
    The name of the disk snapshot (e.g., my-disk-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 DiskSnapshot resource produces the following output properties:

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Supporting Types

    DiskSnapshotResourceType, DiskSnapshotResourceTypeArgs

    DiskSnapshot
    DiskSnapshot
    DiskSnapshotResourceTypeDiskSnapshot
    DiskSnapshot
    DiskSnapshot
    DiskSnapshot
    DiskSnapshot
    DiskSnapshot
    DISK_SNAPSHOT
    DiskSnapshot
    "DiskSnapshot"
    DiskSnapshot

    DiskSnapshotState, DiskSnapshotStateArgs

    Pending
    pending
    Completed
    completed
    Error
    error
    Unknown
    unknown
    DiskSnapshotStatePending
    pending
    DiskSnapshotStateCompleted
    completed
    DiskSnapshotStateError
    error
    DiskSnapshotStateUnknown
    unknown
    Pending
    pending
    Completed
    completed
    Error
    error
    Unknown
    unknown
    Pending
    pending
    Completed
    completed
    Error
    error
    Unknown
    unknown
    PENDING
    pending
    COMPLETED
    completed
    ERROR
    error
    UNKNOWN
    unknown
    "pending"
    pending
    "completed"
    completed
    "error"
    error
    "unknown"
    unknown

    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.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate