1. Docs
2. Reference
3. API
4. @pulumi/aws
5. ebs

Module ebs

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

• DefaultKmsKey
• EncryptionByDefault
• Snapshot
• SnapshotCopy
• Volume

Functions

• getDefaultKmsKey
• getEncryptionByDefault
• getSnapshot
• getSnapshotIds
• getVolume

Others

• DefaultKmsKeyArgs
• DefaultKmsKeyState
• EncryptionByDefaultArgs
• EncryptionByDefaultState
• GetDefaultKmsKeyResult
• GetEncryptionByDefaultResult
• GetSnapshotArgs
• GetSnapshotIdsArgs
• GetSnapshotIdsResult
• GetSnapshotResult
• GetVolumeArgs
• GetVolumeResult
• SnapshotArgs
• SnapshotCopyArgs
• SnapshotCopyState
• SnapshotState
• VolumeArgs
• VolumeState

Resources

Resource DefaultKmsKey

class DefaultKmsKey extends CustomResource

Provides a resource to manage the default customer master key (CMK) that your AWS account uses to encrypt EBS volumes.

Your AWS account has an AWS-managed default CMK that is used for encrypting an EBS volume when no CMK is specified in the API call that creates the volume. By using the aws.ebs.DefaultKmsKey resource, you can specify a customer-managed CMK to use in place of the AWS-managed default CMK.

NOTE: Creating an aws.ebs.DefaultKmsKey resource does not enable default EBS encryption. Use the aws.ebs.EncryptionByDefault to enable default EBS encryption.

NOTE: Destroying this resource will reset the default CMK to the account’s AWS-managed default CMK for EBS.

Example Usage

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

const example = new aws.ebs.DefaultKmsKey("example", {
    keyArn: aws_kms_key_example.arn,
});

constructor

new DefaultKmsKey(name: string, args: DefaultKmsKeyArgs, opts?: pulumi.CustomResourceOptions)

Create a DefaultKmsKey resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DefaultKmsKeyState, opts?: pulumi.CustomResourceOptions): DefaultKmsKey

Get an existing DefaultKmsKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DefaultKmsKey

Returns true if the given object is an instance of DefaultKmsKey. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keyArn

public keyArn: pulumi.Output<string>;

The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the EBS volume.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EncryptionByDefault

class EncryptionByDefault extends CustomResource

Provides a resource to manage whether default EBS encryption is enabled for your AWS account in the current AWS region. To manage the default KMS key for the region, see the aws.ebs.DefaultKmsKey resource.

NOTE: Removing this resource disables default EBS encryption.

Example Usage

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

const example = new aws.ebs.EncryptionByDefault("example", {
    enabled: true,
});

constructor

new EncryptionByDefault(name: string, args?: EncryptionByDefaultArgs, opts?: pulumi.CustomResourceOptions)

Create a EncryptionByDefault resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EncryptionByDefaultState, opts?: pulumi.CustomResourceOptions): EncryptionByDefault

Get an existing EncryptionByDefault resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EncryptionByDefault

Returns true if the given object is an instance of EncryptionByDefault. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Snapshot

class Snapshot extends CustomResource

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", {
    tags: {
        Name: "HelloWorld_snap",
    },
    volumeId: example.id,
});

constructor

new Snapshot(name: string, args: SnapshotArgs, opts?: pulumi.CustomResourceOptions)

Create a Snapshot resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnapshotState, opts?: pulumi.CustomResourceOptions): Snapshot

Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Snapshot

Returns true if the given object is an instance of Snapshot. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dataEncryptionKeyId

public dataEncryptionKeyId: pulumi.Output<string>;

The data encryption key identifier for the snapshot.

property description

public description: pulumi.Output<string | undefined>;

A description of what the snapshot is.

property encrypted

public encrypted: pulumi.Output<boolean>;

Whether the snapshot is encrypted.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key.

property ownerAlias

public ownerAlias: pulumi.Output<string>;

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

property ownerId

public ownerId: pulumi.Output<string>;

The AWS account ID of the EBS snapshot owner.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the snapshot

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeId

public volumeId: pulumi.Output<string>;

The Volume ID of which to make a snapshot.

property volumeSize

public volumeSize: pulumi.Output<number>;

The size of the drive in GiBs.

Resource SnapshotCopy

class SnapshotCopy extends CustomResource

Creates a Snapshot of a snapshot.

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

constructor

new SnapshotCopy(name: string, args: SnapshotCopyArgs, opts?: pulumi.CustomResourceOptions)

Create a SnapshotCopy resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnapshotCopyState, opts?: pulumi.CustomResourceOptions): SnapshotCopy

Get an existing SnapshotCopy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SnapshotCopy

Returns true if the given object is an instance of SnapshotCopy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dataEncryptionKeyId

public dataEncryptionKeyId: pulumi.Output<string>;

The data encryption key identifier for the snapshot. * sourceSnapshotId The ARN of the copied snapshot. * sourceRegion The region of the source snapshot.

property description

public description: pulumi.Output<string | undefined>;

A description of what the snapshot is.

property encrypted

public encrypted: pulumi.Output<boolean | undefined>;

Whether the snapshot is encrypted.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string | undefined>;

The ARN for the KMS encryption key.

property ownerAlias

public ownerAlias: pulumi.Output<string>;

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

property ownerId

public ownerId: pulumi.Output<string>;

The AWS account ID of the snapshot owner.

property sourceRegion

public sourceRegion: pulumi.Output<string>;

The region of the source snapshot.

property sourceSnapshotId

public sourceSnapshotId: pulumi.Output<string>;

The ARN for the snapshot to be copied.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags for the snapshot.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeId

public volumeId: pulumi.Output<string>;

property volumeSize

public volumeSize: pulumi.Output<number>;

The size of the drive in GiBs.

Resource Volume

class Volume extends CustomResource

Manages a single 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",
    },
});

constructor

new Volume(name: string, args: VolumeArgs, opts?: pulumi.CustomResourceOptions)

Create a Volume resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VolumeState, opts?: pulumi.CustomResourceOptions): Volume

Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Volume

Returns true if the given object is an instance of Volume. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The volume ARN (e.g. arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The AZ where the EBS volume will exist.

property encrypted

public encrypted: pulumi.Output<boolean>;

If true, the disk will be encrypted.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iops

public iops: pulumi.Output<number>;

The amount of IOPS to provision for the disk.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, encrypted needs to be set to true.

property multiAttachEnabled

public multiAttachEnabled: pulumi.Output<boolean | undefined>;

Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported exclusively on io1 volumes.

property outpostArn

public outpostArn: pulumi.Output<string | undefined>;

The Amazon Resource Name (ARN) of the Outpost.

property size

public size: pulumi.Output<number>;

The size of the drive in GiBs.

property snapshotId

public snapshotId: pulumi.Output<string>;

A snapshot to base the EBS volume off of.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property type

public type: pulumi.Output<string>;

The type of EBS volume. Can be “standard”, “gp2”, “io1”, “sc1” or “st1” (Default: “gp2”).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getDefaultKmsKey

getDefaultKmsKey(opts?: pulumi.InvokeOptions): Promise<GetDefaultKmsKeyResult>

Use this data source to get the default EBS encryption KMS key in the current region.

Example Usage

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

const current = pulumi.output(aws.ebs.getDefaultKmsKey({ async: true }));
const example = new aws.ebs.Volume("example", {
    availabilityZone: "us-west-2a",
    encrypted: true,
    kmsKeyId: current.keyArn,
});

Function getEncryptionByDefault

getEncryptionByDefault(opts?: pulumi.InvokeOptions): Promise<GetEncryptionByDefaultResult>

Provides a way to check whether default EBS encryption is enabled for your AWS account in the current AWS region.

Example Usage

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

const current = pulumi.output(aws.ebs.getEncryptionByDefault({ async: true }));

Function getSnapshot

getSnapshot(args?: GetSnapshotArgs, opts?: pulumi.InvokeOptions): Promise<GetSnapshotResult>

Use this data source to get information about an EBS Snapshot for use when provisioning EBS Volumes

Example Usage

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

const ebsVolume = pulumi.output(aws.ebs.getSnapshot({
    filters: [
        {
            name: "volume-size",
            values: ["40"],
        },
        {
            name: "tag:Name",
            values: ["Example"],
        },
    ],
    mostRecent: true,
    owners: ["self"],
}, { async: true }));

Function getSnapshotIds

getSnapshotIds(args?: GetSnapshotIdsArgs, opts?: pulumi.InvokeOptions): Promise<GetSnapshotIdsResult>

Use this data source to get a list of EBS Snapshot IDs matching the specified criteria.

Example Usage

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

const ebsVolumes = pulumi.output(aws.ebs.getSnapshotIds({
    filters: [
        {
            name: "volume-size",
            values: ["40"],
        },
        {
            name: "tag:Name",
            values: ["Example"],
        },
    ],
    owners: ["self"],
}, { async: true }));

Function getVolume

getVolume(args?: GetVolumeArgs, opts?: pulumi.InvokeOptions): Promise<GetVolumeResult>

Use this data source to get information about an EBS volume for use in other resources.

Example Usage

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

const ebsVolume = pulumi.output(aws.ebs.getVolume({
    filters: [
        {
            name: "volume-type",
            values: ["gp2"],
        },
        {
            name: "tag:Name",
            values: ["Example"],
        },
    ],
    mostRecent: true,
}, { async: true }));

Others

interface DefaultKmsKeyArgs

interface DefaultKmsKeyArgs

The set of arguments for constructing a DefaultKmsKey resource.

property keyArn

keyArn: pulumi.Input<string>;

The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the EBS volume.

interface DefaultKmsKeyState

interface DefaultKmsKeyState

Input properties used for looking up and filtering DefaultKmsKey resources.

property keyArn

keyArn?: pulumi.Input<string>;

The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the EBS volume.

interface EncryptionByDefaultArgs

interface EncryptionByDefaultArgs

The set of arguments for constructing a EncryptionByDefault resource.

property enabled

enabled?: pulumi.Input<boolean>;

Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.

interface EncryptionByDefaultState

interface EncryptionByDefaultState

Input properties used for looking up and filtering EncryptionByDefault resources.

property enabled

enabled?: pulumi.Input<boolean>;

Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.

interface GetDefaultKmsKeyResult

interface GetDefaultKmsKeyResult

A collection of values returned by getDefaultKmsKey.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property keyArn

keyArn: string;

Amazon Resource Name (ARN) of the default KMS key uses to encrypt an EBS volume in this region when no key is specified in an API call that creates the volume and encryption by default is enabled.

interface GetEncryptionByDefaultResult

interface GetEncryptionByDefaultResult

A collection of values returned by getEncryptionByDefault.

property enabled

enabled: boolean;

Whether or not default EBS encryption is enabled. Returns as true or false.

property id

id: string;

The provider-assigned unique ID for this managed resource.

interface GetSnapshotArgs

interface GetSnapshotArgs

A collection of arguments for invoking getSnapshot.

property filters

filters?: GetSnapshotFilter[];

One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-snapshots in the AWS CLI reference][1].

property mostRecent

mostRecent?: undefined | false | true;

If more than one result is returned, use the most recent snapshot.

property owners

owners?: string[];

Returns the snapshots owned by the specified owner id. Multiple owners can be specified.

property restorableByUserIds

restorableByUserIds?: string[];

One or more AWS accounts IDs that can create volumes from the snapshot.

property snapshotIds

snapshotIds?: string[];

Returns information on a specific snapshot_id.

property tags

tags?: undefined | {[key: string]: any};

A map of tags for the resource.

interface GetSnapshotIdsArgs

interface GetSnapshotIdsArgs

A collection of arguments for invoking getSnapshotIds.

property filters

filters?: GetSnapshotIdsFilter[];

One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-volumes in the AWS CLI reference][1].

property owners

owners?: string[];

Returns the snapshots owned by the specified owner id. Multiple owners can be specified.

property restorableByUserIds

restorableByUserIds?: string[];

One or more AWS accounts IDs that can create volumes from the snapshot.

interface GetSnapshotIdsResult

interface GetSnapshotIdsResult

A collection of values returned by getSnapshotIds.

property filters

filters?: GetSnapshotIdsFilter[];

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

property owners

owners?: string[];

property restorableByUserIds

restorableByUserIds?: string[];

interface GetSnapshotResult

interface GetSnapshotResult

A collection of values returned by getSnapshot.

property dataEncryptionKeyId

dataEncryptionKeyId: string;

The data encryption key identifier for the snapshot.

property description

description: string;

A description for the snapshot

property encrypted

encrypted: boolean;

Whether the snapshot is encrypted.

property filters

filters?: GetSnapshotFilter[];

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kmsKeyId

kmsKeyId: string;

The ARN for the KMS encryption key.

property mostRecent

mostRecent?: undefined | false | true;

property ownerAlias

ownerAlias: string;

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

property ownerId

ownerId: string;

The AWS account ID of the EBS snapshot owner.

property owners

owners?: string[];

property restorableByUserIds

restorableByUserIds?: string[];

property snapshotId

snapshotId: string;

The snapshot ID (e.g. snap-59fcb34e).

property snapshotIds

snapshotIds?: string[];

property state

state: string;

The snapshot state.

property tags

tags: {[key: string]: any};

A map of tags for the resource.

property volumeId

volumeId: string;

The volume ID (e.g. vol-59fcb34e).

property volumeSize

volumeSize: number;

The size of the drive in GiBs.

interface GetVolumeArgs

interface GetVolumeArgs

A collection of arguments for invoking getVolume.

property filters

filters?: GetVolumeFilter[];

One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-volumes in the AWS CLI reference][1].

property mostRecent

mostRecent?: undefined | false | true;

If more than one result is returned, use the most recent Volume.

property tags

tags?: undefined | {[key: string]: any};

A map of tags for the resource.

interface GetVolumeResult

interface GetVolumeResult

A collection of values returned by getVolume.

property arn

arn: string;

The volume ARN (e.g. arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).

property availabilityZone

availabilityZone: string;

The AZ where the EBS volume exists.

property encrypted

encrypted: boolean;

Whether the disk is encrypted.

property filters

filters?: GetVolumeFilter[];

property id

id: string;

The provider-assigned unique ID for this managed resource.

property iops

iops: number;

The amount of IOPS for the disk.

property kmsKeyId

kmsKeyId: string;

The ARN for the KMS encryption key.

property mostRecent

mostRecent?: undefined | false | true;

property multiAttachEnabled

multiAttachEnabled: boolean;

(Optional) Specifies whether Amazon EBS Multi-Attach is enabled.

property outpostArn

outpostArn: string;

The Amazon Resource Name (ARN) of the Outpost.

property size

size: number;

The size of the drive in GiBs.

property snapshotId

snapshotId: string;

The snapshotId the EBS volume is based off.

property tags

tags: {[key: string]: any};

A map of tags for the resource.

property volumeId

volumeId: string;

The volume ID (e.g. vol-59fcb34e).

property volumeType

volumeType: string;

The type of EBS volume.

interface SnapshotArgs

interface SnapshotArgs

The set of arguments for constructing a Snapshot resource.

property description

description?: pulumi.Input<string>;

A description of what the snapshot is.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the snapshot

property volumeId

volumeId: pulumi.Input<string>;

The Volume ID of which to make a snapshot.

interface SnapshotCopyArgs

interface SnapshotCopyArgs

The set of arguments for constructing a SnapshotCopy resource.

property description

description?: pulumi.Input<string>;

A description of what the snapshot is.

property encrypted

encrypted?: pulumi.Input<boolean>;

Whether the snapshot is encrypted.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key.

property sourceRegion

sourceRegion: pulumi.Input<string>;

The region of the source snapshot.

property sourceSnapshotId

sourceSnapshotId: pulumi.Input<string>;

The ARN for the snapshot to be copied.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags for the snapshot.

interface SnapshotCopyState

interface SnapshotCopyState

Input properties used for looking up and filtering SnapshotCopy resources.

property dataEncryptionKeyId

dataEncryptionKeyId?: pulumi.Input<string>;

The data encryption key identifier for the snapshot. * sourceSnapshotId The ARN of the copied snapshot. * sourceRegion The region of the source snapshot.

property description

description?: pulumi.Input<string>;

A description of what the snapshot is.

property encrypted

encrypted?: pulumi.Input<boolean>;

Whether the snapshot is encrypted.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key.

property ownerAlias

ownerAlias?: pulumi.Input<string>;

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

property ownerId

ownerId?: pulumi.Input<string>;

The AWS account ID of the snapshot owner.

property sourceRegion

sourceRegion?: pulumi.Input<string>;

The region of the source snapshot.

property sourceSnapshotId

sourceSnapshotId?: pulumi.Input<string>;

The ARN for the snapshot to be copied.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags for the snapshot.

property volumeId

volumeId?: pulumi.Input<string>;

property volumeSize

volumeSize?: pulumi.Input<number>;

The size of the drive in GiBs.

interface SnapshotState

interface SnapshotState

Input properties used for looking up and filtering Snapshot resources.

property dataEncryptionKeyId

dataEncryptionKeyId?: pulumi.Input<string>;

The data encryption key identifier for the snapshot.

property description

description?: pulumi.Input<string>;

A description of what the snapshot is.

property encrypted

encrypted?: pulumi.Input<boolean>;

Whether the snapshot is encrypted.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key.

property ownerAlias

ownerAlias?: pulumi.Input<string>;

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

property ownerId

ownerId?: pulumi.Input<string>;

The AWS account ID of the EBS snapshot owner.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the snapshot

property volumeId

volumeId?: pulumi.Input<string>;

The Volume ID of which to make a snapshot.

property volumeSize

volumeSize?: pulumi.Input<number>;

The size of the drive in GiBs.

interface VolumeArgs

interface VolumeArgs

The set of arguments for constructing a Volume resource.

property availabilityZone

availabilityZone: pulumi.Input<string>;

The AZ where the EBS volume will exist.

property encrypted

encrypted?: pulumi.Input<boolean>;

If true, the disk will be encrypted.

property iops

iops?: pulumi.Input<number>;

The amount of IOPS to provision for the disk.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, encrypted needs to be set to true.

property multiAttachEnabled

multiAttachEnabled?: pulumi.Input<boolean>;

Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported exclusively on io1 volumes.

property outpostArn

outpostArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Outpost.

property size

size?: pulumi.Input<number>;

The size of the drive in GiBs.

property snapshotId

snapshotId?: pulumi.Input<string>;

A snapshot to base the EBS volume off of.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property type

type?: pulumi.Input<string>;

The type of EBS volume. Can be “standard”, “gp2”, “io1”, “sc1” or “st1” (Default: “gp2”).

interface VolumeState

interface VolumeState

Input properties used for looking up and filtering Volume resources.

property arn

arn?: pulumi.Input<string>;

The volume ARN (e.g. arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The AZ where the EBS volume will exist.

property encrypted

encrypted?: pulumi.Input<boolean>;

If true, the disk will be encrypted.

property iops

iops?: pulumi.Input<number>;

The amount of IOPS to provision for the disk.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, encrypted needs to be set to true.

property multiAttachEnabled

multiAttachEnabled?: pulumi.Input<boolean>;

Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported exclusively on io1 volumes.

property outpostArn

outpostArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Outpost.

property size

size?: pulumi.Input<number>;

The size of the drive in GiBs.

property snapshotId

snapshotId?: pulumi.Input<string>;

A snapshot to base the EBS volume off of.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property type

type?: pulumi.Input<string>;

The type of EBS volume. Can be “standard”, “gp2”, “io1”, “sc1” or “st1” (Default: “gp2”).