Docs
PackagesTry AWS Native preview for resources not in the classic version.
aws.apigatewayv2.getApis
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides details about multiple Amazon API Gateway Version 2 APIs.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.ApiGatewayV2.GetApis.Invoke(new()
{
ProtocolType = "HTTP",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigatewayv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigatewayv2.GetApis(ctx, &apigatewayv2.GetApisArgs{
ProtocolType: pulumi.StringRef("HTTP"),
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Apigatewayv2Functions;
import com.pulumi.aws.apigatewayv2.inputs.GetApisArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = Apigatewayv2Functions.getApis(GetApisArgs.builder()
.protocolType("HTTP")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.get_apis(protocol_type="HTTP")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.apigatewayv2.getApis({
protocolType: "HTTP",
});
variables:
example:
fn::invoke:
Function: aws:apigatewayv2:getApis
Arguments:
protocolType: HTTP
Using getApis
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 getApis(args: GetApisArgs, opts?: InvokeOptions): Promise<GetApisResult>
function getApisOutput(args: GetApisOutputArgs, opts?: InvokeOptions): Output<GetApisResult>def get_apis(name: Optional[str] = None,
protocol_type: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetApisResult
def get_apis_output(name: Optional[pulumi.Input[str]] = None,
protocol_type: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApisResult]func GetApis(ctx *Context, args *GetApisArgs, opts ...InvokeOption) (*GetApisResult, error)
func GetApisOutput(ctx *Context, args *GetApisOutputArgs, opts ...InvokeOption) GetApisResultOutput> Note: This function is named GetApis in the Go SDK.
public static class GetApis
{
public static Task<GetApisResult> InvokeAsync(GetApisArgs args, InvokeOptions? opts = null)
public static Output<GetApisResult> Invoke(GetApisInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetApisResult> getApis(GetApisArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:apigatewayv2/getApis:getApis
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
API name.
- Protocol
Type string API protocol.
- Dictionary<string, string>
Map of tags, each pair of which must exactly match a pair on the desired APIs.
- Name string
API name.
- Protocol
Type string API protocol.
- map[string]string
Map of tags, each pair of which must exactly match a pair on the desired APIs.
- name String
API name.
- protocol
Type String API protocol.
- Map<String,String>
Map of tags, each pair of which must exactly match a pair on the desired APIs.
- name string
API name.
- protocol
Type string API protocol.
- {[key: string]: string}
Map of tags, each pair of which must exactly match a pair on the desired APIs.
- name str
API name.
- protocol_
type str API protocol.
- Mapping[str, str]
Map of tags, each pair of which must exactly match a pair on the desired APIs.
- name String
API name.
- protocol
Type String API protocol.
- Map<String>
Map of tags, each pair of which must exactly match a pair on the desired APIs.
getApis Result
The following output properties are available:
- Id string
The provider-assigned unique ID for this managed resource.
- Ids List<string>
Set of API identifiers.
- Name string
- Protocol
Type string - Dictionary<string, string>
- Id string
The provider-assigned unique ID for this managed resource.
- Ids []string
Set of API identifiers.
- Name string
- Protocol
Type string - map[string]string
- id String
The provider-assigned unique ID for this managed resource.
- ids List<String>
Set of API identifiers.
- name String
- protocol
Type String - Map<String,String>
- id string
The provider-assigned unique ID for this managed resource.
- ids string[]
Set of API identifiers.
- name string
- protocol
Type string - {[key: string]: string}
- id str
The provider-assigned unique ID for this managed resource.
- ids Sequence[str]
Set of API identifiers.
- name str
- protocol_
type str - Mapping[str, str]
- id String
The provider-assigned unique ID for this managed resource.
- ids List<String>
Set of API identifiers.
- name String
- protocol
Type String - Map<String>
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
awsTerraform Provider.
Try AWS Native preview for resources not in the classic version.