We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Creates a snapshot of an EBS volume and stores it in Amazon S3.
Create Snapshot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Snapshot(name: string, args: SnapshotArgs, opts?: CustomResourceOptions);@overload
def Snapshot(resource_name: str,
args: SnapshotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Snapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
volume_id: Optional[str] = None,
description: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)
public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)
type: aws-native:ec2:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_ec2_snapshot" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SnapshotArgs
- 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 SnapshotArgs
- 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 SnapshotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SnapshotArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Snapshot 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 Snapshot resource accepts the following input properties:
- Volume
Id string - The ID of the Amazon EBS volume.
- Description string
- A description for the snapshot.
-
List<Pulumi.
Aws Native. Inputs. Tag> - Any tags assigned to the snapshot.
- Volume
Id string - The ID of the Amazon EBS volume.
- Description string
- A description for the snapshot.
-
Tag
Args - Any tags assigned to the snapshot.
- volume_
id string - The ID of the Amazon EBS volume.
- description string
- A description for the snapshot.
- list(object)
- Any tags assigned to the snapshot.
- volume
Id String - The ID of the Amazon EBS volume.
- description String
- A description for the snapshot.
- List<Tag>
- Any tags assigned to the snapshot.
- volume
Id string - The ID of the Amazon EBS volume.
- description string
- A description for the snapshot.
- Tag[]
- Any tags assigned to the snapshot.
- volume_
id str - The ID of the Amazon EBS volume.
- description str
- A description for the snapshot.
-
Sequence[Tag
Args] - Any tags assigned to the snapshot.
- volume
Id String - The ID of the Amazon EBS volume.
- description String
- A description for the snapshot.
- List<Property Map>
- Any tags assigned to the snapshot.
Outputs
All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the snapshot.
- Encrypted bool
- Indicates whether the snapshot is encrypted.
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- 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.
- volume
Size Number - The size of the volume, in GiB.
Look up Existing Snapshot Resource
Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Snapshot@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Snapshotfunc GetSnapshot(ctx *Context, name string, id IDInput, state *SnapshotState, opts ...ResourceOption) (*Snapshot, error)public static Snapshot Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Snapshot get(String name, Output<String> id, CustomResourceOptions options)resources: existingSnapshot: type: aws-native:ec2:Snapshot get: id: ${id}import {
to = aws-native_ec2_snapshot.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state SnapshotState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
SnapshotState
The snapshot state.
| 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
The storage tier in which the snapshot is stored.
| 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, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi