AccessLogDestinationConfig |
|
AccessLogField |
$context variables that can be used to customize access log pattern. |
AccessLogFormat |
factory methods for access log format. |
AddApiKeyOptions |
|
ApiDefinition |
Represents an OpenAPI definition asset. |
ApiDefinitionConfig |
|
ApiDefinitionS3Location |
|
ApiKey |
An API Gateway ApiKey. |
ApiKeyOptions |
|
ApiKeyProps |
|
ApiKeySourceType |
An enumeration. |
AssetApiDefinition |
OpenAPI specification from a local file. |
AuthorizationType |
|
Authorizer |
Base class for all custom authorizers. |
AwsIntegration |
This type of integration lets an API expose AWS service actions. |
AwsIntegrationProps |
|
BasePathMapping |
This resource creates a base path that clients who call your API must use in the invocation URL. |
BasePathMappingOptions |
|
BasePathMappingProps |
|
CfnAccount |
A CloudFormation AWS::ApiGateway::Account. |
CfnAccountProps |
|
CfnApiKey |
A CloudFormation AWS::ApiGateway::ApiKey. |
CfnApiKeyProps |
|
CfnApiMappingV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::ApiMapping. |
CfnApiMappingV2Props |
|
CfnApiV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::Api. |
CfnApiV2Props |
|
CfnAuthorizer |
A CloudFormation AWS::ApiGateway::Authorizer. |
CfnAuthorizerProps |
|
CfnAuthorizerV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::Authorizer. |
CfnAuthorizerV2Props |
|
CfnBasePathMapping |
A CloudFormation AWS::ApiGateway::BasePathMapping. |
CfnBasePathMappingProps |
|
CfnClientCertificate |
A CloudFormation AWS::ApiGateway::ClientCertificate. |
CfnClientCertificateProps |
|
CfnDeployment |
A CloudFormation AWS::ApiGateway::Deployment. |
CfnDeploymentProps |
|
CfnDeploymentV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::Deployment. |
CfnDeploymentV2Props |
|
CfnDocumentationPart |
A CloudFormation AWS::ApiGateway::DocumentationPart. |
CfnDocumentationPartProps |
|
CfnDocumentationVersion |
A CloudFormation AWS::ApiGateway::DocumentationVersion. |
CfnDocumentationVersionProps |
|
CfnDomainName |
A CloudFormation AWS::ApiGateway::DomainName. |
CfnDomainNameProps |
|
CfnDomainNameV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::DomainName. |
CfnDomainNameV2Props |
|
CfnGatewayResponse |
A CloudFormation AWS::ApiGateway::GatewayResponse. |
CfnGatewayResponseProps |
|
CfnIntegrationResponseV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::IntegrationResponse. |
CfnIntegrationResponseV2Props |
|
CfnIntegrationV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::Integration. |
CfnIntegrationV2Props |
|
CfnMethod |
A CloudFormation AWS::ApiGateway::Method. |
CfnMethodProps |
|
CfnModel |
A CloudFormation AWS::ApiGateway::Model. |
CfnModelProps |
|
CfnModelV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::Model. |
CfnModelV2Props |
|
CfnRequestValidator |
A CloudFormation AWS::ApiGateway::RequestValidator. |
CfnRequestValidatorProps |
|
CfnResource |
A CloudFormation AWS::ApiGateway::Resource. |
CfnResourceProps |
|
CfnRestApi |
A CloudFormation AWS::ApiGateway::RestApi. |
CfnRestApiProps |
|
CfnRouteResponseV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::RouteResponse. |
CfnRouteResponseV2Props |
|
CfnRouteV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::Route. |
CfnRouteV2Props |
|
CfnStage |
A CloudFormation AWS::ApiGateway::Stage. |
CfnStageProps |
|
CfnStageV2 |
(deprecated) A CloudFormation AWS::ApiGatewayV2::Stage. |
CfnStageV2Props |
|
CfnUsagePlan |
A CloudFormation AWS::ApiGateway::UsagePlan. |
CfnUsagePlanKey |
A CloudFormation AWS::ApiGateway::UsagePlanKey. |
CfnUsagePlanKeyProps |
|
CfnUsagePlanProps |
|
CfnVpcLink |
A CloudFormation AWS::ApiGateway::VpcLink. |
CfnVpcLinkProps |
|
CognitoUserPoolsAuthorizer |
Cognito user pools based custom authorizer. |
CognitoUserPoolsAuthorizerProps |
|
ConnectionType |
|
ContentHandling |
|
Cors |
|
CorsOptions |
|
Deployment |
A Deployment of a REST API. |
DeploymentProps |
|
DomainName |
|
DomainNameAttributes |
|
DomainNameOptions |
|
DomainNameProps |
|
EmptyModel |
(deprecated) Represents a reference to a REST API’s Empty model, which is available as part of the model collection by default. |
EndpointConfiguration |
|
EndpointType |
|
ErrorModel |
(deprecated) Represents a reference to a REST API’s Error model, which is available as part of the model collection by default. |
GatewayResponse |
Configure the response received by clients, produced from the API Gateway backend. |
GatewayResponseOptions |
|
GatewayResponseProps |
|
HttpIntegration |
You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,. |
HttpIntegrationProps |
|
IAccessLogDestination |
Access log destination for a RestApi Stage. |
IApiKey |
API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API. |
IAuthorizer |
Represents an API Gateway authorizer. |
IDomainName |
|
IGatewayResponse |
Represents gateway response resource. |
IModel |
|
IRequestValidator |
|
IResource |
|
IRestApi |
|
IStage |
Represents an APIGateway Stage. |
IUsagePlan |
A UsagePlan, either managed by this CDK app, or imported. |
IVpcLink |
Represents an API Gateway VpcLink. |
IdentitySource |
Represents an identity source. |
InlineApiDefinition |
OpenAPI specification from an inline JSON object. |
Integration |
Base class for backend integrations for an API Gateway method. |
IntegrationConfig |
|
IntegrationOptions |
|
IntegrationProps |
|
IntegrationResponse |
|
IntegrationType |
|
JsonSchema |
|
JsonSchemaType |
|
JsonSchemaVersion |
|
JsonWithStandardFieldProps |
|
LambdaAuthorizerProps |
|
LambdaIntegration |
Integrates an AWS Lambda function to an API Gateway method. |
LambdaIntegrationOptions |
|
LambdaRestApi |
Defines an API Gateway REST API with AWS Lambda proxy integration. |
LambdaRestApiProps |
|
LogGroupLogDestination |
Use CloudWatch Logs as a custom access log destination for API Gateway. |
MTLSConfig |
|
Method |
|
MethodDeploymentOptions |
|
MethodLoggingLevel |
|
MethodOptions |
|
MethodProps |
|
MethodResponse |
|
MockIntegration |
This type of integration lets API Gateway return a response without sending the request further to the backend. |
Model |
|
ModelOptions |
|
ModelProps |
|
PassthroughBehavior |
|
Period |
Time period for which quota settings apply. |
ProxyResource |
Defines a {proxy+} greedy resource and an ANY method on a route. |
ProxyResourceOptions |
|
ProxyResourceProps |
|
QuotaSettings |
|
RateLimitedApiKey |
An API Gateway ApiKey, for which a rate limiting configuration can be specified. |
RateLimitedApiKeyProps |
|
RequestAuthorizer |
Request-based lambda authorizer that recognizes the caller’s identity via request parameters, such as headers, paths, query strings, stage variables, or context variables. |
RequestAuthorizerProps |
|
RequestContext |
|
RequestValidator |
|
RequestValidatorOptions |
|
RequestValidatorProps |
|
Resource |
|
ResourceAttributes |
|
ResourceBase |
|
ResourceOptions |
|
ResourceProps |
|
ResponseType |
Supported types of gateway responses. |
RestApi |
Represents a REST API in Amazon API Gateway. |
RestApiAttributes |
|
RestApiBase |
Base implementation that are common to various implementations of IRestApi. |
RestApiBaseProps |
|
RestApiOptions |
|
RestApiProps |
|
S3ApiDefinition |
OpenAPI specification from an S3 archive. |
SecurityPolicy |
The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections. |
SpecRestApi |
Represents a REST API in Amazon API Gateway, created with an OpenAPI specification. |
SpecRestApiProps |
|
Stage |
|
StageOptions |
|
StageProps |
|
StepFunctionsExecutionIntegrationOptions |
|
StepFunctionsIntegration |
Options to integrate with various StepFunction API. |
StepFunctionsRestApi |
Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration. |
StepFunctionsRestApiProps |
|
ThrottleSettings |
|
ThrottlingPerMethod |
|
TokenAuthorizer |
Token based lambda authorizer that recognizes the caller’s identity as a bearer token, such as a JSON Web Token (JWT) or an OAuth token. |
TokenAuthorizerProps |
|
UsagePlan |
|
UsagePlanPerApiStage |
|
UsagePlanProps |
|
VpcLink |
Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC). |
VpcLinkProps |
|