getEbsVolumes function

Future<GetEbsVolumesResult> getEbsVolumes(
  1. GetEbsVolumesArgs args, {
  2. InvokeOptions? options,
})

aws.ebs.getEbsVolumes provides 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.

Example Usage

The following demonstrates obtaining a map of availability zone to EBS volume ID for volumes with a given tag value.

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

const example = aws.ebs.getEbsVolumes({
    tags: {
        VolumeSet: "TestVolumeSet",
    },
});
const exampleGetVolume = example.then(example => .reduce((__obj, [__key, __value]) => ({ ...__obj, [String(__key)]: aws.ebs.getVolume({
    filters: [{
        name: "volume-id",
        values: [__value],
    }],
}) }), {}));
export const availabilityZoneToVolumeId = exampleGetVolume.apply(exampleGetVolume => Object.values(exampleGetVolume).reduce((__obj, s) => ({ ...__obj, [String(s.id)]: s.availabilityZone }), {}));
import pulumi
import pulumi_aws as aws

example = aws.ebs.get_ebs_volumes(tags={
    "VolumeSet": "TestVolumeSet",
})
example_get_volume = {str(__key): aws.ebs.get_volume(filters=[{
    "name": "volume-id",
    "values": [__value],
}]) for __key, __value in enumerate(example.ids)}
pulumi.export("availabilityZoneToVolumeId", {s.id: s.availability_zone for s in example_get_volume.values()})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Ebs.GetEbsVolumes.Invoke(new()
    {
        Tags =
        {
            { "VolumeSet", "TestVolumeSet" },
        },
    });

    var exampleGetVolume = ;

    return new Dictionary<string, object?>
    {
        ["availabilityZoneToVolumeId"] = exampleGetVolume.Apply(exampleGetVolume => (exampleGetVolume).Values.ToDictionary(item => {
            var s = item.Value;
            return s.Id;
        }, item => {
            var s = item.Value;
            return s.AvailabilityZone;
        })),
    };
});
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ebs_getebsvolumes" "example" {
  tags = {
    "VolumeSet" = "TestVolumeSet"
  }
}
data "aws_ebs_getvolume" "invoke_1" {
  for_each = data.aws_ebs_getebsvolumes.example.ids
  filters {
    name   = "volume-id"
    values = [each.value]
  }
}

locals {
  exampleGetVolume = {for __key, __value in data.aws_ebs_getebsvolumes.example.ids : __key => data.aws_ebs_getvolume.invoke_1[__key]}
}
output "availabilityZoneToVolumeId" {
  value = {for s in local.exampleGetVolume : s.id => s.availabilityZone}
}

args Arguments passed to this invoke. Arguments for getEbsVolumes. options Invoke options controlling this call.

Implementation

Future<GetEbsVolumesResult> getEbsVolumes(
  GetEbsVolumesArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ebs/getEbsVolumes:getEbsVolumes',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetEbsVolumesResult.fromMap(result);
}