Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.091Z")
@Stability(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	Description
static final class	SpecRestApiProps.Builder	A builder for SpecRestApiProps
static final class	SpecRestApiProps.Jsii$Proxy	An implementation for SpecRestApiProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

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

Method Details

getApiDefinition

@Stability(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(Stable)
static SpecRestApiProps.Builder builder()

Returns:

a SpecRestApiProps.Builder of SpecRestApiProps