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.

class pulumi_aws.ebs.AwaitableGetDefaultKmsKeyResult(key_arn=None, id=None)
class pulumi_aws.ebs.AwaitableGetEncryptionByDefaultResult(enabled=None, id=None)
class pulumi_aws.ebs.AwaitableGetSnapshotIdsResult(filters=None, ids=None, owners=None, restorable_by_user_ids=None, id=None)
class pulumi_aws.ebs.AwaitableGetSnapshotResult(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)
class pulumi_aws.ebs.AwaitableGetVolumeResult(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)
class pulumi_aws.ebs.DefaultKmsKey(resource_name, opts=None, key_arn=None, __props__=None, __name__=None, __opts__=None)

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 ebs.DefaultKmsKey resource, you can specify a customer-managed CMK to use in place of the AWS-managed default CMK.

NOTE: Creating an ebs.DefaultKmsKey resource does not enable default EBS encryption. Use the 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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • key_arn (pulumi.Input[str]) – The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the EBS volume.

key_arn = None

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

static get(resource_name, id, opts=None, key_arn=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • key_arn (pulumi.Input[str]) – The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the EBS volume.

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.EncryptionByDefault(resource_name, opts=None, enabled=None, __props__=None, __name__=None, __opts__=None)

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 ``ebs.DefaultKmsKey` resource <https://www.terraform.io/docs/providers/aws/r/ebs_default_kms_key.html>`_.

NOTE: Removing this resource disables default EBS encryption.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.

enabled = None

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

static get(resource_name, id, opts=None, enabled=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Whether or not default EBS encryption is enabled. Valid values are true or false. Defaults to true.

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.GetDefaultKmsKeyResult(key_arn=None, id=None)

A collection of values returned by getDefaultKmsKey.

key_arn = None

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.

id = None

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

class pulumi_aws.ebs.GetEncryptionByDefaultResult(enabled=None, id=None)

A collection of values returned by getEncryptionByDefault.

enabled = None

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

id = None

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

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, __props__=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.

static get(resource_name, id, opts=None, data_encryption_key_id=None, description=None, encrypted=None, kms_key_id=None, owner_alias=None, owner_id=None, tags=None, volume_id=None, volume_size=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • data_encryption_key_id (pulumi.Input[str]) – The data encryption key identifier for the snapshot.

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

  • owner_alias (pulumi.Input[str]) – Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

  • owner_id (pulumi.Input[str]) – The AWS account ID of the EBS snapshot owner.

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

  • volume_size (pulumi.Input[float]) – 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, __props__=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.

* `source_snapshot_id` The ARN for the snapshot to be copied.
* `source_region` The region of the source snapshot.
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.

static get(resource_name, id, opts=None, data_encryption_key_id=None, description=None, encrypted=None, kms_key_id=None, owner_alias=None, owner_id=None, source_region=None, source_snapshot_id=None, tags=None, volume_id=None, volume_size=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • data_encryption_key_id (pulumi.Input[str]) – 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.
Parameters
  • 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.

* `source_snapshot_id` The ARN for the snapshot to be copied.
* `source_region` The region of the source snapshot.
Parameters
  • owner_alias (pulumi.Input[str]) – Value from an Amazon-maintained list (amazon, aws-marketplace, microsoft) of snapshot owners.

  • owner_id (pulumi.Input[str]) – The AWS account ID of the snapshot owner.

  • tags (pulumi.Input[dict]) – A mapping of tags for the snapshot.

  • volume_size (pulumi.Input[float]) – 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, __props__=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”).

static get(resource_name, id, opts=None, arn=None, availability_zone=None, encrypted=None, iops=None, kms_key_id=None, size=None, snapshot_id=None, tags=None, type=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The volume ARN (e.g. arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).

  • 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”).

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_default_kms_key(opts=None)

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

pulumi_aws.ebs.get_encryption_by_default(opts=None)

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

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

Parameters
  • filters (list) – 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].

  • most_recent (bool) – If more than one result is returned, use the most recent snapshot.

  • owners (list) – Returns the snapshots owned by the specified owner id. Multiple owners can be specified.

  • restorable_by_user_ids (list) – One or more AWS accounts IDs that can create volumes from the snapshot.

  • snapshot_ids (list) – Returns information on a specific snapshot_id.

The filters object supports the following:

  • name (str)

  • values (list)

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.

Parameters
  • filters (list) – 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].

  • owners (list) – Returns the snapshots owned by the specified owner id. Multiple owners can be specified.

  • restorable_by_user_ids (list) – One or more AWS accounts IDs that can create volumes from the snapshot.

The filters object supports the following:

  • name (str)

  • values (list)

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.

Parameters
  • filters (list) – 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].

  • most_recent (bool) – If more than one result is returned, use the most recent Volume.

The filters object supports the following:

  • name (str)

  • values (list)