mirrors
/
pulumi
mirror of https://github.com/pulumi/pulumi.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pulumi/tests/testdata/codegen/output-funcs-tfbridge20/docs/getamiids/_index.md

48 KiB
Raw Permalink Blame History

title: "getAmiIds" title_tag: "mypkg.getAmiIds" meta_desc: "Documentation for the mypkg.getAmiIds function with examples, input properties, output properties, and supporting types." layout: api no_edit_this_page: true

Deprecated: aws.getAmiIds has been deprecated in favor of aws.ec2.getAmiIds

Taken from pulumi-AWS to regress an issue

Using getAmiIds

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 getAmiIds(args: GetAmiIdsArgs, opts?: InvokeOptions): Promise<GetAmiIdsResult>
function getAmiIdsOutput(args: GetAmiIdsOutputArgs, opts?: InvokeOptions): Output<GetAmiIdsResult>
def get_ami_ids(executable_users: Optional[Sequence[str]] = None,
                filters: Optional[Sequence[GetAmiIdsFilter]] = None,
                name_regex: Optional[str] = None,
                owners: Optional[Sequence[str]] = None,
                sort_ascending: Optional[bool] = None,
                opts: Optional[InvokeOptions] = None) -> GetAmiIdsResult
def get_ami_ids_output(executable_users: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAmiIdsFilterArgs]]]] = None,
                name_regex: Optional[pulumi.Input[str]] = None,
                owners: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                sort_ascending: Optional[pulumi.Input[bool]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAmiIdsResult]
func GetAmiIds(ctx *Context, args *GetAmiIdsArgs, opts ...InvokeOption) (*GetAmiIdsResult, error)
func GetAmiIdsOutput(ctx *Context, args *GetAmiIdsOutputArgs, opts ...InvokeOption) GetAmiIdsResultOutput

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

public static class GetAmiIds 
{
    public static Task<GetAmiIdsResult> InvokeAsync(GetAmiIdsArgs args, InvokeOptions? opts = null)
    public static Output<GetAmiIdsResult> Invoke(GetAmiIdsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAmiIdsResult> getAmiIds(GetAmiIdsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mypkg:getAmiIds
  arguments:
    # arguments dictionary

The following arguments are supported:

Owners List<string>
List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).
ExecutableUsers List<string>
Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
Filters List<GetAmiIdsFilter>
One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
NameRegex string
A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.
SortAscending bool
Used to sort AMIs by creation time.
Owners []string
List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).
ExecutableUsers []string
Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
Filters []GetAmiIdsFilter
One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
NameRegex string
A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.
SortAscending bool
Used to sort AMIs by creation time.
owners List<String>
List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).
executableUsers List<String>
Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters List<GetAmiIdsFilter>
One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
nameRegex String
A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.
sortAscending Boolean
Used to sort AMIs by creation time.
owners string[]
List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).
executableUsers string[]
Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters GetAmiIdsFilter[]
One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
nameRegex string
A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.
sortAscending boolean
Used to sort AMIs by creation time.
owners Sequence[str]
List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).
executable_users Sequence[str]
Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters Sequence[GetAmiIdsFilter]
One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
name_regex str
A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.
sort_ascending bool
Used to sort AMIs by creation time.
owners List<String>
List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g. amazon, aws-marketplace, microsoft).
executableUsers List<String>
Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters List<Property Map>
One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1].
nameRegex String
A regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. It is recommended to combine this with other options to narrow down the list AWS returns.
sortAscending Boolean
Used to sort AMIs by creation time.

getAmiIds Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Ids List<string>
Owners List<string>
ExecutableUsers List<string>
Filters List<GetAmiIdsFilter>
NameRegex string
SortAscending bool
Id string
The provider-assigned unique ID for this managed resource.
Ids []string
Owners []string
ExecutableUsers []string
Filters []GetAmiIdsFilter
NameRegex string
SortAscending bool
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
owners List<String>
executableUsers List<String>
filters List<GetAmiIdsFilter>
nameRegex String
sortAscending Boolean
id string
The provider-assigned unique ID for this managed resource.
ids string[]
owners string[]
executableUsers string[]
filters GetAmiIdsFilter[]
nameRegex string
sortAscending boolean
id str
The provider-assigned unique ID for this managed resource.
ids Sequence[str]
owners Sequence[str]
executable_users Sequence[str]
filters Sequence[GetAmiIdsFilter]
name_regex str
sort_ascending bool
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
owners List<String>
executableUsers List<String>
filters List<Property Map>
nameRegex String
sortAscending Boolean

Supporting Types

GetAmiIdsFilter

Name string
Values List<string>
Name string
Values []string
name String
values List<String>
name string
values string[]
name str
values Sequence[str]
name String
values List<String>

Package Details

Repository
mypkg
License