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-22T03:19:15.841Z") @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 classOpenApiOptions.BuilderA builder forOpenApiOptionsstatic classOpenApiOptions.Jsii$ProxyAn implementation forOpenApiOptions
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static OpenApiOptions.Builderbuilder()default software.amazon.awscdk.services.apigateway.CorsOptionsgetCorsOptions()(experimental) Cross Origin Resource Sharing options for the API.default AuthorizergetDefaultAuthorizer()(experimental) The default authorizer to use for your api.Map<String,OpenApiIntegration>getIntegrations()(experimental) A mapping of API operation to its integration.Map<String,MethodAndPath>getOperationLookup()(experimental) Details about each operation.
-
-
-
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.
-
getCorsOptions
@Stability(Experimental) @Nullable default software.amazon.awscdk.services.apigateway.CorsOptions getCorsOptions()
(experimental) Cross Origin Resource Sharing options for the API.
-
getDefaultAuthorizer
@Stability(Experimental) @Nullable default Authorizer getDefaultAuthorizer()
(experimental) The default authorizer to use for your api.When omitted, no authorizer is used. Authorizers specified at the integration level will override this for that operation.
-
builder
@Stability(Experimental) static OpenApiOptions.Builder builder()
- Returns:
- a
OpenApiOptions.BuilderofOpenApiOptions
-
-