AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

getApi

Resource Type definition for AWS::ApiGatewayV2::Api

Using getApi

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 getApi(args: GetApiArgs, opts?: InvokeOptions): Promise<GetApiResult>
function getApiOutput(args: GetApiOutputArgs, opts?: InvokeOptions): Output<GetApiResult>
def get_api(api_id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetApiResult]
func LookupApi(ctx *Context, args *LookupApiArgs, opts ...InvokeOption) (*LookupApiResult, error)
func LookupApiOutput(ctx *Context, args *LookupApiOutputArgs, opts ...InvokeOption) LookupApiResultOutput

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

public static class GetApi 
{
    public static Task<GetApiResult> InvokeAsync(GetApiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiResult> Invoke(GetApiInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:apigatewayv2:getApi
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiId string
ApiId string
apiId String
apiId string
api_id str
apiId String

getApi Result

The following output properties are available:

ApiEndpoint string
ApiId string
ApiKeySelectionExpression string
CorsConfiguration Pulumi.AwsNative.ApiGatewayV2.Outputs.ApiCors
Description string
DisableExecuteApiEndpoint bool
Name string
RouteSelectionExpression string
Tags object

This resource type use map for Tags, suggest to use List of Tag

Version string
ApiEndpoint string
ApiId string
ApiKeySelectionExpression string
CorsConfiguration ApiCors
Description string
DisableExecuteApiEndpoint bool
Name string
RouteSelectionExpression string
Tags interface{}

This resource type use map for Tags, suggest to use List of Tag

Version string
apiEndpoint String
apiId String
apiKeySelectionExpression String
corsConfiguration ApiCors
description String
disableExecuteApiEndpoint Boolean
name String
routeSelectionExpression String
tags Object

This resource type use map for Tags, suggest to use List of Tag

version String
apiEndpoint string
apiId string
apiKeySelectionExpression string
corsConfiguration ApiCors
description string
disableExecuteApiEndpoint boolean
name string
routeSelectionExpression string
tags any

This resource type use map for Tags, suggest to use List of Tag

version string
api_endpoint str
api_id str
api_key_selection_expression str
cors_configuration ApiCors
description str
disable_execute_api_endpoint bool
name str
route_selection_expression str
tags Any

This resource type use map for Tags, suggest to use List of Tag

version str
apiEndpoint String
apiId String
apiKeySelectionExpression String
corsConfiguration Property Map
description String
disableExecuteApiEndpoint Boolean
name String
routeSelectionExpression String
tags Any

This resource type use map for Tags, suggest to use List of Tag

version String

Supporting Types

ApiCors

AllowCredentials bool
AllowHeaders List<string>
AllowMethods List<string>
AllowOrigins List<string>
ExposeHeaders List<string>
MaxAge int
allowCredentials Boolean
allowHeaders List<String>
allowMethods List<String>
allowOrigins List<String>
exposeHeaders List<String>
maxAge Integer
allowCredentials boolean
allowHeaders string[]
allowMethods string[]
allowOrigins string[]
exposeHeaders string[]
maxAge number
allow_credentials bool
allow_headers Sequence[str]
allow_methods Sequence[str]
allow_origins Sequence[str]
expose_headers Sequence[str]
max_age int
allowCredentials Boolean
allowHeaders List<String>
allowMethods List<String>
allowOrigins List<String>
exposeHeaders List<String>
maxAge Number

Package Details

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