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
published on Wednesday, Nov 18, 2026 by Pulumi
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
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 dictionarydata "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.
- Kms
Key stringId - 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
Pulumi.
Aws Native. Ec2. Snapshot State - The snapshot state.
- Storage
Tier Pulumi.Aws Native. Ec2. Snapshot Storage Tier - The storage tier in which the snapshot is stored.
-
List<Pulumi.
Aws Native. Outputs. 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 bool
- Indicates whether the snapshot is encrypted.
- Kms
Key stringId - 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
Snapshot
State Enum - The snapshot state.
- Storage
Tier SnapshotStorage Tier - The storage tier in which the snapshot is stored.
- 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 bool
- Indicates whether the snapshot is encrypted.
- kms_
key_ stringid - 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.
- 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.
- kms
Key StringId - 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
Snapshot
State - The snapshot state.
- storage
Tier SnapshotStorage Tier - The storage tier in which the snapshot is stored.
- List<Tag>
- Any tags assigned to the snapshot.
- volume
Size 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.
- kms
Key stringId - 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
Snapshot
State - The snapshot state.
- storage
Tier SnapshotStorage Tier - The storage tier in which the snapshot is stored.
- Tag[]
- Any tags assigned to the snapshot.
- volume
Size 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_ strid - 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
Snapshot
State - The snapshot state.
- storage_
tier SnapshotStorage Tier - The storage tier in which the snapshot is stored.
- 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.
- kms
Key StringId - 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.
- List<Property Map>
- Any tags assigned to the snapshot.
- volume
Size Number - The size of the volume, in GiB.
Supporting Types
SnapshotState
| Name | Value |
|---|---|
| Pending | pending |
| Completed | completed |
| Error | error |
| Recoverable | recoverable |
| Recovering | recovering |
| Name | Value |
|---|---|
| Snapshot | pending |
| Snapshot | completed |
| Snapshot | error |
| Snapshot | recoverable |
| Snapshot | recovering |
| Value |
|---|
pending |
completed |
error |
recoverable |
recovering |
| Name | Value |
|---|---|
| Pending | pending |
| Completed | completed |
| Error | error |
| Recoverable | recoverable |
| Recovering | recovering |
| Name | Value |
|---|---|
| Pending | pending |
| Completed | completed |
| Error | error |
| Recoverable | recoverable |
| Recovering | recovering |
| Name | Value |
|---|---|
| PENDING | pending |
| COMPLETED | completed |
| ERROR | error |
| RECOVERABLE | recoverable |
| RECOVERING | recovering |
| Value |
|---|
pending |
completed |
error |
recoverable |
recovering |
SnapshotStorageTier
| Name | Value |
|---|---|
| Archive | archive |
| Standard | standard |
| Name | Value |
|---|---|
| Snapshot | archive |
| Snapshot | standard |
| Value |
|---|
archive |
standard |
| Name | Value |
|---|---|
| Archive | archive |
| Standard | standard |
| Name | Value |
|---|---|
| Archive | archive |
| Standard | standard |
| Name | Value |
|---|---|
| ARCHIVE | archive |
| STANDARD | standard |
| Value |
|---|
archive |
standard |
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
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
published on Wednesday, Nov 18, 2026 by Pulumi