Package software.aws.awsprototypingsdk.openapigateway

Interface OpenApiOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OpenApiGatewayLambdaApiProps

All Known Implementing Classes:

OpenApiGatewayLambdaApiProps.Jsii$Proxy, OpenApiOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.61.0 (build abf4039)",
           date="2022-06-17T03:54:58.805Z")
@Stability(Experimental)
public interface OpenApiOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options required alongside an Open API specification to create API Gateway resources.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OpenApiOptions.Builder	builder()
default software.amazon.awscdk.services.apigateway.AuthorizationType	getAuthType()	(experimental) The authorization type to use for the API.
default software.amazon.awscdk.services.apigateway.CorsOptions	getCorsOptions()	(experimental) Cross Origin Resource Sharing options for the API.
Map<String,OpenApiIntegration>	getIntegrations()	(experimental) A mapping of API operation to its integration.
Map<String,MethodAndPath>	getOperationLookup()	(experimental) Details about each operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIntegrations

@Stability(Experimental)
@NotNull
Map<String,OpenApiIntegration> getIntegrations()

(experimental) A mapping of API operation to its integration.

getOperationLookup

@Stability(Experimental)
@NotNull
Map<String,MethodAndPath> getOperationLookup()

(experimental) Details about each operation.

getAuthType

@Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.apigateway.AuthorizationType getAuthType()

(experimental) The authorization type to use for the API.

getCorsOptions

@Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.apigateway.CorsOptions getCorsOptions()

(experimental) Cross Origin Resource Sharing options for the API.

builder

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

Returns:

a OpenApiOptions.Builder of OpenApiOptions