aws_cdk.aws_apigateway

Package Overview

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.
ApiMappingOptions
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
CfnAuthorizer	A CloudFormation AWS::ApiGateway::Authorizer.
CfnAuthorizerProps
CfnBasePathMapping	A CloudFormation AWS::ApiGateway::BasePathMapping.
CfnBasePathMappingProps
CfnClientCertificate	A CloudFormation AWS::ApiGateway::ClientCertificate.
CfnClientCertificateProps
CfnDeployment	A CloudFormation AWS::ApiGateway::Deployment.
CfnDeploymentProps
CfnDocumentationPart	A CloudFormation AWS::ApiGateway::DocumentationPart.
CfnDocumentationPartProps
CfnDocumentationVersion	A CloudFormation AWS::ApiGateway::DocumentationVersion.
CfnDocumentationVersionProps
CfnDomainName	A CloudFormation AWS::ApiGateway::DomainName.
CfnDomainNameProps
CfnGatewayResponse	A CloudFormation AWS::ApiGateway::GatewayResponse.
CfnGatewayResponseProps
CfnMethod	A CloudFormation AWS::ApiGateway::Method.
CfnMethodProps
CfnModel	A CloudFormation AWS::ApiGateway::Model.
CfnModelProps
CfnRequestValidator	A CloudFormation AWS::ApiGateway::RequestValidator.
CfnRequestValidatorProps
CfnResource	A CloudFormation AWS::ApiGateway::Resource.
CfnResourceProps
CfnRestApi	A CloudFormation AWS::ApiGateway::RestApi.
CfnRestApiProps
CfnStage	A CloudFormation AWS::ApiGateway::Stage.
CfnStageProps
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
EndpointConfiguration
EndpointType
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
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
StageAttributes
StageBase	Base class for an ApiGateway 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