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

aws.ebs.SnapshotImport

Explore with Pulumi AI

Imports a disk image from S3 as 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.SnapshotImport("example", new()
    {
        DiskContainer = new Aws.Ebs.Inputs.SnapshotImportDiskContainerArgs
        {
            Format = "VHD",
            UserBucket = new Aws.Ebs.Inputs.SnapshotImportDiskContainerUserBucketArgs
            {
                S3Bucket = "disk-images",
                S3Key = "source.vhd",
            },
        },
        RoleName = "disk-image-import",
        Tags = 
        {
            { "Name", "HelloWorld" },
        },
    });

});

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 {
		_, err := ebs.NewSnapshotImport(ctx, "example", &ebs.SnapshotImportArgs{
			DiskContainer: &ebs.SnapshotImportDiskContainerArgs{
				Format: pulumi.String("VHD"),
				UserBucket: &ebs.SnapshotImportDiskContainerUserBucketArgs{
					S3Bucket: pulumi.String("disk-images"),
					S3Key:    pulumi.String("source.vhd"),
				},
			},
			RoleName: pulumi.String("disk-image-import"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("HelloWorld"),
			},
		})
		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.SnapshotImport;
import com.pulumi.aws.ebs.SnapshotImportArgs;
import com.pulumi.aws.ebs.inputs.SnapshotImportDiskContainerArgs;
import com.pulumi.aws.ebs.inputs.SnapshotImportDiskContainerUserBucketArgs;
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 SnapshotImport("example", SnapshotImportArgs.builder()        
            .diskContainer(SnapshotImportDiskContainerArgs.builder()
                .format("VHD")
                .userBucket(SnapshotImportDiskContainerUserBucketArgs.builder()
                    .s3Bucket("disk-images")
                    .s3Key("source.vhd")
                    .build())
                .build())
            .roleName("disk-image-import")
            .tags(Map.of("Name", "HelloWorld"))
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.ebs.SnapshotImport("example",
    disk_container=aws.ebs.SnapshotImportDiskContainerArgs(
        format="VHD",
        user_bucket=aws.ebs.SnapshotImportDiskContainerUserBucketArgs(
            s3_bucket="disk-images",
            s3_key="source.vhd",
        ),
    ),
    role_name="disk-image-import",
    tags={
        "Name": "HelloWorld",
    })

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

const example = new aws.ebs.SnapshotImport("example", {
    diskContainer: {
        format: "VHD",
        userBucket: {
            s3Bucket: "disk-images",
            s3Key: "source.vhd",
        },
    },
    roleName: "disk-image-import",
    tags: {
        Name: "HelloWorld",
    },
});

resources:
  example:
    type: aws:ebs:SnapshotImport
    properties:
      diskContainer:
        format: VHD
        userBucket:
          s3Bucket: disk-images
          s3Key: source.vhd
      roleName: disk-image-import
      tags:
        Name: HelloWorld

Create SnapshotImport Resource

new SnapshotImport(name: string, args: SnapshotImportArgs, opts?: CustomResourceOptions);
@overload
def SnapshotImport(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   client_data: Optional[SnapshotImportClientDataArgs] = None,
                   description: Optional[str] = None,
                   disk_container: Optional[SnapshotImportDiskContainerArgs] = None,
                   encrypted: Optional[bool] = None,
                   kms_key_id: Optional[str] = None,
                   permanent_restore: Optional[bool] = None,
                   role_name: Optional[str] = None,
                   storage_tier: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   temporary_restore_days: Optional[int] = None)
@overload
def SnapshotImport(resource_name: str,
                   args: SnapshotImportArgs,
                   opts: Optional[ResourceOptions] = None)
func NewSnapshotImport(ctx *Context, name string, args SnapshotImportArgs, opts ...ResourceOption) (*SnapshotImport, error)
public SnapshotImport(string name, SnapshotImportArgs args, CustomResourceOptions? opts = null)
public SnapshotImport(String name, SnapshotImportArgs args)
public SnapshotImport(String name, SnapshotImportArgs args, CustomResourceOptions options)

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

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

DiskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

ClientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

Description string

The description string for the import snapshot task.

Encrypted bool

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

KmsKeyId string

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

PermanentRestore bool

Indicates whether to permanently restore an archived snapshot.

RoleName string

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

DiskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

ClientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

Description string

The description string for the import snapshot task.

Encrypted bool

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

KmsKeyId string

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

PermanentRestore bool

Indicates whether to permanently restore an archived snapshot.

RoleName string

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

diskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

clientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

description String

The description string for the import snapshot task.

encrypted Boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kmsKeyId String

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

permanentRestore Boolean

Indicates whether to permanently restore an archived snapshot.

roleName String

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

diskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

clientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

description string

The description string for the import snapshot task.

encrypted boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kmsKeyId string

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

permanentRestore boolean

Indicates whether to permanently restore an archived snapshot.

roleName string

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

disk_container SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

client_data SnapshotImportClientDataArgs

The client-specific data. Detailed below.

description str

The description string for the import snapshot task.

encrypted bool

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kms_key_id str

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

permanent_restore bool

Indicates whether to permanently restore an archived snapshot.

role_name str

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

diskContainer Property Map

Information about the disk container. Detailed below.

clientData Property Map

The client-specific data. Detailed below.

description String

The description string for the import snapshot task.

encrypted Boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kmsKeyId String

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

permanentRestore Boolean

Indicates whether to permanently restore an archived snapshot.

roleName String

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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

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

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

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

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

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 EBS 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 SnapshotImport Resource

Get an existing SnapshotImport 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?: SnapshotImportState, opts?: CustomResourceOptions): SnapshotImport
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        client_data: Optional[SnapshotImportClientDataArgs] = None,
        data_encryption_key_id: Optional[str] = None,
        description: Optional[str] = None,
        disk_container: Optional[SnapshotImportDiskContainerArgs] = 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,
        role_name: 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) -> SnapshotImport
func GetSnapshotImport(ctx *Context, name string, id IDInput, state *SnapshotImportState, opts ...ResourceOption) (*SnapshotImport, error)
public static SnapshotImport Get(string name, Input<string> id, SnapshotImportState? state, CustomResourceOptions? opts = null)
public static SnapshotImport get(String name, Output<String> id, SnapshotImportState 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.

ClientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

DataEncryptionKeyId string

The data encryption key identifier for the snapshot.

Description string

The description string for the import snapshot task.

DiskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

Encrypted bool

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

KmsKeyId string

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

PermanentRestore bool

Indicates whether to permanently restore an archived snapshot.

RoleName string

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

ClientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

DataEncryptionKeyId string

The data encryption key identifier for the snapshot.

Description string

The description string for the import snapshot task.

DiskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

Encrypted bool

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

KmsKeyId string

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

PermanentRestore bool

Indicates whether to permanently restore an archived snapshot.

RoleName string

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

clientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

dataEncryptionKeyId String

The data encryption key identifier for the snapshot.

description String

The description string for the import snapshot task.

diskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

encrypted Boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kmsKeyId String

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

permanentRestore Boolean

Indicates whether to permanently restore an archived snapshot.

roleName String

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

clientData SnapshotImportClientDataArgs

The client-specific data. Detailed below.

dataEncryptionKeyId string

The data encryption key identifier for the snapshot.

description string

The description string for the import snapshot task.

diskContainer SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

encrypted boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kmsKeyId string

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

permanentRestore boolean

Indicates whether to permanently restore an archived snapshot.

roleName string

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

client_data SnapshotImportClientDataArgs

The client-specific data. Detailed below.

data_encryption_key_id str

The data encryption key identifier for the snapshot.

description str

The description string for the import snapshot task.

disk_container SnapshotImportDiskContainerArgs

Information about the disk container. Detailed below.

encrypted bool

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kms_key_id str

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

permanent_restore bool

Indicates whether to permanently restore an archived snapshot.

role_name str

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

clientData Property Map

The client-specific data. Detailed below.

dataEncryptionKeyId String

The data encryption key identifier for the snapshot.

description String

The description string for the import snapshot task.

diskContainer Property Map

Information about the disk container. Detailed below.

encrypted Boolean

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId.

kmsKeyId String

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

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

permanentRestore Boolean

Indicates whether to permanently restore an archived snapshot.

roleName String

The name of the IAM Role the VM Import/Export service will assume. This role needs certain permissions. See https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-role. Default: vmimport

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.

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.

Supporting Types

SnapshotImportClientData

Comment string

A user-defined comment about the disk upload.

UploadEnd string

The time that the disk upload ends.

UploadSize double

The size of the uploaded disk image, in GiB.

UploadStart string

The time that the disk upload starts.

Comment string

A user-defined comment about the disk upload.

UploadEnd string

The time that the disk upload ends.

UploadSize float64

The size of the uploaded disk image, in GiB.

UploadStart string

The time that the disk upload starts.

comment String

A user-defined comment about the disk upload.

uploadEnd String

The time that the disk upload ends.

uploadSize Double

The size of the uploaded disk image, in GiB.

uploadStart String

The time that the disk upload starts.

comment string

A user-defined comment about the disk upload.

uploadEnd string

The time that the disk upload ends.

uploadSize number

The size of the uploaded disk image, in GiB.

uploadStart string

The time that the disk upload starts.

comment str

A user-defined comment about the disk upload.

upload_end str

The time that the disk upload ends.

upload_size float

The size of the uploaded disk image, in GiB.

upload_start str

The time that the disk upload starts.

comment String

A user-defined comment about the disk upload.

uploadEnd String

The time that the disk upload ends.

uploadSize Number

The size of the uploaded disk image, in GiB.

uploadStart String

The time that the disk upload starts.

SnapshotImportDiskContainer

Format string

The format of the disk image being imported. One of VHD or VMDK.

Description string

The description of the disk image being imported.

Url string

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). One of url or user_bucket must be set.

UserBucket SnapshotImportDiskContainerUserBucket

The Amazon S3 bucket for the disk image. One of url or user_bucket must be set. Detailed below.

Format string

The format of the disk image being imported. One of VHD or VMDK.

Description string

The description of the disk image being imported.

Url string

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). One of url or user_bucket must be set.

UserBucket SnapshotImportDiskContainerUserBucket

The Amazon S3 bucket for the disk image. One of url or user_bucket must be set. Detailed below.

format String

The format of the disk image being imported. One of VHD or VMDK.

description String

The description of the disk image being imported.

url String

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). One of url or user_bucket must be set.

userBucket SnapshotImportDiskContainerUserBucket

The Amazon S3 bucket for the disk image. One of url or user_bucket must be set. Detailed below.

format string

The format of the disk image being imported. One of VHD or VMDK.

description string

The description of the disk image being imported.

url string

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). One of url or user_bucket must be set.

userBucket SnapshotImportDiskContainerUserBucket

The Amazon S3 bucket for the disk image. One of url or user_bucket must be set. Detailed below.

format str

The format of the disk image being imported. One of VHD or VMDK.

description str

The description of the disk image being imported.

url str

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). One of url or user_bucket must be set.

user_bucket SnapshotImportDiskContainerUserBucket

The Amazon S3 bucket for the disk image. One of url or user_bucket must be set. Detailed below.

format String

The format of the disk image being imported. One of VHD or VMDK.

description String

The description of the disk image being imported.

url String

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). One of url or user_bucket must be set.

userBucket Property Map

The Amazon S3 bucket for the disk image. One of url or user_bucket must be set. Detailed below.

SnapshotImportDiskContainerUserBucket

S3Bucket string

The name of the Amazon S3 bucket where the disk image is located.

S3Key string

The file name of the disk image.

S3Bucket string

The name of the Amazon S3 bucket where the disk image is located.

S3Key string

The file name of the disk image.

s3Bucket String

The name of the Amazon S3 bucket where the disk image is located.

s3Key String

The file name of the disk image.

s3Bucket string

The name of the Amazon S3 bucket where the disk image is located.

s3Key string

The file name of the disk image.

s3_bucket str

The name of the Amazon S3 bucket where the disk image is located.

s3_key str

The file name of the disk image.

s3Bucket String

The name of the Amazon S3 bucket where the disk image is located.

s3Key String

The file name of the disk image.

Package Details

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

This Pulumi package is based on the aws Terraform Provider.