Try AWS Native preview for resources not in the classic version.
aws.apigatewayv2.Api
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Manages an Amazon API Gateway Version 2 API.
Note: Amazon API Gateway Version 2 resources are used for creating and deploying WebSocket and HTTP APIs. To create and deploy REST APIs, use Amazon API Gateway Version 1 resources.
Example Usage
Basic WebSocket API
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGatewayV2.Api("example", new()
{
ProtocolType = "WEBSOCKET",
RouteSelectionExpression = "$request.body.action",
});
});
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.NewApi(ctx, "example", &apigatewayv2.ApiArgs{
ProtocolType: pulumi.String("WEBSOCKET"),
RouteSelectionExpression: pulumi.String("$request.body.action"),
})
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.Api;
import com.pulumi.aws.apigatewayv2.ApiArgs;
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) {
var example = new Api("example", ApiArgs.builder()
.protocolType("WEBSOCKET")
.routeSelectionExpression("$request.body.action")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.Api("example",
protocol_type="WEBSOCKET",
route_selection_expression="$request.body.action")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigatewayv2.Api("example", {
protocolType: "WEBSOCKET",
routeSelectionExpression: "$request.body.action",
});
resources:
example:
type: aws:apigatewayv2:Api
properties:
protocolType: WEBSOCKET
routeSelectionExpression: $request.body.action
Basic HTTP API
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGatewayV2.Api("example", 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.NewApi(ctx, "example", &apigatewayv2.ApiArgs{
ProtocolType: pulumi.String("HTTP"),
})
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.Api;
import com.pulumi.aws.apigatewayv2.ApiArgs;
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) {
var example = new Api("example", ApiArgs.builder()
.protocolType("HTTP")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.apigatewayv2.Api("example", protocol_type="HTTP")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigatewayv2.Api("example", {protocolType: "HTTP"});
resources:
example:
type: aws:apigatewayv2:Api
properties:
protocolType: HTTP
Create Api Resource
new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
@overload
def Api(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_key_selection_expression: Optional[str] = None,
body: Optional[str] = None,
cors_configuration: Optional[ApiCorsConfigurationArgs] = None,
credentials_arn: Optional[str] = None,
description: Optional[str] = None,
disable_execute_api_endpoint: Optional[bool] = None,
fail_on_warnings: Optional[bool] = None,
name: Optional[str] = None,
protocol_type: Optional[str] = None,
route_key: Optional[str] = None,
route_selection_expression: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
target: Optional[str] = None,
version: Optional[str] = None)
@overload
def Api(resource_name: str,
args: ApiArgs,
opts: Optional[ResourceOptions] = None)
func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
type: aws:apigatewayv2:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Api Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Api resource accepts the following input properties:
- Protocol
Type string API protocol. Valid values:
HTTP
,WEBSOCKET
.- Api
Key stringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- Body string
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- Cors
Configuration ApiCors Configuration Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- Credentials
Arn string Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- Description string
Description of the API. Must be less than or equal to 1024 characters in length.
- Disable
Execute boolApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- Fail
On boolWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- Name string
Name of the API. Must be less than or equal to 128 characters in length.
- Route
Key string Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- Route
Selection stringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Dictionary<string, string>
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Target string
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- Version string
Version identifier for the API. Must be between 1 and 64 characters in length.
- Protocol
Type string API protocol. Valid values:
HTTP
,WEBSOCKET
.- Api
Key stringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- Body string
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- Cors
Configuration ApiCors Configuration Args Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- Credentials
Arn string Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- Description string
Description of the API. Must be less than or equal to 1024 characters in length.
- Disable
Execute boolApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- Fail
On boolWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- Name string
Name of the API. Must be less than or equal to 128 characters in length.
- Route
Key string Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- Route
Selection stringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- map[string]string
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Target string
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- Version string
Version identifier for the API. Must be between 1 and 64 characters in length.
- protocol
Type String API protocol. Valid values:
HTTP
,WEBSOCKET
.- api
Key StringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- body String
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors
Configuration ApiCors Configuration Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials
Arn String Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description String
Description of the API. Must be less than or equal to 1024 characters in length.
- disable
Execute BooleanApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- fail
On BooleanWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name String
Name of the API. Must be less than or equal to 128 characters in length.
- route
Key String Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route
Selection StringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Map<String,String>
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- target String
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version String
Version identifier for the API. Must be between 1 and 64 characters in length.
- protocol
Type string API protocol. Valid values:
HTTP
,WEBSOCKET
.- api
Key stringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- body string
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors
Configuration ApiCors Configuration Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials
Arn string Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description string
Description of the API. Must be less than or equal to 1024 characters in length.
- disable
Execute booleanApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- fail
On booleanWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name string
Name of the API. Must be less than or equal to 128 characters in length.
- route
Key string Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route
Selection stringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- {[key: string]: string}
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- target string
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version string
Version identifier for the API. Must be between 1 and 64 characters in length.
- protocol_
type str API protocol. Valid values:
HTTP
,WEBSOCKET
.- api_
key_ strselection_ expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- body str
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors_
configuration ApiCors Configuration Args Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials_
arn str Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description str
Description of the API. Must be less than or equal to 1024 characters in length.
- disable_
execute_ boolapi_ endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- fail_
on_ boolwarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name str
Name of the API. Must be less than or equal to 128 characters in length.
- route_
key str Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route_
selection_ strexpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Mapping[str, str]
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- target str
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version str
Version identifier for the API. Must be between 1 and 64 characters in length.
- protocol
Type String API protocol. Valid values:
HTTP
,WEBSOCKET
.- api
Key StringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- body String
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors
Configuration Property Map Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials
Arn String Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description String
Description of the API. Must be less than or equal to 1024 characters in length.
- disable
Execute BooleanApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- fail
On BooleanWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name String
Name of the API. Must be less than or equal to 128 characters in length.
- route
Key String Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route
Selection StringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Map<String>
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- target String
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version String
Version identifier for the API. Must be between 1 and 64 characters in length.
Outputs
All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:
- Api
Endpoint string URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- Arn string
ARN of the API.
- Execution
Arn string ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- Id string
The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- Api
Endpoint string URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- Arn string
ARN of the API.
- Execution
Arn string ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- Id string
The provider-assigned unique ID for this managed resource.
- map[string]string
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- api
Endpoint String URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- arn String
ARN of the API.
- execution
Arn String ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- id String
The provider-assigned unique ID for this managed resource.
- Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- api
Endpoint string URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- arn string
ARN of the API.
- execution
Arn string ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- id string
The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- api_
endpoint str URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- arn str
ARN of the API.
- execution_
arn str ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- id str
The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- api
Endpoint String URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- arn String
ARN of the API.
- execution
Arn String ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- id String
The provider-assigned unique ID for this managed resource.
- Map<String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
Look up Existing Api Resource
Get an existing Api resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApiState, opts?: CustomResourceOptions): Api
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_endpoint: Optional[str] = None,
api_key_selection_expression: Optional[str] = None,
arn: Optional[str] = None,
body: Optional[str] = None,
cors_configuration: Optional[ApiCorsConfigurationArgs] = None,
credentials_arn: Optional[str] = None,
description: Optional[str] = None,
disable_execute_api_endpoint: Optional[bool] = None,
execution_arn: Optional[str] = None,
fail_on_warnings: Optional[bool] = None,
name: Optional[str] = None,
protocol_type: Optional[str] = None,
route_key: Optional[str] = None,
route_selection_expression: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
target: Optional[str] = None,
version: Optional[str] = None) -> Api
func GetApi(ctx *Context, name string, id IDInput, state *ApiState, opts ...ResourceOption) (*Api, error)
public static Api Get(string name, Input<string> id, ApiState? state, CustomResourceOptions? opts = null)
public static Api get(String name, Output<String> id, ApiState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Endpoint string URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- Api
Key stringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- Arn string
ARN of the API.
- Body string
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- Cors
Configuration ApiCors Configuration Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- Credentials
Arn string Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- Description string
Description of the API. Must be less than or equal to 1024 characters in length.
- Disable
Execute boolApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- Execution
Arn string ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- Fail
On boolWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- Name string
Name of the API. Must be less than or equal to 128 characters in length.
- Protocol
Type string API protocol. Valid values:
HTTP
,WEBSOCKET
.- Route
Key string Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- Route
Selection stringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Dictionary<string, string>
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Target string
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- Version string
Version identifier for the API. Must be between 1 and 64 characters in length.
- Api
Endpoint string URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- Api
Key stringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- Arn string
ARN of the API.
- Body string
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- Cors
Configuration ApiCors Configuration Args Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- Credentials
Arn string Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- Description string
Description of the API. Must be less than or equal to 1024 characters in length.
- Disable
Execute boolApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- Execution
Arn string ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- Fail
On boolWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- Name string
Name of the API. Must be less than or equal to 128 characters in length.
- Protocol
Type string API protocol. Valid values:
HTTP
,WEBSOCKET
.- Route
Key string Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- Route
Selection stringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- map[string]string
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Target string
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- Version string
Version identifier for the API. Must be between 1 and 64 characters in length.
- api
Endpoint String URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- api
Key StringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- arn String
ARN of the API.
- body String
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors
Configuration ApiCors Configuration Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials
Arn String Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description String
Description of the API. Must be less than or equal to 1024 characters in length.
- disable
Execute BooleanApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- execution
Arn String ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- fail
On BooleanWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name String
Name of the API. Must be less than or equal to 128 characters in length.
- protocol
Type String API protocol. Valid values:
HTTP
,WEBSOCKET
.- route
Key String Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route
Selection StringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Map<String,String>
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target String
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version String
Version identifier for the API. Must be between 1 and 64 characters in length.
- api
Endpoint string URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- api
Key stringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- arn string
ARN of the API.
- body string
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors
Configuration ApiCors Configuration Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials
Arn string Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description string
Description of the API. Must be less than or equal to 1024 characters in length.
- disable
Execute booleanApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- execution
Arn string ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- fail
On booleanWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name string
Name of the API. Must be less than or equal to 128 characters in length.
- protocol
Type string API protocol. Valid values:
HTTP
,WEBSOCKET
.- route
Key string Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route
Selection stringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- {[key: string]: string}
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target string
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version string
Version identifier for the API. Must be between 1 and 64 characters in length.
- api_
endpoint str URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- api_
key_ strselection_ expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- arn str
ARN of the API.
- body str
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors_
configuration ApiCors Configuration Args Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials_
arn str Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description str
Description of the API. Must be less than or equal to 1024 characters in length.
- disable_
execute_ boolapi_ endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- execution_
arn str ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- fail_
on_ boolwarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name str
Name of the API. Must be less than or equal to 128 characters in length.
- protocol_
type str API protocol. Valid values:
HTTP
,WEBSOCKET
.- route_
key str Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route_
selection_ strexpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Mapping[str, str]
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target str
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version str
Version identifier for the API. Must be between 1 and 64 characters in length.
- api
Endpoint String URI of the API, of the form
https://{api-id}.execute-api.{region}.amazonaws.com
for HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.com
for WebSocket APIs.- api
Key StringSelection Expression An API key selection expression. Valid values:
$context.authorizer.usageIdentifierKey
,$request.header.x-api-key
. Defaults to$request.header.x-api-key
. Applicable for WebSocket APIs.- arn String
ARN of the API.
- body String
An OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
- cors
Configuration Property Map Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
- credentials
Arn String Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
- description String
Description of the API. Must be less than or equal to 1024 characters in length.
- disable
Execute BooleanApi Endpoint Whether clients can invoke the API by using the default
execute-api
endpoint. By default, clients can invoke the API with the default{api_id}.execute-api.{region}.amazonaws.com endpoint
. To require that clients use a custom domain name to invoke the API, disable the default endpoint.- execution
Arn String ARN prefix to be used in an
aws.lambda.Permission
'ssource_arn
attribute or in anaws.iam.Policy
to authorize access to the@connections
API. See the Amazon API Gateway Developer Guide for details.- fail
On BooleanWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to
false
. Applicable for HTTP APIs.- name String
Name of the API. Must be less than or equal to 128 characters in length.
- protocol
Type String API protocol. Valid values:
HTTP
,WEBSOCKET
.- route
Key String Part of quick create. Specifies any route key. Applicable for HTTP APIs.
- route
Selection StringExpression The route selection expression for the API. Defaults to
$request.method $request.path
.- Map<String>
Map of tags to assign to the API. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target String
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be
HTTP_PROXY
orAWS_PROXY
, respectively. Applicable for HTTP APIs.- version String
Version identifier for the API. Must be between 1 and 64 characters in length.
Supporting Types
ApiCorsConfiguration, ApiCorsConfigurationArgs
- Allow
Credentials bool Whether credentials are included in the CORS request.
- Allow
Headers List<string> Set of allowed HTTP headers.
- Allow
Methods List<string> Set of allowed HTTP methods.
- Allow
Origins List<string> Set of allowed origins.
- Expose
Headers List<string> Set of exposed HTTP headers.
- Max
Age int Number of seconds that the browser should cache preflight request results.
- Allow
Credentials bool Whether credentials are included in the CORS request.
- Allow
Headers []string Set of allowed HTTP headers.
- Allow
Methods []string Set of allowed HTTP methods.
- Allow
Origins []string Set of allowed origins.
- Expose
Headers []string Set of exposed HTTP headers.
- Max
Age int Number of seconds that the browser should cache preflight request results.
- allow
Credentials Boolean Whether credentials are included in the CORS request.
- allow
Headers List<String> Set of allowed HTTP headers.
- allow
Methods List<String> Set of allowed HTTP methods.
- allow
Origins List<String> Set of allowed origins.
- expose
Headers List<String> Set of exposed HTTP headers.
- max
Age Integer Number of seconds that the browser should cache preflight request results.
- allow
Credentials boolean Whether credentials are included in the CORS request.
- allow
Headers string[] Set of allowed HTTP headers.
- allow
Methods string[] Set of allowed HTTP methods.
- allow
Origins string[] Set of allowed origins.
- expose
Headers string[] Set of exposed HTTP headers.
- max
Age number Number of seconds that the browser should cache preflight request results.
- allow_
credentials bool Whether credentials are included in the CORS request.
- allow_
headers Sequence[str] Set of allowed HTTP headers.
- allow_
methods Sequence[str] Set of allowed HTTP methods.
- allow_
origins Sequence[str] Set of allowed origins.
- expose_
headers Sequence[str] Set of exposed HTTP headers.
- max_
age int Number of seconds that the browser should cache preflight request results.
- allow
Credentials Boolean Whether credentials are included in the CORS request.
- allow
Headers List<String> Set of allowed HTTP headers.
- allow
Methods List<String> Set of allowed HTTP methods.
- allow
Origins List<String> Set of allowed origins.
- expose
Headers List<String> Set of exposed HTTP headers.
- max
Age Number Number of seconds that the browser should cache preflight request results.
Import
Using pulumi import
, import aws_apigatewayv2_api
using the API identifier. For example:
$ pulumi import aws:apigatewayv2/api:Api example aabbccddee
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.