| Package | Description |
|---|---|
| software.amazon.awscdk.services.apigateway |
Amazon API Gateway Construct Library
|
| Modifier and Type | Method and Description |
|---|---|
CfnRestApi.Builder |
CfnRestApi.Builder.apiKeySourceType(String apiKeySourceType)
The source of the API key for metering requests according to a usage plan.
|
CfnRestApi.Builder |
CfnRestApi.Builder.binaryMediaTypes(List<String> binaryMediaTypes)
The list of binary media types that are supported by the `RestApi` resource.
|
CfnRestApi.Builder |
CfnRestApi.Builder.body(Object body)
An OpenAPI specification that defines a set of RESTful APIs in JSON format.
|
CfnRestApi.Builder |
CfnRestApi.Builder.bodyS3Location(CfnRestApi.S3LocationProperty bodyS3Location)
The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
|
CfnRestApi.Builder |
CfnRestApi.Builder.bodyS3Location(IResolvable bodyS3Location)
The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
|
CfnRestApi.Builder |
CfnRestApi.Builder.cloneFrom(String cloneFrom)
The ID of the `RestApi` resource that you want to clone.
|
static CfnRestApi.Builder |
CfnRestApi.Builder.create(software.constructs.Construct scope,
String id) |
CfnRestApi.Builder |
CfnRestApi.Builder.description(String description)
A description of the `RestApi` resource.
|
CfnRestApi.Builder |
CfnRestApi.Builder.disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
|
CfnRestApi.Builder |
CfnRestApi.Builder.disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
|
CfnRestApi.Builder |
CfnRestApi.Builder.endpointConfiguration(CfnRestApi.EndpointConfigurationProperty endpointConfiguration)
A list of the endpoint types of the API.
|
CfnRestApi.Builder |
CfnRestApi.Builder.endpointConfiguration(IResolvable endpointConfiguration)
A list of the endpoint types of the API.
|
CfnRestApi.Builder |
CfnRestApi.Builder.failOnWarnings(Boolean failOnWarnings)
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource.
|
CfnRestApi.Builder |
CfnRestApi.Builder.failOnWarnings(IResolvable failOnWarnings)
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource.
|
CfnRestApi.Builder |
CfnRestApi.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 (with a null value) on an API.
|
CfnRestApi.Builder |
CfnRestApi.Builder.mode(String mode)
This property applies only when you use OpenAPI to define your REST API.
|
CfnRestApi.Builder |
CfnRestApi.Builder.name(String name)
A name for the `RestApi` resource.
|
CfnRestApi.Builder |
CfnRestApi.Builder.parameters(IResolvable parameters)
Custom header parameters for the request.
|
CfnRestApi.Builder |
CfnRestApi.Builder.parameters(Map<String,String> parameters)
Custom header parameters for the request.
|
CfnRestApi.Builder |
CfnRestApi.Builder.policy(Object policy)
A policy document that contains the permissions for the `RestApi` resource.
|
CfnRestApi.Builder |
CfnRestApi.Builder.tags(List<? extends CfnTag> tags)
An array of arbitrary tags (key-value pairs) to associate with the API.
|
Copyright © 2022. All rights reserved.