Package software.aws.awsprototypingsdk.openapigateway

Interface OpenApiGatewayRestApiProps

All Superinterfaces:

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

All Known Implementing Classes:

OpenApiGatewayRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T04:12:25.066Z")
@Stability(Experimental)
public interface OpenApiGatewayRestApiProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.apigateway.RestApiBaseProps, OpenApiOptions

(experimental) Configuration for the OpenApiGatewayRestApi construct.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OpenApiGatewayRestApiProps.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 OpenApiGatewayRestApiProps.Builder builder()

Returns:

a OpenApiGatewayRestApiProps.Builder of OpenApiGatewayRestApiProps