| Package | Description |
|---|---|
| software.amazon.awscdk.services.apigateway |
Amazon API Gateway Construct Library
|
| software.amazon.awscdk.services.stepfunctions.tasks |
Tasks for AWS Step Functions
|
| Modifier and Type | Interface and Description |
|---|---|
static interface |
IRestApi.Jsii$Default
Internal default implementation for
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
Defines an API Gateway REST API with AWS Lambda proxy integration.
|
class |
RestApi
Represents a REST API in Amazon API Gateway.
|
class |
RestApiBase
Base implementation that are common to various implementations of IRestApi.
|
class |
SpecRestApi
Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.
|
class |
StepFunctionsRestApi
Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.
|
| Modifier and Type | Method and Description |
|---|---|
static IRestApi |
RestApi.fromRestApiAttributes(software.constructs.Construct scope,
String id,
RestApiAttributes attrs)
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)
Import an existing RestApi.
|
IRestApi |
IResource.getApi()
The rest API that this resource is part of.
|
IRestApi |
IResource.Jsii$Proxy.getApi()
The rest API that this resource is part of.
|
default IRestApi |
IResource.Jsii$Default.getApi()
The rest API that this resource is part of.
|
IRestApi |
Method.getApi()
The API Gateway RestApi associated with this method.
|
IRestApi |
DeploymentProps.getApi()
The Rest API to deploy.
|
IRestApi |
DeploymentProps.Jsii$Proxy.getApi() |
default IRestApi |
UsagePlanPerApiStage.getApi()
Default: none
|
IRestApi |
UsagePlanPerApiStage.Jsii$Proxy.getApi() |
abstract IRestApi |
ResourceBase.getApi()
The rest API that this resource is part of.
|
IRestApi |
Deployment.getApi() |
IRestApi |
Resource.getApi()
The rest API that this resource is part of.
|
IRestApi |
StepFunctionsRestApiProps.Jsii$Proxy.getCloneFrom() |
default IRestApi |
RestApiProps.getCloneFrom()
The ID of the API Gateway RestApi resource that you want to clone.
|
IRestApi |
RestApiProps.Jsii$Proxy.getCloneFrom() |
IRestApi |
LambdaRestApiProps.Jsii$Proxy.getCloneFrom() |
default IRestApi |
DomainNameProps.getMapping()
If specified, all requests to this domain will be mapped to the production deployment of this API.
|
IRestApi |
DomainNameProps.Jsii$Proxy.getMapping() |
IRestApi |
ResourceAttributes.getRestApi()
The rest API that this resource is part of.
|
IRestApi |
ResourceAttributes.Jsii$Proxy.getRestApi() |
IRestApi |
RequestValidatorProps.getRestApi()
The rest API that this model is part of.
|
IRestApi |
RequestValidatorProps.Jsii$Proxy.getRestApi() |
IRestApi |
ModelProps.getRestApi()
The rest API that this model is part of.
|
IRestApi |
ModelProps.Jsii$Proxy.getRestApi() |
IRestApi |
Stage.getRestApi()
RestApi to which this stage is associated.
|
IRestApi |
BasePathMappingProps.getRestApi()
The RestApi resource to target.
|
IRestApi |
BasePathMappingProps.Jsii$Proxy.getRestApi() |
IRestApi |
IStage.getRestApi()
RestApi to which this stage is associated.
|
IRestApi |
IStage.Jsii$Proxy.getRestApi()
RestApi to which this stage is associated.
|
default IRestApi |
IStage.Jsii$Default.getRestApi()
RestApi to which this stage is associated.
|
IRestApi |
GatewayResponseProps.getRestApi()
Rest api resource to target.
|
IRestApi |
GatewayResponseProps.Jsii$Proxy.getRestApi() |
| Modifier and Type | Method and Description |
|---|---|
List<IRestApi> |
RateLimitedApiKeyProps.Jsii$Proxy.getResources() |
default List<IRestApi> |
ApiKeyProps.getResources()
A list of resources this api key is associated with.
|
List<IRestApi> |
ApiKeyProps.Jsii$Proxy.getResources() |
| Modifier and Type | Method and Description |
|---|---|
BasePathMapping |
DomainName.addBasePathMapping(IRestApi targetApi)
Maps this domain to an API endpoint.
|
BasePathMapping |
DomainName.addBasePathMapping(IRestApi targetApi,
BasePathMappingOptions options)
Maps this domain to an API endpoint.
|
DeploymentProps.Builder |
DeploymentProps.Builder.api(IRestApi api)
Sets the value of
DeploymentProps.getApi() |
UsagePlanPerApiStage.Builder |
UsagePlanPerApiStage.Builder.api(IRestApi api)
Sets the value of
UsagePlanPerApiStage.getApi() |
Deployment.Builder |
Deployment.Builder.api(IRestApi api)
The Rest API to deploy.
|
void |
ApiDefinition.bindAfterCreate(software.constructs.Construct _scope,
IRestApi _restApi)
Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.
|
void |
AssetApiDefinition.bindAfterCreate(software.constructs.Construct scope,
IRestApi restApi)
Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.cloneFrom(IRestApi cloneFrom)
The ID of the API Gateway RestApi resource that you want to clone.
|
StepFunctionsRestApiProps.Builder |
StepFunctionsRestApiProps.Builder.cloneFrom(IRestApi cloneFrom)
Sets the value of
RestApiProps.getCloneFrom() |
RestApi.Builder |
RestApi.Builder.cloneFrom(IRestApi cloneFrom)
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() |
StepFunctionsRestApi.Builder |
StepFunctionsRestApi.Builder.cloneFrom(IRestApi cloneFrom)
The ID of the API Gateway RestApi resource that you want to clone.
|
LambdaRestApiProps.Builder |
LambdaRestApiProps.Builder.cloneFrom(IRestApi cloneFrom)
Sets the value of
RestApiProps.getCloneFrom() |
DomainName.Builder |
DomainName.Builder.mapping(IRestApi mapping)
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() |
ResourceAttributes.Builder |
ResourceAttributes.Builder.restApi(IRestApi restApi)
Sets the value of
ResourceAttributes.getRestApi() |
RequestValidatorProps.Builder |
RequestValidatorProps.Builder.restApi(IRestApi restApi)
Sets the value of
RequestValidatorProps.getRestApi() |
ModelProps.Builder |
ModelProps.Builder.restApi(IRestApi restApi)
Sets the value of
ModelProps.getRestApi() |
Model.Builder |
Model.Builder.restApi(IRestApi restApi)
The rest API that this model is part of.
|
BasePathMappingProps.Builder |
BasePathMappingProps.Builder.restApi(IRestApi restApi)
Sets the value of
BasePathMappingProps.getRestApi() |
BasePathMapping.Builder |
BasePathMapping.Builder.restApi(IRestApi restApi)
The RestApi resource to target.
|
RequestValidator.Builder |
RequestValidator.Builder.restApi(IRestApi restApi)
The rest API that this model is part of.
|
GatewayResponse.Builder |
GatewayResponse.Builder.restApi(IRestApi restApi)
Rest api resource to target.
|
GatewayResponseProps.Builder |
GatewayResponseProps.Builder.restApi(IRestApi restApi)
Sets the value of
GatewayResponseProps.getRestApi() |
| Modifier and Type | Method and Description |
|---|---|
RateLimitedApiKeyProps.Builder |
RateLimitedApiKeyProps.Builder.resources(List<? extends IRestApi> resources)
Sets the value of
ApiKeyProps.getResources() |
RateLimitedApiKey.Builder |
RateLimitedApiKey.Builder.resources(List<? extends IRestApi> resources)
A list of resources this api key is associated with.
|
ApiKey.Builder |
ApiKey.Builder.resources(List<? extends IRestApi> resources)
A list of resources this api key is associated with.
|
ApiKeyProps.Builder |
ApiKeyProps.Builder.resources(List<? extends IRestApi> resources)
Sets the value of
ApiKeyProps.getResources() |
| Modifier and Type | Method and Description |
|---|---|
IRestApi |
CallApiGatewayRestApiEndpointProps.getApi()
API to call.
|
IRestApi |
CallApiGatewayRestApiEndpointProps.Jsii$Proxy.getApi() |
| Modifier and Type | Method and Description |
|---|---|
CallApiGatewayRestApiEndpointProps.Builder |
CallApiGatewayRestApiEndpointProps.Builder.api(IRestApi api)
Sets the value of
CallApiGatewayRestApiEndpointProps.getApi() |
CallApiGatewayRestApiEndpoint.Builder |
CallApiGatewayRestApiEndpoint.Builder.api(IRestApi api)
API to call.
|
Copyright © 2022. All rights reserved.