Uses of Class
software.amazon.awscdk.services.apigateway.RestApi.Builder

Packages that use RestApi.Builder

Package	Description
software.amazon.awscdk.services.apigateway	Amazon API Gateway Construct Library

Uses of RestApi.Builder in software.amazon.awscdk.services.apigateway

Methods in software.amazon.awscdk.services.apigateway that return RestApi.Builder

Modifier and Type	Method	Description
RestApi.Builder	RestApi.Builder.apiKeySourceType(ApiKeySourceType apiKeySourceType)	The source of the API key for metering requests according to a usage plan.
RestApi.Builder	RestApi.Builder.binaryMediaTypes(List<String> binaryMediaTypes)	The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
RestApi.Builder	RestApi.Builder.cloneFrom(IRestApi cloneFrom)	The ID of the API Gateway RestApi resource that you want to clone.
RestApi.Builder	RestApi.Builder.cloudWatchRole(Boolean cloudWatchRole)	Automatically configure an AWS CloudWatch role for API Gateway.
static RestApi.Builder	RestApi.Builder.create(software.constructs.Construct scope, String id)
RestApi.Builder	RestApi.Builder.defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)	Adds a CORS preflight OPTIONS method to this resource and all child resources.
RestApi.Builder	RestApi.Builder.defaultIntegration(Integration defaultIntegration)	An integration to use as a default for all methods created within this API unless an integration is specified.
RestApi.Builder	RestApi.Builder.defaultMethodOptions(MethodOptions defaultMethodOptions)	Method options to use as a default for all methods created within this API unless custom options are specified.
RestApi.Builder	RestApi.Builder.deploy(Boolean deploy)	Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
RestApi.Builder	RestApi.Builder.deployOptions(StageOptions deployOptions)	Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.
RestApi.Builder	RestApi.Builder.description(String description)	A description of the purpose of this API Gateway RestApi resource.
RestApi.Builder	RestApi.Builder.disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)	Specifies whether clients can invoke the API using the default execute-api endpoint.
RestApi.Builder	RestApi.Builder.domainName(DomainNameOptions domainName)	Configure a custom domain name and map it to this API.
RestApi.Builder	RestApi.Builder.endpointConfiguration(EndpointConfiguration endpointConfiguration)	The EndpointConfiguration property type specifies the endpoint types of a REST API.
RestApi.Builder	RestApi.Builder.endpointExportName(String endpointExportName)	Export name for the CfnOutput containing the API endpoint.
RestApi.Builder	RestApi.Builder.endpointTypes(List<? extends EndpointType> endpointTypes)	A list of the endpoint types of the API.
RestApi.Builder	RestApi.Builder.failOnWarnings(Boolean failOnWarnings)	Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
RestApi.Builder	RestApi.Builder.minimumCompressionSize(Number minimumCompressionSize)	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.
RestApi.Builder	RestApi.Builder.parameters(Map<String,String> parameters)	Custom header parameters for the request.
RestApi.Builder	RestApi.Builder.policy(PolicyDocument policy)	A policy document that contains the permissions for this RestApi.
RestApi.Builder	RestApi.Builder.restApiName(String restApiName)	A name for the API Gateway RestApi resource.
RestApi.Builder	RestApi.Builder.retainDeployments(Boolean retainDeployments)	Retains old deployment resources when the API changes.