Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. ebs
  5. Snapshot

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ebs.Snapshot

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

    Creates a Snapshot of an EBS Volume.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ebs.Volume("example", {
    availabilityZone: "us-west-2a",
    size: 40,
    tags: {
        Name: "HelloWorld",
    },
});
const exampleSnapshot = new aws.ebs.Snapshot("example_snapshot", {
    volumeId: example.id,
    tags: {
        Name: "HelloWorld_snap",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.ebs.Volume("example",
    availability_zone="us-west-2a",
    size=40,
    tags={
        "Name": "HelloWorld",
    })
example_snapshot = aws.ebs.Snapshot("example_snapshot",
    volume_id=example.id,
    tags={
        "Name": "HelloWorld_snap",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ebs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ebs.NewVolume(ctx, "example", &ebs.VolumeArgs{
			AvailabilityZone: pulumi.String("us-west-2a"),
			Size:             pulumi.Int(40),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("HelloWorld"),
			},
		})
		if err != nil {
			return err
		}
		_, err = ebs.NewSnapshot(ctx, "example_snapshot", &ebs.SnapshotArgs{
			VolumeId: example.ID(),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("HelloWorld_snap"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ebs.Volume("example", new()
    {
        AvailabilityZone = "us-west-2a",
        Size = 40,
        Tags = 
        {
            { "Name", "HelloWorld" },
        },
    });

    var exampleSnapshot = new Aws.Ebs.Snapshot("example_snapshot", new()
    {
        VolumeId = example.Id,
        Tags = 
        {
            { "Name", "HelloWorld_snap" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ebs.Volume;
import com.pulumi.aws.ebs.VolumeArgs;
import com.pulumi.aws.ebs.Snapshot;
import com.pulumi.aws.ebs.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Volume("example", VolumeArgs.builder()        
            .availabilityZone("us-west-2a")
            .size(40)
            .tags(Map.of("Name", "HelloWorld"))
            .build());

        var exampleSnapshot = new Snapshot("exampleSnapshot", SnapshotArgs.builder()        
            .volumeId(example.id())
            .tags(Map.of("Name", "HelloWorld_snap"))
            .build());

    }
}

    resources:
  example:
    type: aws:ebs:Volume
    properties:
      availabilityZone: us-west-2a
      size: 40
      tags:
        Name: HelloWorld
  exampleSnapshot:
    type: aws:ebs:Snapshot
    name: example_snapshot
    properties:
      volumeId: ${example.id}
      tags:
        Name: HelloWorld_snap

    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,
             outpost_arn: Optional[str] = None,
             permanent_restore: Optional[bool] = None,
             storage_tier: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             temporary_restore_days: Optional[int] = 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:ebs:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var snapshotResource = new Aws.Ebs.Snapshot("snapshotResource", new()
{
    VolumeId = "string",
    Description = "string",
    OutpostArn = "string",
    PermanentRestore = false,
    StorageTier = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TemporaryRestoreDays = 0,
});

    example, err := ebs.NewSnapshot(ctx, "snapshotResource", &ebs.SnapshotArgs{
	VolumeId:         pulumi.String("string"),
	Description:      pulumi.String("string"),
	OutpostArn:       pulumi.String("string"),
	PermanentRestore: pulumi.Bool(false),
	StorageTier:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TemporaryRestoreDays: pulumi.Int(0),
})

    var snapshotResource = new Snapshot("snapshotResource", SnapshotArgs.builder()        
    .volumeId("string")
    .description("string")
    .outpostArn("string")
    .permanentRestore(false)
    .storageTier("string")
    .tags(Map.of("string", "string"))
    .temporaryRestoreDays(0)
    .build());

    snapshot_resource = aws.ebs.Snapshot("snapshotResource",
    volume_id="string",
    description="string",
    outpost_arn="string",
    permanent_restore=False,
    storage_tier="string",
    tags={
        "string": "string",
    },
    temporary_restore_days=0)

    const snapshotResource = new aws.ebs.Snapshot("snapshotResource", {
    volumeId: "string",
    description: "string",
    outpostArn: "string",
    permanentRestore: false,
    storageTier: "string",
    tags: {
        string: "string",
    },
    temporaryRestoreDays: 0,
});

    type: aws:ebs:Snapshot
properties:
    description: string
    outpostArn: string
    permanentRestore: false
    storageTier: string
    tags:
        string: string
    temporaryRestoreDays: 0
    volumeId: string

    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

    The Snapshot resource accepts the following input properties:

    VolumeId string
    The Volume ID of which to make a snapshot.
    Description string
    A description of what the snapshot is.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    PermanentRestore bool
    Indicates whether to permanently restore an archived snapshot.
    StorageTier string
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    Tags Dictionary<string, string>
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TemporaryRestoreDays int
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    VolumeId string
    The Volume ID of which to make a snapshot.
    Description string
    A description of what the snapshot is.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    PermanentRestore bool
    Indicates whether to permanently restore an archived snapshot.
    StorageTier string
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    Tags map[string]string
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TemporaryRestoreDays int
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volumeId String
    The Volume ID of which to make a snapshot.
    description String
    A description of what the snapshot is.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    permanentRestore Boolean
    Indicates whether to permanently restore an archived snapshot.
    storageTier String
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags Map<String,String>
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    temporaryRestoreDays Integer
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volumeId string
    The Volume ID of which to make a snapshot.
    description string
    A description of what the snapshot is.
    outpostArn string
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    permanentRestore boolean
    Indicates whether to permanently restore an archived snapshot.
    storageTier string
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags {[key: string]: string}
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    temporaryRestoreDays number
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volume_id str
    The Volume ID of which to make a snapshot.
    description str
    A description of what the snapshot is.
    outpost_arn str
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    permanent_restore bool
    Indicates whether to permanently restore an archived snapshot.
    storage_tier str
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags Mapping[str, str]
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    temporary_restore_days int
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volumeId String
    The Volume ID of which to make a snapshot.
    description String
    A description of what the snapshot is.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    permanentRestore Boolean
    Indicates whether to permanently restore an archived snapshot.
    storageTier String
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags Map<String>
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    temporaryRestoreDays Number
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the EBS Snapshot.
    DataEncryptionKeyId string
    The data encryption key identifier for the snapshot.
    Encrypted bool
    Whether the snapshot is encrypted.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    The ARN for the KMS encryption key.
    OwnerAlias string
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    OwnerId string
    The AWS account ID of the EBS snapshot owner.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VolumeSize int
    The size of the drive in GiBs.
    Arn string
    Amazon Resource Name (ARN) of the EBS Snapshot.
    DataEncryptionKeyId string
    The data encryption key identifier for the snapshot.
    Encrypted bool
    Whether the snapshot is encrypted.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    The ARN for the KMS encryption key.
    OwnerAlias string
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    OwnerId string
    The AWS account ID of the EBS snapshot owner.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VolumeSize int
    The size of the drive in GiBs.
    arn String
    Amazon Resource Name (ARN) of the EBS Snapshot.
    dataEncryptionKeyId String
    The data encryption key identifier for the snapshot.
    encrypted Boolean
    Whether the snapshot is encrypted.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    The ARN for the KMS encryption key.
    ownerAlias String
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    ownerId String
    The AWS account ID of the EBS snapshot owner.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    volumeSize Integer
    The size of the drive in GiBs.
    arn string
    Amazon Resource Name (ARN) of the EBS Snapshot.
    dataEncryptionKeyId string
    The data encryption key identifier for the snapshot.
    encrypted boolean
    Whether the snapshot is encrypted.
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyId string
    The ARN for the KMS encryption key.
    ownerAlias string
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    ownerId string
    The AWS account ID of the EBS snapshot owner.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    volumeSize number
    The size of the drive in GiBs.
    arn str
    Amazon Resource Name (ARN) of the EBS Snapshot.
    data_encryption_key_id str
    The data encryption key identifier for the snapshot.
    encrypted bool
    Whether the snapshot is encrypted.
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_id str
    The ARN for the KMS encryption key.
    owner_alias str
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    owner_id str
    The AWS account ID of the EBS snapshot owner.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    volume_size int
    The size of the drive in GiBs.
    arn String
    Amazon Resource Name (ARN) of the EBS Snapshot.
    dataEncryptionKeyId String
    The data encryption key identifier for the snapshot.
    encrypted Boolean
    Whether the snapshot is encrypted.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    The ARN for the KMS encryption key.
    ownerAlias String
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    ownerId String
    The AWS account ID of the EBS snapshot owner.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    volumeSize Number
    The size of the drive in GiBs.

    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>, state?: SnapshotState, opts?: CustomResourceOptions): Snapshot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        data_encryption_key_id: Optional[str] = None,
        description: Optional[str] = None,
        encrypted: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        outpost_arn: Optional[str] = None,
        owner_alias: Optional[str] = None,
        owner_id: Optional[str] = None,
        permanent_restore: Optional[bool] = None,
        storage_tier: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        temporary_restore_days: Optional[int] = None,
        volume_id: Optional[str] = None,
        volume_size: Optional[int] = 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, SnapshotState? state, CustomResourceOptions? opts = null)
    public static Snapshot get(String name, Output<String> id, SnapshotState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) of the EBS Snapshot.
    DataEncryptionKeyId string
    The data encryption key identifier for the snapshot.
    Description string
    A description of what the snapshot is.
    Encrypted bool
    Whether the snapshot is encrypted.
    KmsKeyId string
    The ARN for the KMS encryption key.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    OwnerAlias string
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    OwnerId string
    The AWS account ID of the EBS snapshot owner.
    PermanentRestore bool
    Indicates whether to permanently restore an archived snapshot.
    StorageTier string
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    Tags Dictionary<string, string>
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TemporaryRestoreDays int
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    VolumeId string
    The Volume ID of which to make a snapshot.
    VolumeSize int
    The size of the drive in GiBs.
    Arn string
    Amazon Resource Name (ARN) of the EBS Snapshot.
    DataEncryptionKeyId string
    The data encryption key identifier for the snapshot.
    Description string
    A description of what the snapshot is.
    Encrypted bool
    Whether the snapshot is encrypted.
    KmsKeyId string
    The ARN for the KMS encryption key.
    OutpostArn string
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    OwnerAlias string
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    OwnerId string
    The AWS account ID of the EBS snapshot owner.
    PermanentRestore bool
    Indicates whether to permanently restore an archived snapshot.
    StorageTier string
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    Tags map[string]string
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TemporaryRestoreDays int
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    VolumeId string
    The Volume ID of which to make a snapshot.
    VolumeSize int
    The size of the drive in GiBs.
    arn String
    Amazon Resource Name (ARN) of the EBS Snapshot.
    dataEncryptionKeyId String
    The data encryption key identifier for the snapshot.
    description String
    A description of what the snapshot is.
    encrypted Boolean
    Whether the snapshot is encrypted.
    kmsKeyId String
    The ARN for the KMS encryption key.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    ownerAlias String
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    ownerId String
    The AWS account ID of the EBS snapshot owner.
    permanentRestore Boolean
    Indicates whether to permanently restore an archived snapshot.
    storageTier String
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags Map<String,String>
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    temporaryRestoreDays Integer
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volumeId String
    The Volume ID of which to make a snapshot.
    volumeSize Integer
    The size of the drive in GiBs.
    arn string
    Amazon Resource Name (ARN) of the EBS Snapshot.
    dataEncryptionKeyId string
    The data encryption key identifier for the snapshot.
    description string
    A description of what the snapshot is.
    encrypted boolean
    Whether the snapshot is encrypted.
    kmsKeyId string
    The ARN for the KMS encryption key.
    outpostArn string
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    ownerAlias string
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    ownerId string
    The AWS account ID of the EBS snapshot owner.
    permanentRestore boolean
    Indicates whether to permanently restore an archived snapshot.
    storageTier string
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags {[key: string]: string}
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    temporaryRestoreDays number
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volumeId string
    The Volume ID of which to make a snapshot.
    volumeSize number
    The size of the drive in GiBs.
    arn str
    Amazon Resource Name (ARN) of the EBS Snapshot.
    data_encryption_key_id str
    The data encryption key identifier for the snapshot.
    description str
    A description of what the snapshot is.
    encrypted bool
    Whether the snapshot is encrypted.
    kms_key_id str
    The ARN for the KMS encryption key.
    outpost_arn str
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    owner_alias str
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    owner_id str
    The AWS account ID of the EBS snapshot owner.
    permanent_restore bool
    Indicates whether to permanently restore an archived snapshot.
    storage_tier str
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags Mapping[str, str]
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    temporary_restore_days int
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volume_id str
    The Volume ID of which to make a snapshot.
    volume_size int
    The size of the drive in GiBs.
    arn String
    Amazon Resource Name (ARN) of the EBS Snapshot.
    dataEncryptionKeyId String
    The data encryption key identifier for the snapshot.
    description String
    A description of what the snapshot is.
    encrypted Boolean
    Whether the snapshot is encrypted.
    kmsKeyId String
    The ARN for the KMS encryption key.
    outpostArn String
    The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
    ownerAlias String
    Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.
    ownerId String
    The AWS account ID of the EBS snapshot owner.
    permanentRestore Boolean
    Indicates whether to permanently restore an archived snapshot.
    storageTier String
    The name of the storage tier. Valid values are archive and standard. Default value is standard.
    tags Map<String>
    A map of tags to assign to the snapshot. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    temporaryRestoreDays Number
    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
    volumeId String
    The Volume ID of which to make a snapshot.
    volumeSize Number
    The size of the drive in GiBs.

    Import

    Using pulumi import, import EBS Snapshot using the id. For example:

    $ pulumi import aws:ebs/snapshot:Snapshot id snap-049df61146c4d7901

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
    pulumi/pulumi-aws