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

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.

    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:

    VolumeId string
    The ID of the Amazon EBS volume.
    Description string
    A description for the snapshot.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Any tags assigned to the snapshot.
    VolumeId string
    The ID of the Amazon EBS volume.
    Description string
    A description for the snapshot.
    Tags TagArgs
    Any tags assigned to the snapshot.
    volume_id string
    The ID of the Amazon EBS volume.
    description string
    A description for the snapshot.
    tags list(object)
    Any tags assigned to the snapshot.
    volumeId String
    The ID of the Amazon EBS volume.
    description String
    A description for the snapshot.
    tags List<Tag>
    Any tags assigned to the snapshot.
    volumeId string
    The ID of the Amazon EBS volume.
    description string
    A description for the snapshot.
    tags Tag[]
    Any tags assigned to the snapshot.
    volume_id str
    The ID of the Amazon EBS volume.
    description str
    A description for the snapshot.
    tags Sequence[TagArgs]
    Any tags assigned to the snapshot.
    volumeId String
    The ID of the Amazon EBS volume.
    description String
    A description for the snapshot.
    tags 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.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    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.
    volumeSize 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) -> Snapshot
    func 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.

    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

    The storage tier in which the snapshot is stored.

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

    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 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