Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. ebs
  5. SnapshotCopy
aws logo
AWS Classic v5.41.0, May 15 23

aws.ebs.SnapshotCopy

Explore with Pulumi AI

Creates a Snapshot of a snapshot.

Example Usage

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("exampleSnapshot", new()
    {
        VolumeId = example.Id,
        Tags = 
        {
            { "Name", "HelloWorld_snap" },
        },
    });

    var exampleCopy = new Aws.Ebs.SnapshotCopy("exampleCopy", new()
    {
        SourceSnapshotId = exampleSnapshot.Id,
        SourceRegion = "us-west-2",
        Tags = 
        {
            { "Name", "HelloWorld_copy_snap" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
		}
		exampleSnapshot, err := ebs.NewSnapshot(ctx, "exampleSnapshot", &ebs.SnapshotArgs{
			VolumeId: example.ID(),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("HelloWorld_snap"),
			},
		})
		if err != nil {
			return err
		}
		_, err = ebs.NewSnapshotCopy(ctx, "exampleCopy", &ebs.SnapshotCopyArgs{
			SourceSnapshotId: exampleSnapshot.ID(),
			SourceRegion:     pulumi.String("us-west-2"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("HelloWorld_copy_snap"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 com.pulumi.aws.ebs.SnapshotCopy;
import com.pulumi.aws.ebs.SnapshotCopyArgs;
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());

        var exampleCopy = new SnapshotCopy("exampleCopy", SnapshotCopyArgs.builder()        
            .sourceSnapshotId(exampleSnapshot.id())
            .sourceRegion("us-west-2")
            .tags(Map.of("Name", "HelloWorld_copy_snap"))
            .build());

    }
}

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("exampleSnapshot",
    volume_id=example.id,
    tags={
        "Name": "HelloWorld_snap",
    })
example_copy = aws.ebs.SnapshotCopy("exampleCopy",
    source_snapshot_id=example_snapshot.id,
    source_region="us-west-2",
    tags={
        "Name": "HelloWorld_copy_snap",
    })

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("exampleSnapshot", {
    volumeId: example.id,
    tags: {
        Name: "HelloWorld_snap",
    },
});
const exampleCopy = new aws.ebs.SnapshotCopy("exampleCopy", {
    sourceSnapshotId: exampleSnapshot.id,
    sourceRegion: "us-west-2",
    tags: {
        Name: "HelloWorld_copy_snap",
    },
});

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

Create SnapshotCopy Resource

new SnapshotCopy(name: string, args: SnapshotCopyArgs, opts?: CustomResourceOptions);
@overload
def SnapshotCopy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 encrypted: Optional[bool] = None,
                 kms_key_id: Optional[str] = None,
                 permanent_restore: Optional[bool] = None,
                 source_region: Optional[str] = None,
                 source_snapshot_id: Optional[str] = None,
                 storage_tier: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 temporary_restore_days: Optional[int] = None)
@overload
def SnapshotCopy(resource_name: str,
                 args: SnapshotCopyArgs,
                 opts: Optional[ResourceOptions] = None)
func NewSnapshotCopy(ctx *Context, name string, args SnapshotCopyArgs, opts ...ResourceOption) (*SnapshotCopy, error)
public SnapshotCopy(string name, SnapshotCopyArgs args, CustomResourceOptions? opts = null)
public SnapshotCopy(String name, SnapshotCopyArgs args)
public SnapshotCopy(String name, SnapshotCopyArgs args, CustomResourceOptions options)

type: aws:ebs:SnapshotCopy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SnapshotCopyArgs
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 SnapshotCopyArgs
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 SnapshotCopyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SnapshotCopyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SnapshotCopyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

SnapshotCopy 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 SnapshotCopy resource accepts the following input properties:

SourceRegion string

The region of the source snapshot.

SourceSnapshotId string

The ARN for the snapshot to be copied.

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.

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 for the snapshot.

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.

SourceRegion string

The region of the source snapshot.

SourceSnapshotId string

The ARN for the snapshot to be copied.

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.

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 for the snapshot.

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.

sourceRegion String

The region of the source snapshot.

sourceSnapshotId String

The ARN for the snapshot to be copied.

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.

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 for the snapshot.

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.

sourceRegion string

The region of the source snapshot.

sourceSnapshotId string

The ARN for the snapshot to be copied.

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.

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 for the snapshot.

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.

source_region str

The region of the source snapshot.

source_snapshot_id str

The ARN for the snapshot to be copied.

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.

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 for the snapshot.

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.

sourceRegion String

The region of the source snapshot.

sourceSnapshotId String

The ARN for the snapshot to be copied.

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.

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 for the snapshot.

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

Id string

The provider-assigned unique ID for this managed resource.

OutpostArn string
OwnerAlias string

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

OwnerId string

The AWS account ID of the snapshot owner.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

VolumeId string
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.

Id string

The provider-assigned unique ID for this managed resource.

OutpostArn string
OwnerAlias string

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

OwnerId string

The AWS account ID of the snapshot owner.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

VolumeId string
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.

id String

The provider-assigned unique ID for this managed resource.

outpostArn String
ownerAlias String

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

ownerId String

The AWS account ID of the snapshot owner.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

volumeId String
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.

id string

The provider-assigned unique ID for this managed resource.

outpostArn string
ownerAlias string

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

ownerId string

The AWS account ID of the snapshot owner.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

volumeId string
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.

id str

The provider-assigned unique ID for this managed resource.

outpost_arn str
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 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.

volume_id str
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.

id String

The provider-assigned unique ID for this managed resource.

outpostArn String
ownerAlias String

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

ownerId String

The AWS account ID of the snapshot owner.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

volumeId String
volumeSize Number

The size of the drive in GiBs.

Look up Existing SnapshotCopy Resource

Get an existing SnapshotCopy 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?: SnapshotCopyState, opts?: CustomResourceOptions): SnapshotCopy
@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,
        source_region: Optional[str] = None,
        source_snapshot_id: Optional[str] = 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) -> SnapshotCopy
func GetSnapshotCopy(ctx *Context, name string, id IDInput, state *SnapshotCopyState, opts ...ResourceOption) (*SnapshotCopy, error)
public static SnapshotCopy Get(string name, Input<string> id, SnapshotCopyState? state, CustomResourceOptions? opts = null)
public static SnapshotCopy get(String name, Output<String> id, SnapshotCopyState 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
OwnerAlias string

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

OwnerId string

The AWS account ID of the snapshot owner.

PermanentRestore bool

Indicates whether to permanently restore an archived snapshot.

SourceRegion string

The region of the source snapshot.

SourceSnapshotId string

The ARN for the snapshot to be copied.

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 for the snapshot.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

OwnerId string

The AWS account ID of the snapshot owner.

PermanentRestore bool

Indicates whether to permanently restore an archived snapshot.

SourceRegion string

The region of the source snapshot.

SourceSnapshotId string

The ARN for the snapshot to be copied.

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 for the snapshot.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

ownerId String

The AWS account ID of the snapshot owner.

permanentRestore Boolean

Indicates whether to permanently restore an archived snapshot.

sourceRegion String

The region of the source snapshot.

sourceSnapshotId String

The ARN for the snapshot to be copied.

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 for the snapshot.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

ownerId string

The AWS account ID of the snapshot owner.

permanentRestore boolean

Indicates whether to permanently restore an archived snapshot.

sourceRegion string

The region of the source snapshot.

sourceSnapshotId string

The ARN for the snapshot to be copied.

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 for the snapshot.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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
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
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 snapshot owner.

permanent_restore bool

Indicates whether to permanently restore an archived snapshot.

source_region str

The region of the source snapshot.

source_snapshot_id str

The ARN for the snapshot to be copied.

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 for the snapshot.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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

Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

ownerId String

The AWS account ID of the snapshot owner.

permanentRestore Boolean

Indicates whether to permanently restore an archived snapshot.

sourceRegion String

The region of the source snapshot.

sourceSnapshotId String

The ARN for the snapshot to be copied.

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 for the snapshot.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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

The size of the drive in GiBs.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.