Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. getInstanceSnapshot

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

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.getInstanceSnapshot

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Lightsail::InstanceSnapshot

    Using getInstanceSnapshot

    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 getInstanceSnapshot(args: GetInstanceSnapshotArgs, opts?: InvokeOptions): Promise<GetInstanceSnapshotResult>
function getInstanceSnapshotOutput(args: GetInstanceSnapshotOutputArgs, opts?: InvokeOptions): Output<GetInstanceSnapshotResult>
    def get_instance_snapshot(instance_snapshot_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetInstanceSnapshotResult
def get_instance_snapshot_output(instance_snapshot_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetInstanceSnapshotResult]
    func LookupInstanceSnapshot(ctx *Context, args *LookupInstanceSnapshotArgs, opts ...InvokeOption) (*LookupInstanceSnapshotResult, error)
func LookupInstanceSnapshotOutput(ctx *Context, args *LookupInstanceSnapshotOutputArgs, opts ...InvokeOption) LookupInstanceSnapshotResultOutput

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

    public static class GetInstanceSnapshot 
{
    public static Task<GetInstanceSnapshotResult> InvokeAsync(GetInstanceSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceSnapshotResult> Invoke(GetInstanceSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceSnapshotResult> getInstanceSnapshot(GetInstanceSnapshotArgs args, InvokeOptions options)
public static Output<GetInstanceSnapshotResult> getInstanceSnapshot(GetInstanceSnapshotArgs args, InvokeOptions options)

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

    The following arguments are supported:

    InstanceSnapshotName string
    The name of the snapshot.
    InstanceSnapshotName string
    The name of the snapshot.
    instanceSnapshotName String
    The name of the snapshot.
    instanceSnapshotName string
    The name of the snapshot.
    instance_snapshot_name str
    The name of the snapshot.
    instanceSnapshotName String
    The name of the snapshot.

    getInstanceSnapshot Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the snapshot.
    FromInstanceArn string
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created.
    FromInstanceName string
    The instance from which the snapshot was created.
    IsFromAutoSnapshot bool
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.
    Location Pulumi.AwsNative.Lightsail.Outputs.InstanceSnapshotLocation
    ResourceType string
    The type of resource (usually InstanceSnapshot).
    SizeInGb int
    The size in GB of the SSD
    State string
    The state the snapshot is in.
    SupportCode string
    Support code to help identify any issues
    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 snapshot.
    FromInstanceArn string
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created.
    FromInstanceName string
    The instance from which the snapshot was created.
    IsFromAutoSnapshot bool
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.
    Location InstanceSnapshotLocation
    ResourceType string
    The type of resource (usually InstanceSnapshot).
    SizeInGb int
    The size in GB of the SSD
    State string
    The state the snapshot is in.
    SupportCode string
    Support code to help identify any issues
    Tags Tag
    An array of key-value pairs to apply to this resource.
    arn String
    The Amazon Resource Name (ARN) of the snapshot.
    fromInstanceArn String
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created.
    fromInstanceName String
    The instance from which the snapshot was created.
    isFromAutoSnapshot Boolean
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.
    location InstanceSnapshotLocation
    resourceType String
    The type of resource (usually InstanceSnapshot).
    sizeInGb Integer
    The size in GB of the SSD
    state String
    The state the snapshot is in.
    supportCode String
    Support code to help identify any issues
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    arn string
    The Amazon Resource Name (ARN) of the snapshot.
    fromInstanceArn string
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created.
    fromInstanceName string
    The instance from which the snapshot was created.
    isFromAutoSnapshot boolean
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.
    location InstanceSnapshotLocation
    resourceType string
    The type of resource (usually InstanceSnapshot).
    sizeInGb number
    The size in GB of the SSD
    state string
    The state the snapshot is in.
    supportCode string
    Support code to help identify any issues
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    arn str
    The Amazon Resource Name (ARN) of the snapshot.
    from_instance_arn str
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created.
    from_instance_name str
    The instance from which the snapshot was created.
    is_from_auto_snapshot bool
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.
    location InstanceSnapshotLocation
    resource_type str
    The type of resource (usually InstanceSnapshot).
    size_in_gb int
    The size in GB of the SSD
    state str
    The state the snapshot is in.
    support_code str
    Support code to help identify any issues
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    arn String
    The Amazon Resource Name (ARN) of the snapshot.
    fromInstanceArn String
    The Amazon Resource Name (ARN) of the instance from which the snapshot was created.
    fromInstanceName String
    The instance from which the snapshot was created.
    isFromAutoSnapshot Boolean
    A Boolean value indicating whether the snapshot was created from an automatic snapshot.
    location Property Map
    resourceType String
    The type of resource (usually InstanceSnapshot).
    sizeInGb Number
    The size in GB of the SSD
    state String
    The state the snapshot is in.
    supportCode String
    Support code to help identify any issues
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    InstanceSnapshotLocation

    AvailabilityZone string
    The Availability Zone. Follows the format us-east-2a (case-sensitive).
    RegionName string
    The AWS Region name.
    AvailabilityZone string
    The Availability Zone. Follows the format us-east-2a (case-sensitive).
    RegionName string
    The AWS Region name.
    availabilityZone String
    The Availability Zone. Follows the format us-east-2a (case-sensitive).
    regionName String
    The AWS Region name.
    availabilityZone string
    The Availability Zone. Follows the format us-east-2a (case-sensitive).
    regionName string
    The AWS Region name.
    availability_zone str
    The Availability Zone. Follows the format us-east-2a (case-sensitive).
    region_name str
    The AWS Region name.
    availabilityZone String
    The Availability Zone. Follows the format us-east-2a (case-sensitive).
    regionName String
    The AWS Region name.

    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.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native