AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

getEbsVolumes

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.

Using getEbsVolumes

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEbsVolumes(args: GetEbsVolumesArgs, opts?: InvokeOptions): Promise<GetEbsVolumesResult>
function getEbsVolumesOutput(args: GetEbsVolumesOutputArgs, opts?: InvokeOptions): Output<GetEbsVolumesResult>
def get_ebs_volumes(filters: Optional[Sequence[GetEbsVolumesFilter]] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEbsVolumesResult
def get_ebs_volumes_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetEbsVolumesFilterArgs]]]] = None,
                    tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEbsVolumesResult]
func GetEbsVolumes(ctx *Context, args *GetEbsVolumesArgs, opts ...InvokeOption) (*GetEbsVolumesResult, error)
func GetEbsVolumesOutput(ctx *Context, args *GetEbsVolumesOutputArgs, opts ...InvokeOption) GetEbsVolumesResultOutput

> Note: This function is named GetEbsVolumes in the Go SDK.

public static class GetEbsVolumes 
{
    public static Task<GetEbsVolumesResult> InvokeAsync(GetEbsVolumesArgs args, InvokeOptions? opts = null)
    public static Output<GetEbsVolumesResult> Invoke(GetEbsVolumesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEbsVolumesResult> getEbsVolumes(GetEbsVolumesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:ebs/getEbsVolumes:getEbsVolumes
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Filters List<GetEbsVolumesFilter>

Custom filter block as described below.

Tags Dictionary<string, string>

Map of tags, each pair of which must exactly match a pair on the desired volumes.

Filters []GetEbsVolumesFilter

Custom filter block as described below.

Tags map[string]string

Map of tags, each pair of which must exactly match a pair on the desired volumes.

filters List<GetEbsVolumesFilter>

Custom filter block as described below.

tags Map<String,String>

Map of tags, each pair of which must exactly match a pair on the desired volumes.

filters GetEbsVolumesFilter[]

Custom filter block as described below.

tags {[key: string]: string}

Map of tags, each pair of which must exactly match a pair on the desired volumes.

filters Sequence[GetEbsVolumesFilter]

Custom filter block as described below.

tags Mapping[str, str]

Map of tags, each pair of which must exactly match a pair on the desired volumes.

filters List<Property Map>

Custom filter block as described below.

tags Map<String>

Map of tags, each pair of which must exactly match a pair on the desired volumes.

getEbsVolumes Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>

Set of all the EBS Volume IDs found. This data source will fail if no volumes match the provided criteria.

Filters List<GetEbsVolumesFilter>
Tags Dictionary<string, string>
Id string

The provider-assigned unique ID for this managed resource.

Ids []string

Set of all the EBS Volume IDs found. This data source will fail if no volumes match the provided criteria.

Filters []GetEbsVolumesFilter
Tags map[string]string
id String

The provider-assigned unique ID for this managed resource.

ids List<String>

Set of all the EBS Volume IDs found. This data source will fail if no volumes match the provided criteria.

filters List<GetEbsVolumesFilter>
tags Map<String,String>
id string

The provider-assigned unique ID for this managed resource.

ids string[]

Set of all the EBS Volume IDs found. This data source will fail if no volumes match the provided criteria.

filters GetEbsVolumesFilter[]
tags {[key: string]: string}
id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]

Set of all the EBS Volume IDs found. This data source will fail if no volumes match the provided criteria.

filters Sequence[GetEbsVolumesFilter]
tags Mapping[str, str]
id String

The provider-assigned unique ID for this managed resource.

ids List<String>

Set of all the EBS Volume IDs found. This data source will fail if no volumes match the provided criteria.

filters List<Property Map>
tags Map<String>

Supporting Types

GetEbsVolumesFilter

Name string

Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against the size filter, use:

Values List<string>

Set of values that are accepted for the given field. EBS Volume IDs will be selected if any one of the given values match.

Name string

Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against the size filter, use:

Values []string

Set of values that are accepted for the given field. EBS Volume IDs will be selected if any one of the given values match.

name String

Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against the size filter, use:

values List<String>

Set of values that are accepted for the given field. EBS Volume IDs will be selected if any one of the given values match.

name string

Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against the size filter, use:

values string[]

Set of values that are accepted for the given field. EBS Volume IDs will be selected if any one of the given values match.

name str

Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against the size filter, use:

values Sequence[str]

Set of values that are accepted for the given field. EBS Volume IDs will be selected if any one of the given values match.

name String

Name of the field to filter by, as defined by the underlying AWS API. For example, if matching against the size filter, use:

values List<String>

Set of values that are accepted for the given field. EBS Volume IDs will be selected if any one of the given values match.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.