This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.
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(id=None, key_arn=None)¶
- class
pulumi_aws.ebs.AwaitableGetEbsVolumesResult(filters=None, id=None, ids=None, tags=None)¶
- class
pulumi_aws.ebs.AwaitableGetEncryptionByDefaultResult(enabled=None, id=None)¶
- class
pulumi_aws.ebs.AwaitableGetSnapshotIdsResult(filters=None, id=None, ids=None, owners=None, restorable_by_user_ids=None)¶
- class
pulumi_aws.ebs.AwaitableGetSnapshotResult(data_encryption_key_id=None, description=None, encrypted=None, filters=None, id=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)¶
- class
pulumi_aws.ebs.AwaitableGetVolumeResult(arn=None, availability_zone=None, encrypted=None, filters=None, id=None, iops=None, kms_key_id=None, most_recent=None, multi_attach_enabled=None, outpost_arn=None, size=None, snapshot_id=None, tags=None, volume_id=None, volume_type=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.DefaultKmsKeyresource, you can specify a customer-managed CMK to use in place of the AWS-managed default CMK.NOTE: Creating an
ebs.DefaultKmsKeyresource does not enable default EBS encryption. Use theebs.EncryptionByDefaultto enable default EBS encryption.NOTE: Destroying this resource will reset the default CMK to the account’s AWS-managed default CMK for EBS.
import pulumi import pulumi_aws as aws example = aws.ebs.DefaultKmsKey("example", key_arn=aws_kms_key["example"]["arn"])
- 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: pulumi.Output[str] = 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.DefaultKmsKeyresource.NOTE: Removing this resource disables default EBS encryption.
import pulumi import pulumi_aws as aws example = aws.ebs.EncryptionByDefault("example", enabled=True)
- 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
trueorfalse. Defaults totrue.
enabled: pulumi.Output[bool] = None¶Whether or not default EBS encryption is enabled. Valid values are
trueorfalse. Defaults totrue.
- 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
trueorfalse. Defaults totrue.
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(id=None, key_arn=None)¶ A collection of values returned by getDefaultKmsKey.
id= None¶The provider-assigned unique ID for this managed resource.
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.
- class
pulumi_aws.ebs.GetEbsVolumesResult(filters=None, id=None, ids=None, tags=None)¶ A collection of values returned by getEbsVolumes.
id= None¶The provider-assigned unique ID for this managed resource.
ids= None¶A set of all the EBS Volume IDs found. This data source will fail if no volumes match the provided criteria.
- 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
trueorfalse.
id= None¶The provider-assigned unique ID for this managed resource.
- class
pulumi_aws.ebs.GetSnapshotIdsResult(filters=None, id=None, ids=None, owners=None, restorable_by_user_ids=None)¶ A collection of values returned by getSnapshotIds.
id= None¶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, id=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)¶ 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.
id= None¶The provider-assigned unique ID for this managed resource.
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.
A map 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.
- class
pulumi_aws.ebs.GetVolumeResult(arn=None, availability_zone=None, encrypted=None, filters=None, id=None, iops=None, kms_key_id=None, most_recent=None, multi_attach_enabled=None, outpost_arn=None, size=None, snapshot_id=None, tags=None, volume_id=None, volume_type=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.
id= None¶The provider-assigned unique ID for this managed resource.
iops= None¶The amount of IOPS for the disk.
kms_key_id= None¶The ARN for the KMS encryption key.
multi_attach_enabled= None¶(Optional) Specifies whether Amazon EBS Multi-Attach is enabled.
outpost_arn= None¶The Amazon Resource Name (ARN) of the Outpost.
size= None¶The size of the drive in GiBs.
snapshot_id= None¶The snapshot_id the EBS volume is based off.
A map of tags for the resource.
volume_id= None¶The volume ID (e.g. vol-59fcb34e).
volume_type= None¶The type of EBS volume.
- 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.
import pulumi import pulumi_aws as aws example = aws.ebs.Volume("example", availability_zone="us-west-2a", size=40, tags={ "Name": "HelloWorld", }) example_snapshot = aws.ebs.Snapshot("exampleSnapshot", tags={ "Name": "HelloWorld_snap", }, volume_id=example.id)
- 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 map 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: pulumi.Output[str] = None¶The data encryption key identifier for the snapshot.
description: pulumi.Output[str] = None¶A description of what the snapshot is.
encrypted: pulumi.Output[bool] = None¶Whether the snapshot is encrypted.
kms_key_id: pulumi.Output[str] = None¶The ARN for the KMS encryption key.
owner_alias: pulumi.Output[str] = None¶Value from an Amazon-maintained list (
amazon,aws-marketplace,microsoft) of snapshot owners.
owner_id: pulumi.Output[str] = None¶The AWS account ID of the EBS snapshot owner.
A map of tags to assign to the snapshot
volume_id: pulumi.Output[str] = None¶The Volume ID of which to make a snapshot.
volume_size: pulumi.Output[float] = 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 map 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.
import pulumi import pulumi_aws as aws example = aws.ebs.Volume("example", availability_zone="us-west-2a", size=40, tags={ "Name": "HelloWorld", }) example_snapshot = aws.ebs.Snapshot("exampleSnapshot", tags={ "Name": "HelloWorld_snap", }, volume_id=example.id) example_copy = aws.ebs.SnapshotCopy("exampleCopy", source_region="us-west-2", source_snapshot_id=example_snapshot.id, tags={ "Name": "HelloWorld_copy_snap", })
- 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_region (pulumi.Input[str]) – The region of the source snapshot.
source_snapshot_id (pulumi.Input[str]) – The ARN for the snapshot to be copied.
tags (pulumi.Input[dict]) – A map of tags for the snapshot.
data_encryption_key_id: pulumi.Output[str] = None¶The data encryption key identifier for the snapshot.
source_snapshot_idThe ARN of the copied snapshot.source_regionThe region of the source snapshot.
description: pulumi.Output[str] = None¶A description of what the snapshot is.
encrypted: pulumi.Output[bool] = None¶Whether the snapshot is encrypted.
kms_key_id: pulumi.Output[str] = None¶The ARN for the KMS encryption key.
owner_alias: pulumi.Output[str] = None¶Value from an Amazon-maintained list (
amazon,aws-marketplace,microsoft) of snapshot owners.
owner_id: pulumi.Output[str] = None¶The AWS account ID of the snapshot owner.
source_region: pulumi.Output[str] = None¶The region of the source snapshot.
source_snapshot_id: pulumi.Output[str] = None¶The ARN for the snapshot to be copied.
A map of tags for the snapshot.
volume_size: pulumi.Output[float] = 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.
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.
source_region (pulumi.Input[str]) – The region of the source snapshot.
source_snapshot_id (pulumi.Input[str]) – The ARN for the snapshot to be copied.
tags (pulumi.Input[dict]) – A map 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, multi_attach_enabled=None, outpost_arn=None, size=None, snapshot_id=None, tags=None, type=None, __props__=None, __name__=None, __opts__=None)¶ Manages a single EBS volume.
import pulumi import pulumi_aws as aws example = aws.ebs.Volume("example", availability_zone="us-west-2a", size=40, tags={ "Name": "HelloWorld", })
- 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,encryptedneeds to be set to true.multi_attach_enabled (pulumi.Input[bool]) – Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported exclusively on
io1volumes.outpost_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Outpost.
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 map 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: “gp2”).
arn: pulumi.Output[str] = None¶The volume ARN (e.g. arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
availability_zone: pulumi.Output[str] = None¶The AZ where the EBS volume will exist.
encrypted: pulumi.Output[bool] = None¶If true, the disk will be encrypted.
iops: pulumi.Output[float] = None¶The amount of IOPS to provision for the disk.
kms_key_id: pulumi.Output[str] = None¶The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.
multi_attach_enabled: pulumi.Output[bool] = None¶Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported exclusively on
io1volumes.
outpost_arn: pulumi.Output[str] = None¶The Amazon Resource Name (ARN) of the Outpost.
size: pulumi.Output[float] = None¶The size of the drive in GiBs.
snapshot_id: pulumi.Output[str] = None¶A snapshot to base the EBS volume off of.
A map of tags to assign to the resource.
type: pulumi.Output[str] = None¶The type of EBS volume. Can be “standard”, “gp2”, “io1”, “sc1” or “st1” (Default: “gp2”).
- static
get(resource_name, id, opts=None, arn=None, availability_zone=None, encrypted=None, iops=None, kms_key_id=None, multi_attach_enabled=None, outpost_arn=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,encryptedneeds to be set to true.multi_attach_enabled (pulumi.Input[bool]) – Specifies whether to enable Amazon EBS Multi-Attach. Multi-Attach is supported exclusively on
io1volumes.outpost_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Outpost.
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 map 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: “gp2”).
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.
import pulumi import pulumi_aws as aws current = aws.ebs.get_default_kms_key() example = aws.ebs.Volume("example", availability_zone="us-west-2a", encrypted=True, kms_key_id=current.key_arn)
pulumi_aws.ebs.get_ebs_volumes(filters=None, tags=None, opts=None)¶ebs.getEbsVolumesprovides identifying information for EBS volumes matching given criteria.This data source can be useful for getting a list of volume IDs with (for example) matching tags.
import pulumi import pulumi_aws as aws example_ebs_volumes = aws.ebs.get_ebs_volumes(tags={ "VolumeSet": "TestVolumeSet", }) example_volume = [aws.ebs.get_volume(filter=[{ "name": "volume-id", "values": [each["value"]], }]) for __key, __value in example_ebs_volumes.ids] pulumi.export("availabilityZoneToVolumeId", {s.id: s.availability_zone for s in example_volume})
- Parameters
filters (list) – Custom filter block as described below.
tags (dict) – A map of tags, each pair of which must exactly match a pair on the desired volumes.
The filters object supports the following:
name(str) - The name of the field to filter by, as defined by the underlying AWS API. For example, if matching against thesizefilter, use:values(list) - Set of values that are accepted for the given field. EBS Volume IDs will be selected if any one of the given values match.
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.
import pulumi import pulumi_aws as aws current = aws.ebs.get_encryption_by_default()
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
import pulumi import pulumi_aws as aws ebs_volume = aws.ebs.get_snapshot(filters=[ { "name": "volume-size", "values": ["40"], }, { "name": "tag:Name", "values": ["Example"], }, ], most_recent=True, owners=["self"])
- 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.
tags (dict) – A map of tags for the resource.
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.
import pulumi import pulumi_aws as aws ebs_volumes = aws.ebs.get_snapshot_ids(filters=[ { "name": "volume-size", "values": ["40"], }, { "name": "tag:Name", "values": ["Example"], }, ], owners=["self"])
- 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.
import pulumi import pulumi_aws as aws ebs_volume = aws.ebs.get_volume(filters=[ { "name": "volume-type", "values": ["gp2"], }, { "name": "tag:Name", "values": ["Example"], }, ], most_recent=True)
- 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.
tags (dict) – A map of tags for the resource.
The filters object supports the following:
name(str)values(list)