ebs

class pulumi_aws.ebs.GetSnapshotIdsResult(filters=None, ids=None, owners=None, restorable_by_user_ids=None, id=None)

A collection of values returned by getSnapshotIds.

id = None

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

class pulumi_aws.ebs.GetSnapshotResult(data_encryption_key_id=None, description=None, encrypted=None, filters=None, kms_key_id=None, most_recent=None, owner_alias=None, owner_id=None, owners=None, restorable_by_user_ids=None, snapshot_id=None, snapshot_ids=None, state=None, tags=None, volume_id=None, volume_size=None, id=None)

A collection of values returned by getSnapshot.

data_encryption_key_id = None

The data encryption key identifier for the snapshot.

description = None

A description for the snapshot

encrypted = None

Whether the snapshot is encrypted.

kms_key_id = None

The ARN for the KMS encryption key.

owner_alias = None

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

owner_id = None

The AWS account ID of the EBS snapshot owner.

snapshot_id = None

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

state = None

The snapshot state.

tags = None

A mapping of tags for the resource.

volume_id = None

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

volume_size = None

The size of the drive in GiBs.

id = None

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

class pulumi_aws.ebs.GetVolumeResult(arn=None, availability_zone=None, encrypted=None, filters=None, iops=None, kms_key_id=None, most_recent=None, size=None, snapshot_id=None, tags=None, volume_id=None, volume_type=None, id=None)

A collection of values returned by getVolume.

arn = None

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

availability_zone = None

The AZ where the EBS volume exists.

encrypted = None

Whether the disk is encrypted.

iops = None

The amount of IOPS for the disk.

kms_key_id = None

The ARN for the KMS encryption key.

size = None

The size of the drive in GiBs.

snapshot_id = None

The snapshot_id the EBS volume is based off.

tags = None

A mapping of tags for the resource.

volume_id = None

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

volume_type = None

The type of EBS volume.

id = None

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

class pulumi_aws.ebs.Snapshot(resource_name, opts=None, description=None, tags=None, volume_id=None, __name__=None, __opts__=None)

Creates a Snapshot of an EBS Volume.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A description of what the snapshot is.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the snapshot
  • volume_id (pulumi.Input[str]) – The Volume ID of which to make a snapshot.
data_encryption_key_id = None

The data encryption key identifier for the snapshot.

description = None

A description of what the snapshot is.

encrypted = None

Whether the snapshot is encrypted.

kms_key_id = None

The ARN for the KMS encryption key.

owner_alias = None

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

owner_id = None

The AWS account ID of the EBS snapshot owner.

tags = None

A mapping of tags to assign to the snapshot

volume_id = None

The Volume ID of which to make a snapshot.

volume_size = None

The size of the drive in GiBs.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ebs.SnapshotCopy(resource_name, opts=None, description=None, encrypted=None, kms_key_id=None, source_region=None, source_snapshot_id=None, tags=None, __name__=None, __opts__=None)

Creates a Snapshot of a snapshot.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A description of what the snapshot is.
  • encrypted (pulumi.Input[bool]) – Whether the snapshot is encrypted.
  • kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key.
Parameters:tags (pulumi.Input[dict]) – A mapping of tags for the snapshot.
data_encryption_key_id = None

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.
description = None

A description of what the snapshot is.

encrypted = None

Whether the snapshot is encrypted.

kms_key_id = None

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.
owner_alias = None

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

owner_id = None

The AWS account ID of the snapshot owner.

tags = None

A mapping of tags for the snapshot.

volume_size = None

The size of the drive in GiBs.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ebs.Volume(resource_name, opts=None, availability_zone=None, encrypted=None, iops=None, kms_key_id=None, size=None, snapshot_id=None, tags=None, type=None, __name__=None, __opts__=None)

Manages a single EBS volume.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • availability_zone (pulumi.Input[str]) – The AZ where the EBS volume will exist.
  • encrypted (pulumi.Input[bool]) – If true, the disk will be encrypted.
  • iops (pulumi.Input[float]) – The amount of IOPS to provision for the disk.
  • kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
  • size (pulumi.Input[float]) – The size of the drive in GiBs.
  • snapshot_id (pulumi.Input[str]) – A snapshot to base the EBS volume off of.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • type (pulumi.Input[str]) – The type of EBS volume. Can be “standard”, “gp2”, “io1”, “sc1” or “st1” (Default: “standard”).
arn = None

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

availability_zone = None

The AZ where the EBS volume will exist.

encrypted = None

If true, the disk will be encrypted.

iops = None

The amount of IOPS to provision for the disk.

kms_key_id = None

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

size = None

The size of the drive in GiBs.

snapshot_id = None

A snapshot to base the EBS volume off of.

tags = None

A mapping of tags to assign to the resource.

type = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.ebs.get_snapshot(filters=None, most_recent=None, owners=None, restorable_by_user_ids=None, snapshot_ids=None, tags=None, opts=None)

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

pulumi_aws.ebs.get_snapshot_ids(filters=None, owners=None, restorable_by_user_ids=None, opts=None)

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

pulumi_aws.ebs.get_volume(filters=None, most_recent=None, tags=None, opts=None)

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