| Package | Description |
|---|---|
| software.amazon.awscdk.services.apigateway |
Amazon API Gateway Construct Library
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsIntegration
(experimental) This type of integration lets an API expose AWS service actions.
|
class |
HttpIntegration
(experimental) You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.
|
class |
LambdaIntegration
(experimental) Integrates an AWS Lambda function to an API Gateway method.
|
class |
MockIntegration
(experimental) This type of integration lets API Gateway return a response without sending the request further to the backend.
|
| Modifier and Type | Method and Description |
|---|---|
Integration |
Integration.Builder.build() |
default Integration |
IResource.getDefaultIntegration()
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
Integration |
IResource.Jsii$Proxy.getDefaultIntegration()
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
default Integration |
IResource.Jsii$Default.getDefaultIntegration()
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
default Integration |
ResourceOptions.getDefaultIntegration()
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
Integration |
ResourceOptions.Jsii$Proxy.getDefaultIntegration() |
Integration |
LambdaRestApiProps.Jsii$Proxy.getDefaultIntegration() |
Integration |
ApiKeyProps.Jsii$Proxy.getDefaultIntegration() |
Integration |
ResourceProps.Jsii$Proxy.getDefaultIntegration() |
Integration |
ProxyResourceProps.Jsii$Proxy.getDefaultIntegration() |
Integration |
Resource.getDefaultIntegration()
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
Integration |
RestApiProps.Jsii$Proxy.getDefaultIntegration() |
Integration |
ApiKeyOptions.Jsii$Proxy.getDefaultIntegration() |
Integration |
ProxyResourceOptions.Jsii$Proxy.getDefaultIntegration() |
Integration |
RateLimitedApiKeyProps.Jsii$Proxy.getDefaultIntegration() |
abstract Integration |
ResourceBase.getDefaultIntegration()
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
default Integration |
MethodProps.getIntegration()
(experimental) The backend system that the method calls when it receives a request.
|
Integration |
MethodProps.Jsii$Proxy.getIntegration() |
| Modifier and Type | Method and Description |
|---|---|
Method |
IResource.addMethod(String httpMethod,
Integration target)
(experimental) Defines a new method for this resource.
|
Method |
IResource.Jsii$Proxy.addMethod(String httpMethod,
Integration target)
(experimental) Defines a new method for this resource.
|
Method |
ProxyResource.addMethod(String httpMethod,
Integration integration)
(experimental) Defines a new method for this resource.
|
Method |
ResourceBase.addMethod(String httpMethod,
Integration integration)
(experimental) Defines a new method for this resource.
|
Method |
IResource.addMethod(String httpMethod,
Integration target,
MethodOptions options)
(experimental) Defines a new method for this resource.
|
Method |
IResource.Jsii$Proxy.addMethod(String httpMethod,
Integration target,
MethodOptions options)
(experimental) Defines a new method for this resource.
|
default Method |
IResource.Jsii$Default.addMethod(String httpMethod,
Integration target,
MethodOptions options)
(experimental) Defines a new method for this resource.
|
Method |
ProxyResource.addMethod(String httpMethod,
Integration integration,
MethodOptions options)
(experimental) Defines a new method for this resource.
|
Method |
ResourceBase.addMethod(String httpMethod,
Integration integration,
MethodOptions options)
(experimental) Defines a new method for this resource.
|
ResourceOptions.Builder |
ResourceOptions.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
LambdaRestApiProps.Builder |
LambdaRestApiProps.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
RestApi.Builder |
RestApi.Builder.defaultIntegration(Integration defaultIntegration)
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
LambdaRestApi.Builder |
LambdaRestApi.Builder.defaultIntegration(Integration defaultIntegration)
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
ApiKeyProps.Builder |
ApiKeyProps.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
ResourceProps.Builder |
ResourceProps.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
ProxyResourceProps.Builder |
ProxyResourceProps.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
Resource.Builder |
Resource.Builder.defaultIntegration(Integration defaultIntegration)
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
ApiKey.Builder |
ApiKey.Builder.defaultIntegration(Integration defaultIntegration)
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
RestApiProps.Builder |
RestApiProps.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
ApiKeyOptions.Builder |
ApiKeyOptions.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
ProxyResource.Builder |
ProxyResource.Builder.defaultIntegration(Integration defaultIntegration)
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
ProxyResourceOptions.Builder |
ProxyResourceOptions.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
RateLimitedApiKey.Builder |
RateLimitedApiKey.Builder.defaultIntegration(Integration defaultIntegration)
(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
|
RateLimitedApiKeyProps.Builder |
RateLimitedApiKeyProps.Builder.defaultIntegration(Integration defaultIntegration)
Sets the value of
ResourceOptions.getDefaultIntegration() |
MethodProps.Builder |
MethodProps.Builder.integration(Integration integration)
Sets the value of
MethodProps.getIntegration() |
Method.Builder |
Method.Builder.integration(Integration integration)
(experimental) The backend system that the method calls when it receives a request.
|
| 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(Boolean anyMethod,
CorsOptions defaultCorsPreflightOptions,
Integration defaultIntegration,
MethodOptions defaultMethodOptions)
Constructor that initializes the object based on literal property values passed by the
ProxyResourceOptions.Builder. |
Jsii$Proxy(CorsOptions defaultCorsPreflightOptions,
Integration defaultIntegration,
MethodOptions defaultMethodOptions)
Constructor that initializes the object based on literal property values passed by the
ResourceOptions.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(IResource parent,
Boolean anyMethod,
CorsOptions defaultCorsPreflightOptions,
Integration defaultIntegration,
MethodOptions defaultMethodOptions)
Constructor that initializes the object based on literal property values passed by the
ProxyResourceProps.Builder. |
Jsii$Proxy(IResource parent,
String pathPart,
CorsOptions defaultCorsPreflightOptions,
Integration defaultIntegration,
MethodOptions defaultMethodOptions)
Constructor that initializes the object based on literal property values passed by the
ResourceProps.Builder. |
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 httpMethod,
IResource resource,
Integration integration,
MethodOptions options)
Constructor that initializes the object based on literal property values passed by the
MethodProps.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. |
Jsii$Proxy(String apiKeyName,
String value,
CorsOptions defaultCorsPreflightOptions,
Integration defaultIntegration,
MethodOptions defaultMethodOptions)
Constructor that initializes the object based on literal property values passed by the
ApiKeyOptions.Builder. |
Copyright © 2021. All rights reserved.