@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:58.324Z") public interface RestApiProps extends RestApiOptions
Example:
StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine") .stateMachineType(StateMachineType.EXPRESS) .definition(Chain.start(new Pass(this, "Pass"))) .build(); RestApi api = RestApi.Builder.create(this, "Api") .restApiName("MyApi") .build(); api.root.addMethod("GET", StepFunctionsIntegration.startExecution(stateMachine));
Modifier and Type | Interface and Description |
---|---|
static class |
RestApiProps.Builder
A builder for
RestApiProps |
static class |
RestApiProps.Jsii$Proxy
An implementation for
RestApiProps |
Modifier and Type | Method and Description |
---|---|
static RestApiProps.Builder |
builder() |
default ApiKeySourceType |
getApiKeySourceType()
The source of the API key for metering requests according to a usage plan.
|
default java.util.List<java.lang.String> |
getBinaryMediaTypes()
The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
|
default IRestApi |
getCloneFrom()
The ID of the API Gateway RestApi resource that you want to clone.
|
default java.lang.String |
getDescription()
A description of the purpose of this API Gateway RestApi resource.
|
default EndpointConfiguration |
getEndpointConfiguration()
The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
default java.lang.Number |
getMinimumCompressionSize()
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.
|
getCloudWatchRole, getDeploy, getDeployOptions, getDisableExecuteApiEndpoint, getDomainName, getEndpointExportName, getEndpointTypes, getFailOnWarnings, getParameters, getPolicy, getRestApiName, getRetainDeployments
getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions
default ApiKeySourceType getApiKeySourceType()
Default: - Metering is disabled.
default java.util.List<java.lang.String> getBinaryMediaTypes()
Default: - RestApi supports only UTF-8-encoded text payloads.
default IRestApi getCloneFrom()
Default: - None.
default java.lang.String getDescription()
Default: - No description.
default EndpointConfiguration getEndpointConfiguration()
Default: EndpointType.EDGE
default java.lang.Number getMinimumCompressionSize()
When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Default: - Compression is disabled.
static RestApiProps.Builder builder()
builder
in interface ResourceOptions
builder
in interface RestApiBaseProps
builder
in interface RestApiOptions
RestApiProps.Builder
of RestApiProps