software.amazon.awscdk.services.apigateway

Interface SpecRestApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, RestApiBaseProps

All Known Implementing Classes:

SpecRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.216Z")
 @Stability(value=Stable)
public interface SpecRestApiProps
extends software.amazon.jsii.JsiiSerializable, RestApiBaseProps

Props to instantiate a new SpecRestApi.

Example:

 Integration integration;
 SpecRestApi api = SpecRestApi.Builder.create(this, "books-api")
         .apiDefinition(ApiDefinition.fromAsset("path-to-file.json"))
         .build();
 Resource booksResource = api.root.addResource("books");
 booksResource.addMethod("GET", integration);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpecRestApiProps.Builder A builder for SpecRestApiProps
static class	SpecRestApiProps.Jsii$Proxy An implementation for SpecRestApiProps

Method Summary

Modifier and Type	Method and Description
static SpecRestApiProps.Builder	builder()
ApiDefinition	getApiDefinition() An OpenAPI definition compatible with API Gateway.

Methods inherited from interface software.amazon.awscdk.services.apigateway.RestApiBaseProps

getCloudWatchRole, getDeploy, getDeployOptions, getDescription, getDisableExecuteApiEndpoint, getDomainName, getEndpointExportName, getEndpointTypes, getFailOnWarnings, getParameters, getPolicy, getRestApiName, getRetainDeployments

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiDefinition

@Stability(value=Stable)
 @NotNull
ApiDefinition getApiDefinition()

An OpenAPI definition compatible with API Gateway.

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html

builder

@Stability(value=Stable)
static SpecRestApiProps.Builder builder()

Specified by:

builder in interface RestApiBaseProps

Returns:

a SpecRestApiProps.Builder of SpecRestApiProps