AWS Native is in preview. AWS Classic is fully supported.
aws-native.apigatewayv2.Api
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::ApiGatewayV2::Api
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,
base_path: Optional[str] = None,
body: Optional[Any] = None,
body_s3_location: Optional[ApiBodyS3LocationArgs] = None,
cors_configuration: Optional[ApiCorsArgs] = None,
credentials_arn: Optional[str] = None,
description: Optional[str] = None,
disable_execute_api_endpoint: Optional[bool] = None,
disable_schema_validation: 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[Any] = None,
target: Optional[str] = None,
version: Optional[str] = None)
@overload
def Api(resource_name: str,
args: Optional[ApiArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewApi(ctx *Context, name string, args *ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs? args = null, CustomResourceOptions? opts = null)
type: aws-native: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:
- Api
Key stringSelection Expression - Base
Path string - Body object
- Body
S3Location Pulumi.Aws Native. Api Gateway V2. Inputs. Api Body S3Location - Cors
Configuration Pulumi.Aws Native. Api Gateway V2. Inputs. Api Cors - Credentials
Arn string - Description string
- Disable
Execute boolApi Endpoint - Disable
Schema boolValidation - Fail
On boolWarnings - Name string
- Protocol
Type string - Route
Key string - Route
Selection stringExpression - object
This resource type use map for Tags, suggest to use List of Tag
- Target string
- Version string
- Api
Key stringSelection Expression - Base
Path string - Body interface{}
- Body
S3Location ApiBody S3Location Args - Cors
Configuration ApiCors Args - Credentials
Arn string - Description string
- Disable
Execute boolApi Endpoint - Disable
Schema boolValidation - Fail
On boolWarnings - Name string
- Protocol
Type string - Route
Key string - Route
Selection stringExpression - interface{}
This resource type use map for Tags, suggest to use List of Tag
- Target string
- Version string
- api
Key StringSelection Expression - base
Path String - body Object
- body
S3Location ApiBody S3Location - cors
Configuration ApiCors - credentials
Arn String - description String
- disable
Execute BooleanApi Endpoint - disable
Schema BooleanValidation - fail
On BooleanWarnings - name String
- protocol
Type String - route
Key String - route
Selection StringExpression - Object
This resource type use map for Tags, suggest to use List of Tag
- target String
- version String
- api
Key stringSelection Expression - base
Path string - body any
- body
S3Location ApiBody S3Location - cors
Configuration ApiCors - credentials
Arn string - description string
- disable
Execute booleanApi Endpoint - disable
Schema booleanValidation - fail
On booleanWarnings - name string
- protocol
Type string - route
Key string - route
Selection stringExpression - any
This resource type use map for Tags, suggest to use List of Tag
- target string
- version string
- api_
key_ strselection_ expression - base_
path str - body Any
- body_
s3_ Apilocation Body S3Location Args - cors_
configuration ApiCors Args - credentials_
arn str - description str
- disable_
execute_ boolapi_ endpoint - disable_
schema_ boolvalidation - fail_
on_ boolwarnings - name str
- protocol_
type str - route_
key str - route_
selection_ strexpression - Any
This resource type use map for Tags, suggest to use List of Tag
- target str
- version str
- api
Key StringSelection Expression - base
Path String - body Any
- body
S3Location Property Map - cors
Configuration Property Map - credentials
Arn String - description String
- disable
Execute BooleanApi Endpoint - disable
Schema BooleanValidation - fail
On BooleanWarnings - name String
- protocol
Type String - route
Key String - route
Selection StringExpression - Any
This resource type use map for Tags, suggest to use List of Tag
- target String
- version String
Outputs
All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:
- Api
Endpoint string - Api
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Api
Endpoint string - Api
Id string - Id string
The provider-assigned unique ID for this managed resource.
- api
Endpoint String - api
Id String - id String
The provider-assigned unique ID for this managed resource.
- api
Endpoint string - api
Id string - id string
The provider-assigned unique ID for this managed resource.
- api_
endpoint str - api_
id str - id str
The provider-assigned unique ID for this managed resource.
- api
Endpoint String - api
Id String - id String
The provider-assigned unique ID for this managed resource.
Supporting Types
ApiBodyS3Location, ApiBodyS3LocationArgs
ApiCors, ApiCorsArgs
- 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
AWS Native is in preview. AWS Classic is fully supported.