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.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.900Z")
 @Stability(value=Experimental)
public interface SpecRestApiProps
extends software.amazon.jsii.JsiiSerializable, RestApiBaseProps

(experimental) Props to instantiate a new SpecRestApi.

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() (experimental) An OpenAPI definition compatible with API Gateway.

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

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiDefinition

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

(experimental) 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=Experimental)
static SpecRestApiProps.Builder builder()

Specified by:

builder in interface RestApiBaseProps

Returns:

a SpecRestApiProps.Builder of SpecRestApiProps