Package software.aws.awsprototypingsdk.openapigateway

Interface OpenApiGatewayLambdaApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OpenApiOptions, software.amazon.awscdk.services.apigateway.RestApiBaseProps

All Known Implementing Classes:

OpenApiGatewayLambdaApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-14T10:57:31.347Z")
@Stability(Experimental)
public interface OpenApiGatewayLambdaApiProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.apigateway.RestApiBaseProps, OpenApiOptions

(experimental) Configuration for the OpenApiGatewayLambdaApi construct.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OpenApiGatewayLambdaApiProps.Builder	builder()
Object	getSpec()	(experimental) The parsed OpenAPI specification.
String	getSpecPath()	(experimental) Path to the JSON open api spec.
default OpenApiGatewayWebAclOptions	getWebAclOptions()	(experimental) Options for the AWS WAF v2 WebACL associated with the api.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.aws.awsprototypingsdk.openapigateway.OpenApiOptions

getCorsOptions, getDefaultAuthorizer, getIntegrations, getOperationLookup

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

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

Method Detail

getSpec

@Stability(Experimental)
@NotNull
Object getSpec()

(experimental) The parsed OpenAPI specification.

getSpecPath

@Stability(Experimental)
@NotNull
String getSpecPath()

(experimental) Path to the JSON open api spec.

getWebAclOptions

@Stability(Experimental)
@Nullable
default OpenApiGatewayWebAclOptions getWebAclOptions()

(experimental) Options for the AWS WAF v2 WebACL associated with the api.

By default, a Web ACL with the AWS default managed rule set will be associated with the API. These options may disable or override the defaults.

builder

@Stability(Experimental)
static OpenApiGatewayLambdaApiProps.Builder builder()

Returns:

a OpenApiGatewayLambdaApiProps.Builder of OpenApiGatewayLambdaApiProps