| Package | Description |
|---|---|
| software.amazon.awscdk.services.apigateway |
Amazon API Gateway Construct Library
|
| Modifier and Type | Method and Description |
|---|---|
LambdaRestApi.Builder |
LambdaRestApi.Builder.apiKeySourceType(ApiKeySourceType apiKeySourceType)
(experimental) The source of the API key for metering requests according to a usage plan.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.binaryMediaTypes(List<String> binaryMediaTypes)
(experimental) The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.cloneFrom(IRestApi cloneFrom)
(experimental) The ID of the API Gateway RestApi resource that you want to clone.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.cloudWatchRole(Boolean cloudWatchRole)
(experimental) Automatically configure an AWS CloudWatch role for API Gateway.
|
static LambdaRestApi.Builder |
LambdaRestApi.Builder.create(software.constructs.Construct scope,
String id) |
LambdaRestApi.Builder |
LambdaRestApi.Builder.defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)
(experimental) Adds a CORS preflight OPTIONS method to this resource and all child resources.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.defaultIntegration(Integration defaultIntegration)
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.defaultMethodOptions(MethodOptions defaultMethodOptions)
(experimental) Method options to use as a default for all methods created within this API unless custom options are specified.
|
LambdaRestApi.Builder |
LambdaRestApi.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.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.deployOptions(StageOptions deployOptions)
(experimental) Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.description(String description)
(experimental) A description of the purpose of this API Gateway RestApi resource.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.domainName(DomainNameOptions domainName)
(experimental) Configure a custom domain name and map it to this API.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.endpointConfiguration(EndpointConfiguration endpointConfiguration)
(experimental) The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.endpointExportName(String endpointExportName)
(experimental) Export name for the CfnOutput containing the API endpoint.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.endpointTypes(List<? extends EndpointType> endpointTypes)
(experimental) A list of the endpoint types of the API.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.failOnWarnings(Boolean failOnWarnings)
(experimental) Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.handler(IFunction handler)
(experimental) The default Lambda function that handles all requests from this API.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.minimumCompressionSize(Number minimumCompressionSize)
(experimental) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.parameters(Map<String,String> parameters)
(experimental) Custom header parameters for the request.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.policy(PolicyDocument policy)
(experimental) A policy document that contains the permissions for this RestApi.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.proxy(Boolean proxy)
(experimental) If true, route all requests to the Lambda Function.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.restApiName(String restApiName)
(experimental) A name for the API Gateway RestApi resource.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.retainDeployments(Boolean retainDeployments)
(experimental) Retains old deployment resources when the API changes.
|
Copyright © 2021. All rights reserved.