aws-native.apigatewayv2.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:
- Api
Id string
- Api
Id string
- api
Id String
- api
Id string
- api_
id str
- api
Id String
getApi Result
The following output properties are available:
- Api
Endpoint string - Api
Id string - Api
Key stringSelection Expression - Cors
Configuration Pulumi.Aws Native. Api Gateway V2. Outputs. Api Cors - Description string
- Disable
Execute boolApi Endpoint - Name string
- Route
Selection stringExpression - object
This resource type use map for Tags, suggest to use List of Tag
- Version string
- Api
Endpoint string - Api
Id string - Api
Key stringSelection Expression - Cors
Configuration ApiCors - Description string
- Disable
Execute boolApi Endpoint - Name string
- Route
Selection stringExpression - interface{}
This resource type use map for Tags, suggest to use List of Tag
- Version string
- api
Endpoint String - api
Id String - api
Key StringSelection Expression - cors
Configuration ApiCors - description String
- disable
Execute BooleanApi Endpoint - name String
- route
Selection StringExpression - Object
This resource type use map for Tags, suggest to use List of Tag
- version String
- api
Endpoint string - api
Id string - api
Key stringSelection Expression - cors
Configuration ApiCors - description string
- disable
Execute booleanApi Endpoint - name string
- route
Selection stringExpression - any
This resource type use map for Tags, suggest to use List of Tag
- version string
- api_
endpoint str - api_
id str - api_
key_ strselection_ expression - cors_
configuration ApiCors - description str
- disable_
execute_ boolapi_ endpoint - name str
- route_
selection_ strexpression - Any
This resource type use map for Tags, suggest to use List of Tag
- version str
- api
Endpoint String - api
Id String - api
Key StringSelection Expression - cors
Configuration Property Map - description String
- disable
Execute BooleanApi Endpoint - name String
- route
Selection StringExpression - Any
This resource type use map for Tags, suggest to use List of Tag
- version String
Supporting Types
ApiCors
- Allow
Credentials bool - Allow
Headers List<string> - Allow
Methods List<string> - Allow
Origins List<string> - Expose
Headers List<string> - Max
Age int
- Allow
Credentials bool - Allow
Headers []string - Allow
Methods []string - Allow
Origins []string - Expose
Headers []string - Max
Age int
- allow
Credentials Boolean - allow
Headers List<String> - allow
Methods List<String> - allow
Origins List<String> - expose
Headers List<String> - max
Age Integer
- allow
Credentials boolean - allow
Headers string[] - allow
Methods string[] - allow
Origins string[] - expose
Headers string[] - max
Age number
- allow_
credentials bool - allow_
headers Sequence[str] - allow_
methods Sequence[str] - allow_
origins Sequence[str] - expose_
headers Sequence[str] - max_
age int
- allow
Credentials Boolean - allow
Headers List<String> - allow
Methods List<String> - allow
Origins List<String> - expose
Headers List<String> - max
Age Number
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0