Uses of Interface
software.amazon.awscdk.services.apigateway.IRestApi

Packages that use IRestApi

Package	Description
software.amazon.awscdk.services.apigateway	Amazon API Gateway Construct Library
software.amazon.awscdk.services.stepfunctions.tasks	Tasks for AWS Step Functions

Uses of IRestApi in software.amazon.awscdk.services.apigateway

Subinterfaces of IRestApi in software.amazon.awscdk.services.apigateway

Modifier and Type	Interface and Description
static interface	IRestApi.Jsii$Default Internal default implementation for IRestApi.

Classes in software.amazon.awscdk.services.apigateway that implement IRestApi

Modifier and Type	Class and Description
static class	IRestApi.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.
class	LambdaRestApi (experimental) Defines an API Gateway REST API with AWS Lambda proxy integration.
class	RestApi (experimental) Represents a REST API in Amazon API Gateway.
class	RestApiBase (experimental) Base implementation that are common to various implementations of IRestApi.
class	SpecRestApi (experimental) Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.

Methods in software.amazon.awscdk.services.apigateway that return IRestApi

Modifier and Type	Method and Description
static IRestApi	RestApi.fromRestApiAttributes(software.constructs.Construct scope, String id, RestApiAttributes attrs) (experimental) Import an existing RestApi that can be configured with additional Methods and Resources.
static IRestApi	RestApi.fromRestApiId(software.constructs.Construct scope, String id, String restApiId) (experimental) Import an existing RestApi.
IRestApi	IResource.getApi() (experimental) The rest API that this resource is part of.
IRestApi	IResource.Jsii$Proxy.getApi() (experimental) The rest API that this resource is part of.
default IRestApi	IResource.Jsii$Default.getApi() (experimental) The rest API that this resource is part of.
IRestApi	DeploymentProps.getApi() (experimental) The Rest API to deploy.
IRestApi	DeploymentProps.Jsii$Proxy.getApi()
IRestApi	Deployment.getApi()
IRestApi	Resource.getApi() (experimental) The rest API that this resource is part of.
default IRestApi	UsagePlanPerApiStage.getApi() Default: none
IRestApi	UsagePlanPerApiStage.Jsii$Proxy.getApi()
IRestApi	Method.getApi() (experimental) The API Gateway RestApi associated with this method.
abstract IRestApi	ResourceBase.getApi() (experimental) The rest API that this resource is part of.
IRestApi	LambdaRestApiProps.Jsii$Proxy.getCloneFrom()
default IRestApi	RestApiProps.getCloneFrom() (experimental) The ID of the API Gateway RestApi resource that you want to clone.
IRestApi	RestApiProps.Jsii$Proxy.getCloneFrom()
default IRestApi	DomainNameProps.getMapping() (experimental) If specified, all requests to this domain will be mapped to the production deployment of this API.
IRestApi	DomainNameProps.Jsii$Proxy.getMapping()
IRestApi	ModelProps.getRestApi() (experimental) The rest API that this model is part of.
IRestApi	ModelProps.Jsii$Proxy.getRestApi()
IRestApi	Stage.getRestApi() (experimental) RestApi to which this stage is associated.
IRestApi	GatewayResponseProps.getRestApi() (experimental) Rest api resource to target.
IRestApi	GatewayResponseProps.Jsii$Proxy.getRestApi()
IRestApi	IStage.getRestApi() (experimental) RestApi to which this stage is associated.
IRestApi	IStage.Jsii$Proxy.getRestApi() (experimental) RestApi to which this stage is associated.
default IRestApi	IStage.Jsii$Default.getRestApi() (experimental) RestApi to which this stage is associated.
IRestApi	BasePathMappingProps.getRestApi() (experimental) The RestApi resource to target.
IRestApi	BasePathMappingProps.Jsii$Proxy.getRestApi()
IRestApi	RequestValidatorProps.getRestApi() (experimental) The rest API that this model is part of.
IRestApi	RequestValidatorProps.Jsii$Proxy.getRestApi()
IRestApi	ResourceAttributes.getRestApi() (experimental) The rest API that this resource is part of.
IRestApi	ResourceAttributes.Jsii$Proxy.getRestApi()

Methods in software.amazon.awscdk.services.apigateway that return types with arguments of type IRestApi

Modifier and Type	Method and Description
default List<IRestApi>	ApiKeyProps.getResources() (experimental) A list of resources this api key is associated with.
List<IRestApi>	ApiKeyProps.Jsii$Proxy.getResources()
List<IRestApi>	RateLimitedApiKeyProps.Jsii$Proxy.getResources()

Methods in software.amazon.awscdk.services.apigateway with parameters of type IRestApi

Modifier and Type	Method and Description
BasePathMapping	DomainName.addBasePathMapping(IRestApi targetApi) (experimental) Maps this domain to an API endpoint.
BasePathMapping	DomainName.addBasePathMapping(IRestApi targetApi, BasePathMappingOptions options) (experimental) Maps this domain to an API endpoint.
DeploymentProps.Builder	DeploymentProps.Builder.api(IRestApi api) Sets the value of DeploymentProps.getApi()
Deployment.Builder	Deployment.Builder.api(IRestApi api) (experimental) The Rest API to deploy.
UsagePlanPerApiStage.Builder	UsagePlanPerApiStage.Builder.api(IRestApi api) Sets the value of UsagePlanPerApiStage.getApi()
LambdaRestApiProps.Builder	LambdaRestApiProps.Builder.cloneFrom(IRestApi cloneFrom) Sets the value of RestApiProps.getCloneFrom()
RestApi.Builder	RestApi.Builder.cloneFrom(IRestApi cloneFrom) (experimental) The ID of the API Gateway RestApi resource that you want to clone.
LambdaRestApi.Builder	LambdaRestApi.Builder.cloneFrom(IRestApi cloneFrom) (experimental) The ID of the API Gateway RestApi resource that you want to clone.
RestApiProps.Builder	RestApiProps.Builder.cloneFrom(IRestApi cloneFrom) Sets the value of RestApiProps.getCloneFrom()
DomainName.Builder	DomainName.Builder.mapping(IRestApi mapping) (experimental) If specified, all requests to this domain will be mapped to the production deployment of this API.
DomainNameProps.Builder	DomainNameProps.Builder.mapping(IRestApi mapping) Sets the value of DomainNameProps.getMapping()
Model.Builder	Model.Builder.restApi(IRestApi restApi) (experimental) The rest API that this model is part of.
ModelProps.Builder	ModelProps.Builder.restApi(IRestApi restApi) Sets the value of ModelProps.getRestApi()
GatewayResponseProps.Builder	GatewayResponseProps.Builder.restApi(IRestApi restApi) Sets the value of GatewayResponseProps.getRestApi()
BasePathMapping.Builder	BasePathMapping.Builder.restApi(IRestApi restApi) (experimental) The RestApi resource to target.
BasePathMappingProps.Builder	BasePathMappingProps.Builder.restApi(IRestApi restApi) Sets the value of BasePathMappingProps.getRestApi()
GatewayResponse.Builder	GatewayResponse.Builder.restApi(IRestApi restApi) (experimental) Rest api resource to target.
RequestValidatorProps.Builder	RequestValidatorProps.Builder.restApi(IRestApi restApi) Sets the value of RequestValidatorProps.getRestApi()
ResourceAttributes.Builder	ResourceAttributes.Builder.restApi(IRestApi restApi) Sets the value of ResourceAttributes.getRestApi()
RequestValidator.Builder	RequestValidator.Builder.restApi(IRestApi restApi) (experimental) The rest API that this model is part of.

Method parameters in software.amazon.awscdk.services.apigateway with type arguments of type IRestApi

Modifier and Type	Method and Description
ApiKeyProps.Builder	ApiKeyProps.Builder.resources(List<? extends IRestApi> resources) Sets the value of ApiKeyProps.getResources()
ApiKey.Builder	ApiKey.Builder.resources(List<? extends IRestApi> resources) (experimental) A list of resources this api key is associated with.
RateLimitedApiKey.Builder	RateLimitedApiKey.Builder.resources(List<? extends IRestApi> resources) (experimental) A list of resources this api key is associated with.
RateLimitedApiKeyProps.Builder	RateLimitedApiKeyProps.Builder.resources(List<? extends IRestApi> resources) Sets the value of ApiKeyProps.getResources()

Constructors in software.amazon.awscdk.services.apigateway with parameters of type IRestApi

Constructor and Description
Jsii$Proxy(ApiKeySourceType apiKeySourceType, List<String> binaryMediaTypes, IRestApi cloneFrom, String description, EndpointConfiguration endpointConfiguration, Number minimumCompressionSize, CorsOptions defaultCorsPreflightOptions, Integration defaultIntegration, MethodOptions defaultMethodOptions, Boolean cloudWatchRole, Boolean deploy, StageOptions deployOptions, DomainNameOptions domainName, String endpointExportName, List<? extends EndpointType> endpointTypes, Boolean failOnWarnings, Map<String,String> parameters, PolicyDocument policy, String restApiName, Boolean retainDeployments) Constructor that initializes the object based on literal property values passed by the RestApiProps.Builder.
Jsii$Proxy(IDomainName domainName, IRestApi restApi, String basePath, Stage stage) Constructor that initializes the object based on literal property values passed by the BasePathMappingProps.Builder.
Jsii$Proxy(IFunction handler, Boolean proxy, ApiKeySourceType apiKeySourceType, List<String> binaryMediaTypes, IRestApi cloneFrom, String description, EndpointConfiguration endpointConfiguration, Number minimumCompressionSize, CorsOptions defaultCorsPreflightOptions, Integration defaultIntegration, MethodOptions defaultMethodOptions, Boolean cloudWatchRole, Boolean deploy, StageOptions deployOptions, DomainNameOptions domainName, String endpointExportName, List<? extends EndpointType> endpointTypes, Boolean failOnWarnings, Map<String,String> parameters, PolicyDocument policy, String restApiName, Boolean retainDeployments) Constructor that initializes the object based on literal property values passed by the LambdaRestApiProps.Builder.
Jsii$Proxy(IRestApi mapping, ICertificate certificate, String domainName, EndpointType endpointType, MTLSConfig mtls, SecurityPolicy securityPolicy) Constructor that initializes the object based on literal property values passed by the DomainNameProps.Builder.
Jsii$Proxy(IRestApi restApi, JsonSchema schema, String contentType, String description, String modelName) Constructor that initializes the object based on literal property values passed by the ModelProps.Builder.
Jsii$Proxy(IRestApi restApi, ResponseType type, Map<String,String> responseHeaders, String statusCode, Map<String,String> templates) Constructor that initializes the object based on literal property values passed by the GatewayResponseProps.Builder.
Jsii$Proxy(IRestApi api, Stage stage, List<? extends ThrottlingPerMethod> throttle) Constructor that initializes the object based on literal property values passed by the UsagePlanPerApiStage.Builder.
Jsii$Proxy(IRestApi api, String description, Boolean retainDeployments) Constructor that initializes the object based on literal property values passed by the DeploymentProps.Builder.
Jsii$Proxy(IRestApi restApi, String requestValidatorName, Boolean validateRequestBody, Boolean validateRequestParameters) Constructor that initializes the object based on literal property values passed by the RequestValidatorProps.Builder.
Jsii$Proxy(String path, String resourceId, IRestApi restApi) Constructor that initializes the object based on literal property values passed by the ResourceAttributes.Builder.

Constructor parameters in software.amazon.awscdk.services.apigateway with type arguments of type IRestApi

Constructor and Description
Jsii$Proxy(List<? extends UsagePlanPerApiStage> apiStages, QuotaSettings quota, ThrottleSettings throttle, String customerId, String description, Boolean enabled, Boolean generateDistinctId, List<? extends IRestApi> resources, String apiKeyName, String value, CorsOptions defaultCorsPreflightOptions, Integration defaultIntegration, MethodOptions defaultMethodOptions) Constructor that initializes the object based on literal property values passed by the RateLimitedApiKeyProps.Builder.
Jsii$Proxy(String customerId, String description, Boolean enabled, Boolean generateDistinctId, List<? extends IRestApi> resources, String apiKeyName, String value, CorsOptions defaultCorsPreflightOptions, Integration defaultIntegration, MethodOptions defaultMethodOptions) Constructor that initializes the object based on literal property values passed by the ApiKeyProps.Builder.

Uses of IRestApi in software.amazon.awscdk.services.stepfunctions.tasks

Methods in software.amazon.awscdk.services.stepfunctions.tasks that return IRestApi

Modifier and Type	Method and Description
IRestApi	CallApiGatewayRestApiEndpointProps.getApi() (experimental) API to call.
IRestApi	CallApiGatewayRestApiEndpointProps.Jsii$Proxy.getApi()

Methods in software.amazon.awscdk.services.stepfunctions.tasks with parameters of type IRestApi

Modifier and Type	Method and Description
CallApiGatewayRestApiEndpoint.Builder	CallApiGatewayRestApiEndpoint.Builder.api(IRestApi api) (experimental) API to call.
CallApiGatewayRestApiEndpointProps.Builder	CallApiGatewayRestApiEndpointProps.Builder.api(IRestApi api) Sets the value of CallApiGatewayRestApiEndpointProps.getApi()

Constructors in software.amazon.awscdk.services.stepfunctions.tasks with parameters of type IRestApi

Constructor and Description

Jsii$Proxy(IRestApi api, String stageName, HttpMethod method, String apiPath, AuthType authType, TaskInput headers, TaskInput queryParameters, TaskInput requestBody, String comment, Duration heartbeat, String inputPath, IntegrationPattern integrationPattern, String outputPath, String resultPath, Map<String,? extends Object> resultSelector, Duration timeout) Constructor that initializes the object based on literal property values passed by the CallApiGatewayRestApiEndpointProps.Builder.