1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. ec2
  6. getSnapshot

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Creates a snapshot of an EBS volume and stores it in Amazon S3.

    Using getSnapshot

    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 getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
    function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOutputOptions): Output<GetSnapshotResult>
    def get_snapshot(arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
    def get_snapshot_output(arn: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetSnapshotResult]
    func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
    func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

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

    public static class GetSnapshot 
    {
        public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:ec2:getSnapshot
      arguments:
        # arguments dictionary
    data "aws-native_ec2_get_snapshot" "name" {
        # arguments
    }

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the snapshot.
    Arn string
    The Amazon Resource Name (ARN) of the snapshot.
    arn string
    The Amazon Resource Name (ARN) of the snapshot.
    arn String
    The Amazon Resource Name (ARN) of the snapshot.
    arn string
    The Amazon Resource Name (ARN) of the snapshot.
    arn str
    The Amazon Resource Name (ARN) of the snapshot.
    arn String
    The Amazon Resource Name (ARN) of the snapshot.

    getSnapshot Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the snapshot.
    Encrypted bool
    Indicates whether the snapshot is encrypted.
    KmsKeyId string
    The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    OwnerId string
    The ID of the Amazon Web Services account that owns the EBS snapshot.
    Progress string
    The progress of the snapshot, as a percentage.
    SnapshotId string
    The ID of the snapshot.
    StartTime string
    The time stamp when the snapshot was initiated.
    State Pulumi.AwsNative.Ec2.SnapshotState
    The snapshot state.
    StorageTier Pulumi.AwsNative.Ec2.SnapshotStorageTier
    The storage tier in which the snapshot is stored.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Any tags assigned to the snapshot.
    VolumeSize int
    The size of the volume, in GiB.
    Arn string
    The Amazon Resource Name (ARN) of the snapshot.
    Encrypted bool
    Indicates whether the snapshot is encrypted.
    KmsKeyId string
    The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    OwnerId string
    The ID of the Amazon Web Services account that owns the EBS snapshot.
    Progress string
    The progress of the snapshot, as a percentage.
    SnapshotId string
    The ID of the snapshot.
    StartTime string
    The time stamp when the snapshot was initiated.
    State SnapshotStateEnum
    The snapshot state.
    StorageTier SnapshotStorageTier
    The storage tier in which the snapshot is stored.
    Tags Tag
    Any tags assigned to the snapshot.
    VolumeSize int
    The size of the volume, in GiB.
    arn string
    The Amazon Resource Name (ARN) of the snapshot.
    encrypted bool
    Indicates whether the snapshot is encrypted.
    kms_key_id string
    The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    owner_id string
    The ID of the Amazon Web Services account that owns the EBS snapshot.
    progress string
    The progress of the snapshot, as a percentage.
    snapshot_id string
    The ID of the snapshot.
    start_time string
    The time stamp when the snapshot was initiated.
    state "pending" | "completed" | "error" | "recoverable" | "recovering"
    The snapshot state.
    storage_tier "archive" | "standard"
    The storage tier in which the snapshot is stored.
    tags list(object)
    Any tags assigned to the snapshot.
    volume_size number
    The size of the volume, in GiB.
    arn String
    The Amazon Resource Name (ARN) of the snapshot.
    encrypted Boolean
    Indicates whether the snapshot is encrypted.
    kmsKeyId String
    The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    ownerId String
    The ID of the Amazon Web Services account that owns the EBS snapshot.
    progress String
    The progress of the snapshot, as a percentage.
    snapshotId String
    The ID of the snapshot.
    startTime String
    The time stamp when the snapshot was initiated.
    state SnapshotState
    The snapshot state.
    storageTier SnapshotStorageTier
    The storage tier in which the snapshot is stored.
    tags List<Tag>
    Any tags assigned to the snapshot.
    volumeSize Integer
    The size of the volume, in GiB.
    arn string
    The Amazon Resource Name (ARN) of the snapshot.
    encrypted boolean
    Indicates whether the snapshot is encrypted.
    kmsKeyId string
    The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    ownerId string
    The ID of the Amazon Web Services account that owns the EBS snapshot.
    progress string
    The progress of the snapshot, as a percentage.
    snapshotId string
    The ID of the snapshot.
    startTime string
    The time stamp when the snapshot was initiated.
    state SnapshotState
    The snapshot state.
    storageTier SnapshotStorageTier
    The storage tier in which the snapshot is stored.
    tags Tag[]
    Any tags assigned to the snapshot.
    volumeSize number
    The size of the volume, in GiB.
    arn str
    The Amazon Resource Name (ARN) of the snapshot.
    encrypted bool
    Indicates whether the snapshot is encrypted.
    kms_key_id str
    The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    owner_id str
    The ID of the Amazon Web Services account that owns the EBS snapshot.
    progress str
    The progress of the snapshot, as a percentage.
    snapshot_id str
    The ID of the snapshot.
    start_time str
    The time stamp when the snapshot was initiated.
    state SnapshotState
    The snapshot state.
    storage_tier SnapshotStorageTier
    The storage tier in which the snapshot is stored.
    tags Sequence[root_Tag]
    Any tags assigned to the snapshot.
    volume_size int
    The size of the volume, in GiB.
    arn String
    The Amazon Resource Name (ARN) of the snapshot.
    encrypted Boolean
    Indicates whether the snapshot is encrypted.
    kmsKeyId String
    The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
    ownerId String
    The ID of the Amazon Web Services account that owns the EBS snapshot.
    progress String
    The progress of the snapshot, as a percentage.
    snapshotId String
    The ID of the snapshot.
    startTime String
    The time stamp when the snapshot was initiated.
    state "pending" | "completed" | "error" | "recoverable" | "recovering"
    The snapshot state.
    storageTier "archive" | "standard"
    The storage tier in which the snapshot is stored.
    tags List<Property Map>
    Any tags assigned to the snapshot.
    volumeSize Number
    The size of the volume, in GiB.

    Supporting Types

    SnapshotState

    NameValue
    Pendingpending
    Completedcompleted
    Errorerror
    Recoverablerecoverable
    Recoveringrecovering
    NameValue
    SnapshotStatePendingpending
    SnapshotStateCompletedcompleted
    SnapshotStateErrorerror
    SnapshotStateRecoverablerecoverable
    SnapshotStateRecoveringrecovering
    Value
    pending
    completed
    error
    recoverable
    recovering
    NameValue
    Pendingpending
    Completedcompleted
    Errorerror
    Recoverablerecoverable
    Recoveringrecovering
    NameValue
    Pendingpending
    Completedcompleted
    Errorerror
    Recoverablerecoverable
    Recoveringrecovering
    NameValue
    PENDINGpending
    COMPLETEDcompleted
    ERRORerror
    RECOVERABLErecoverable
    RECOVERINGrecovering
    Value
    pending
    completed
    error
    recoverable
    recovering

    SnapshotStorageTier

    NameValue
    Archivearchive
    Standardstandard
    NameValue
    SnapshotStorageTierArchivearchive
    SnapshotStorageTierStandardstandard
    Value
    archive
    standard
    NameValue
    Archivearchive
    Standardstandard
    NameValue
    Archivearchive
    Standardstandard
    NameValue
    ARCHIVEarchive
    STANDARDstandard
    Value
    archive
    standard

    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 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 aws-native logo AWS Cloud Control

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial