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.94.0 (build b380f01)",
           date="2024-02-23T02:06:27.582Z")
@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.
default Size	getMinCompressionSize()	A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getCloudWatchRole, getCloudWatchRoleRemovalPolicy, getDeploy, getDeployOptions, getDescription, 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

getMinCompressionSize

@Stability(Stable)
@Nullable
default Size getMinCompressionSize()

A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.

When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Default: - Compression is disabled.

builder

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

Returns:

a SpecRestApiProps.Builder of SpecRestApiProps