software.amazon.awscdk.services.apigateway

Interface RestApiProps

All Superinterfaces:

ResourceOptions, RestApiBaseProps, RestApiOptions

All Known Subinterfaces:

LambdaRestApiProps, StepFunctionsRestApiProps

All Known Implementing Classes:

LambdaRestApiProps.Jsii$Proxy, RestApiProps.Jsii$Proxy, StepFunctionsRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:58.324Z")
public interface RestApiProps
extends RestApiOptions

Props to create a new instance of RestApi.

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));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RestApiProps.Builder A builder for RestApiProps
static class	RestApiProps.Jsii$Proxy An implementation for RestApiProps

Method Summary

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.

Methods inherited from interface software.amazon.awscdk.services.apigateway.RestApiBaseProps

getCloudWatchRole, getDeploy, getDeployOptions, getDisableExecuteApiEndpoint, getDomainName, getEndpointExportName, getEndpointTypes, getFailOnWarnings, getParameters, getPolicy, getRestApiName, getRetainDeployments

Methods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Method Detail

getApiKeySourceType

default ApiKeySourceType getApiKeySourceType()

The source of the API key for metering requests according to a usage plan.

Default: - Metering is disabled.

getBinaryMediaTypes

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: - RestApi supports only UTF-8-encoded text payloads.

getCloneFrom

default IRestApi getCloneFrom()

The ID of the API Gateway RestApi resource that you want to clone.

Default: - None.

getDescription

default java.lang.String getDescription()

A description of the purpose of this API Gateway RestApi resource.

Default: - No description.

getEndpointConfiguration

default EndpointConfiguration getEndpointConfiguration()

The EndpointConfiguration property type specifies the endpoint types of a REST API.

Default: EndpointType.EDGE

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

getMinimumCompressionSize

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.

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.

builder

static RestApiProps.Builder builder()

Specified by:

builder in interface ResourceOptions

Specified by:

builder in interface RestApiBaseProps

Specified by:

builder in interface RestApiOptions

Returns:

a RestApiProps.Builder of RestApiProps