Class: RestApi

ApiGateway.RestApi

new RestApi()

Properties:
Name Type Description
Body Object Required: No. A Swagger specification that defines a set of RESTful APIs in the JSON format. To specify a Swagger file that is in the YAML format, use the BodyS3Location property.Update requires: No interruption
BodyS3Location AmazonAPIGatewayRestApiS3Location Required: No. The Amazon Simple Storage Service (Amazon S3) location that points to a Swagger file, which defines a set of RESTful APIs in JSON or YAML format.Update requires: No interruption
CloneFrom String Required: No. The ID of the API Gateway RestApi resource that you want to clone.Update requires: No interruption
Description String Required: No. A description of the purpose of this API Gateway RestApi resource.Update requires: No interruption
FailOnWarnings Boolean Required: No. If a warning occurs while API Gateway is creating the RestApi resource, indicates whether to roll back the resource.Update requires: No interruption
Name String Required: Conditional. A name for the API Gateway RestApi resource.Update requires: No interruption
Parameters String Required: No. Custom header parameters for the request.Update requires: No interruption
Source:

Extends

  • WKResource

ApiGateway.RestApi

new RestApi()

Properties:
Name Type Description
Body Object Required: No. A Swagger specification that defines a set of RESTful APIs in the JSON format. To specify a Swagger file that is in the YAML format, use the BodyS3Location property.Update requires: No interruption
BodyS3Location AmazonAPIGatewayRestApiS3Location Required: No. The Amazon Simple Storage Service (Amazon S3) location that points to a Swagger file, which defines a set of RESTful APIs in JSON or YAML format.Update requires: No interruption
CloneFrom String Required: No. The ID of the API Gateway RestApi resource that you want to clone.Update requires: No interruption
Description String Required: No. A description of the purpose of this API Gateway RestApi resource.Update requires: No interruption
FailOnWarnings Boolean Required: No. If a warning occurs while API Gateway is creating the RestApi resource, indicates whether to roll back the resource.Update requires: No interruption
Name String Required: Conditional. A name for the API Gateway RestApi resource.Update requires: No interruption
Parameters String Required: No. Custom header parameters for the request.Update requires: No interruption
Source:

Extends

  • WKResource