Module ebs

@pulumi/aws > ebs

Index

ebs/getSnapshot.ts ebs/getSnapshotIds.ts ebs/getVolume.ts ebs/snapshot.ts ebs/snapshotCopy.ts ebs/volume.ts

class Snapshot

Creates a Snapshot of an EBS Volume.

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<Tags | undefined>;

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

class SnapshotCopy

Creates a Snapshot of a snapshot.

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

  • source_snapshot_id The ARN of the copied snapshot.
  • source_region 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.

  • source_snapshot_id The ARN for the snapshot to be copied.
  • source_region The region of the source snapshot.

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

property sourceSnapshotId

public sourceSnapshotId: pulumi.Output<string>;

property tags

public tags: pulumi.Output<Tags | undefined>;

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

class Volume

Manages a single EBS volume.

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 kms_key_id, encrypted needs to be set to true.

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<Tags | undefined>;

A mapping 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: “standard”).

property urn

urn: Output<URN>;

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

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

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.

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.

interface GetSnapshotArgs

A collection of arguments for invoking getSnapshot.

property filters

filters?: { ... }[];

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?: boolean;

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?: { ... };

interface GetSnapshotIdsArgs

A collection of arguments for invoking getSnapshotIds.

property filters

filters?: { ... }[];

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

A collection of values returned by getSnapshotIds.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property ids

ids: string[];

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 id

id: string;

id is the provider-assigned unique ID for this managed resource.

property kmsKeyId

kmsKeyId: string;

The ARN for the KMS encryption key.

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 snapshotId

snapshotId: string;

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

property state

state: string;

The snapshot state.

property tags

tags: { ... };

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

A collection of arguments for invoking getVolume.

property filters

filters?: { ... }[];

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?: boolean;

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

property tags

tags?: { ... };

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 id

id: string;

id is 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 size

size: number;

The size of the drive in GiBs.

property snapshotId

snapshotId: string;

The snapshot_id the EBS volume is based off.

property tags

tags: { ... };

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

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

A mapping of tags to assign to the snapshot

property volumeId

volumeId: pulumi.Input<string>;

The Volume ID of which to make a snapshot.

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.

  • source_snapshot_id The ARN for the snapshot to be copied.
  • source_region The region of the source snapshot.

property sourceRegion

sourceRegion: pulumi.Input<string>;

property sourceSnapshotId

sourceSnapshotId: pulumi.Input<string>;

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags for the snapshot.

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.

  • source_snapshot_id The ARN of the copied snapshot.
  • source_region 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.

  • source_snapshot_id The ARN for the snapshot to be copied.
  • source_region The region of the source snapshot.

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

property sourceSnapshotId

sourceSnapshotId?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<Tags>;

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

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

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

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 kms_key_id, encrypted needs to be set to true.

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

A mapping 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: “standard”).

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 kms_key_id, encrypted needs to be set to true.

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

A mapping 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: “standard”).