| Package | Description |
|---|---|
| software.amazon.awscdk.services.apigateway |
Amazon API Gateway Construct Library
|
| Modifier and Type | Method and Description |
|---|---|
SpecRestApi.Builder |
SpecRestApi.Builder.apiDefinition(ApiDefinition apiDefinition)
(experimental) An OpenAPI definition compatible with API Gateway.
|
SpecRestApi.Builder |
SpecRestApi.Builder.cloudWatchRole(Boolean cloudWatchRole)
(experimental) Automatically configure an AWS CloudWatch role for API Gateway.
|
static SpecRestApi.Builder |
SpecRestApi.Builder.create(software.constructs.Construct scope,
String id) |
SpecRestApi.Builder |
SpecRestApi.Builder.deploy(Boolean deploy)
(experimental) Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
|
SpecRestApi.Builder |
SpecRestApi.Builder.deployOptions(StageOptions deployOptions)
(experimental) Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
|
SpecRestApi.Builder |
SpecRestApi.Builder.domainName(DomainNameOptions domainName)
(experimental) Configure a custom domain name and map it to this API.
|
SpecRestApi.Builder |
SpecRestApi.Builder.endpointExportName(String endpointExportName)
(experimental) Export name for the CfnOutput containing the API endpoint.
|
SpecRestApi.Builder |
SpecRestApi.Builder.endpointTypes(List<? extends EndpointType> endpointTypes)
(experimental) A list of the endpoint types of the API.
|
SpecRestApi.Builder |
SpecRestApi.Builder.failOnWarnings(Boolean failOnWarnings)
(experimental) Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
|
SpecRestApi.Builder |
SpecRestApi.Builder.parameters(Map<String,String> parameters)
(experimental) Custom header parameters for the request.
|
SpecRestApi.Builder |
SpecRestApi.Builder.policy(PolicyDocument policy)
(experimental) A policy document that contains the permissions for this RestApi.
|
SpecRestApi.Builder |
SpecRestApi.Builder.restApiName(String restApiName)
(experimental) A name for the API Gateway RestApi resource.
|
SpecRestApi.Builder |
SpecRestApi.Builder.retainDeployments(Boolean retainDeployments)
(experimental) Retains old deployment resources when the API changes.
|
Copyright © 2021. All rights reserved.