Uses of Class
software.amazon.awscdk.services.apigateway.SpecRestApi.Builder
Packages that use SpecRestApi.Builder
-
Uses of SpecRestApi.Builder in software.amazon.awscdk.services.apigateway
Methods in software.amazon.awscdk.services.apigateway that return SpecRestApi.BuilderModifier and TypeMethodDescriptionSpecRestApi.Builder.apiDefinition(ApiDefinition apiDefinition) An OpenAPI definition compatible with API Gateway.SpecRestApi.Builder.binaryMediaTypes(List<String> binaryMediaTypes) The list of binary media mime-types that are supported by the SpecRestApi resource, such as "image/png" or "application/octet-stream".SpecRestApi.Builder.cloudWatchRole(Boolean cloudWatchRole) Automatically configure an AWS CloudWatch role for API Gateway.SpecRestApi.Builder.cloudWatchRoleRemovalPolicy(RemovalPolicy cloudWatchRoleRemovalPolicy) The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.static SpecRestApi.BuilderIndicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.SpecRestApi.Builder.deployOptions(StageOptions deployOptions) Options for the API Gateway stage that will always point to the latest deployment whendeployis enabled.SpecRestApi.Builder.description(String description) A description of the RestApi construct.SpecRestApi.Builder.disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke the API using the default execute-api endpoint.SpecRestApi.Builder.domainName(DomainNameOptions domainName) Configure a custom domain name and map it to this API.SpecRestApi.Builder.endpointConfiguration(EndpointConfiguration endpointConfiguration) The EndpointConfiguration property type specifies the endpoint types of a REST API.SpecRestApi.Builder.endpointExportName(String endpointExportName) Export name for the CfnOutput containing the API endpoint.SpecRestApi.Builder.endpointTypes(List<? extends EndpointType> endpointTypes) A list of the endpoint types of the API.SpecRestApi.Builder.failOnWarnings(Boolean failOnWarnings) Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.SpecRestApi.Builder.minCompressionSize(Size minCompressionSize) A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.SpecRestApi.Builder.mode(RestApiMode mode) The Mode that determines how API Gateway handles resource updates.SpecRestApi.Builder.parameters(Map<String, String> parameters) Custom header parameters for the request.SpecRestApi.Builder.policy(PolicyDocument policy) A policy document that contains the permissions for this RestApi.SpecRestApi.Builder.restApiName(String restApiName) A name for the API Gateway RestApi resource.SpecRestApi.Builder.retainDeployments(Boolean retainDeployments) Retains old deployment resources when the API changes.