Uses of Package
software.amazon.awscdk.services.apigateway

Packages that use software.amazon.awscdk.services.apigateway

Package	Description
software.amazon.awscdk.services.apigateway	Amazon API Gateway Construct Library
software.amazon.awscdk.services.events.targets	Event Targets for Amazon EventBridge
software.amazon.awscdk.services.lambda.eventsources	AWS Lambda Event Sources
software.amazon.awscdk.services.route53.targets	Route53 Alias Record Targets for the CDK Route53 Library
software.amazon.awscdk.services.stepfunctions.tasks	Tasks for AWS Step Functions

Classes in software.amazon.awscdk.services.apigateway used by software.amazon.awscdk.services.apigateway

Class and Description
AccessLogDestinationConfig Options when binding a log destination to a RestApi Stage.
AccessLogDestinationConfig.Builder A builder for AccessLogDestinationConfig
AccessLogFormat factory methods for access log format.
AddApiKeyOptions Options to the UsagePlan.addApiKey() method.
AddApiKeyOptions.Builder A builder for AddApiKeyOptions
ApiDefinition Represents an OpenAPI definition asset.
ApiDefinitionConfig Post-Binding Configuration for a CDK construct.
ApiDefinitionConfig.Builder A builder for ApiDefinitionConfig
ApiDefinitionS3Location S3 location of the API definition file.
ApiDefinitionS3Location.Builder A builder for ApiDefinitionS3Location
ApiKey An API Gateway ApiKey.
ApiKey.Builder A fluent builder for ApiKey.
ApiKeyOptions The options for creating an API Key.
ApiKeyOptions.Builder A builder for ApiKeyOptions
ApiKeyProps ApiKey Properties.
ApiKeyProps.Builder A builder for ApiKeyProps
ApiKeySourceType
AssetApiDefinition OpenAPI specification from a local file.
AssetApiDefinition.Builder A fluent builder for AssetApiDefinition.
AuthorizationType Example:
Authorizer Base class for all custom authorizers.
AwsIntegration This type of integration lets an API expose AWS service actions.
AwsIntegration.Builder A fluent builder for AwsIntegration.
AwsIntegrationProps Example:
AwsIntegrationProps.Builder A builder for AwsIntegrationProps
BasePathMapping This resource creates a base path that clients who call your API must use in the invocation URL.
BasePathMapping.Builder A fluent builder for BasePathMapping.
BasePathMappingOptions Example:
BasePathMappingOptions.Builder A builder for BasePathMappingOptions
BasePathMappingProps Example:
BasePathMappingProps.Builder A builder for BasePathMappingProps
CfnAccount A CloudFormation `AWS::ApiGateway::Account`.
CfnAccount.Builder A fluent builder for CfnAccount.
CfnAccountProps Properties for defining a `AWS::ApiGateway::Account`.
CfnAccountProps.Builder A builder for CfnAccountProps
CfnApiKey A CloudFormation `AWS::ApiGateway::ApiKey`.
CfnApiKey.Builder A fluent builder for CfnApiKey.
CfnApiKey.StageKeyProperty Example:
CfnApiKey.StageKeyProperty.Builder A builder for CfnApiKey.StageKeyProperty
CfnApiKeyProps Properties for defining a `AWS::ApiGateway::ApiKey`.
CfnApiKeyProps.Builder A builder for CfnApiKeyProps
CfnAuthorizer A CloudFormation `AWS::ApiGateway::Authorizer`.
CfnAuthorizer.Builder A fluent builder for CfnAuthorizer.
CfnAuthorizerProps Properties for defining a `AWS::ApiGateway::Authorizer`.
CfnAuthorizerProps.Builder A builder for CfnAuthorizerProps
CfnBasePathMapping A CloudFormation `AWS::ApiGateway::BasePathMapping`.
CfnBasePathMapping.Builder A fluent builder for CfnBasePathMapping.
CfnBasePathMappingProps Properties for defining a `AWS::ApiGateway::BasePathMapping`.
CfnBasePathMappingProps.Builder A builder for CfnBasePathMappingProps
CfnClientCertificate A CloudFormation `AWS::ApiGateway::ClientCertificate`.
CfnClientCertificate.Builder A fluent builder for CfnClientCertificate.
CfnClientCertificateProps Properties for defining a `AWS::ApiGateway::ClientCertificate`.
CfnClientCertificateProps.Builder A builder for CfnClientCertificateProps
CfnDeployment A CloudFormation `AWS::ApiGateway::Deployment`.
CfnDeployment.AccessLogSettingProperty Example:
CfnDeployment.AccessLogSettingProperty.Builder A builder for CfnDeployment.AccessLogSettingProperty
CfnDeployment.Builder A fluent builder for CfnDeployment.
CfnDeployment.CanarySettingProperty Example:
CfnDeployment.CanarySettingProperty.Builder A builder for CfnDeployment.CanarySettingProperty
CfnDeployment.DeploymentCanarySettingsProperty Example:
CfnDeployment.DeploymentCanarySettingsProperty.Builder A builder for CfnDeployment.DeploymentCanarySettingsProperty
CfnDeployment.MethodSettingProperty Example:
CfnDeployment.MethodSettingProperty.Builder A builder for CfnDeployment.MethodSettingProperty
CfnDeployment.StageDescriptionProperty Example:
CfnDeployment.StageDescriptionProperty.Builder A builder for CfnDeployment.StageDescriptionProperty
CfnDeploymentProps Properties for defining a `AWS::ApiGateway::Deployment`.
CfnDeploymentProps.Builder A builder for CfnDeploymentProps
CfnDocumentationPart A CloudFormation `AWS::ApiGateway::DocumentationPart`.
CfnDocumentationPart.Builder A fluent builder for CfnDocumentationPart.
CfnDocumentationPart.LocationProperty Example:
CfnDocumentationPart.LocationProperty.Builder A builder for CfnDocumentationPart.LocationProperty
CfnDocumentationPartProps Properties for defining a `AWS::ApiGateway::DocumentationPart`.
CfnDocumentationPartProps.Builder A builder for CfnDocumentationPartProps
CfnDocumentationVersion A CloudFormation `AWS::ApiGateway::DocumentationVersion`.
CfnDocumentationVersion.Builder A fluent builder for CfnDocumentationVersion.
CfnDocumentationVersionProps Properties for defining a `AWS::ApiGateway::DocumentationVersion`.
CfnDocumentationVersionProps.Builder A builder for CfnDocumentationVersionProps
CfnDomainName A CloudFormation `AWS::ApiGateway::DomainName`.
CfnDomainName.Builder A fluent builder for CfnDomainName.
CfnDomainName.EndpointConfigurationProperty Example:
CfnDomainName.EndpointConfigurationProperty.Builder A builder for CfnDomainName.EndpointConfigurationProperty
CfnDomainName.MutualTlsAuthenticationProperty Example:
CfnDomainName.MutualTlsAuthenticationProperty.Builder A builder for CfnDomainName.MutualTlsAuthenticationProperty
CfnDomainNameProps Properties for defining a `AWS::ApiGateway::DomainName`.
CfnDomainNameProps.Builder A builder for CfnDomainNameProps
CfnGatewayResponse A CloudFormation `AWS::ApiGateway::GatewayResponse`.
CfnGatewayResponse.Builder A fluent builder for CfnGatewayResponse.
CfnGatewayResponseProps Properties for defining a `AWS::ApiGateway::GatewayResponse`.
CfnGatewayResponseProps.Builder A builder for CfnGatewayResponseProps
CfnMethod A CloudFormation `AWS::ApiGateway::Method`.
CfnMethod.Builder A fluent builder for CfnMethod.
CfnMethod.IntegrationProperty Example:
CfnMethod.IntegrationProperty.Builder A builder for CfnMethod.IntegrationProperty
CfnMethod.IntegrationResponseProperty Example:
CfnMethod.IntegrationResponseProperty.Builder A builder for CfnMethod.IntegrationResponseProperty
CfnMethod.MethodResponseProperty Example:
CfnMethod.MethodResponseProperty.Builder A builder for CfnMethod.MethodResponseProperty
CfnMethodProps Properties for defining a `AWS::ApiGateway::Method`.
CfnMethodProps.Builder A builder for CfnMethodProps
CfnModel A CloudFormation `AWS::ApiGateway::Model`.
CfnModel.Builder A fluent builder for CfnModel.
CfnModelProps Properties for defining a `AWS::ApiGateway::Model`.
CfnModelProps.Builder A builder for CfnModelProps
CfnRequestValidator A CloudFormation `AWS::ApiGateway::RequestValidator`.
CfnRequestValidator.Builder A fluent builder for CfnRequestValidator.
CfnRequestValidatorProps Properties for defining a `AWS::ApiGateway::RequestValidator`.
CfnRequestValidatorProps.Builder A builder for CfnRequestValidatorProps
CfnResource A CloudFormation `AWS::ApiGateway::Resource`.
CfnResource.Builder A fluent builder for CfnResource.
CfnResourceProps Properties for defining a `AWS::ApiGateway::Resource`.
CfnResourceProps.Builder A builder for CfnResourceProps
CfnRestApi A CloudFormation `AWS::ApiGateway::RestApi`.
CfnRestApi.Builder A fluent builder for CfnRestApi.
CfnRestApi.EndpointConfigurationProperty Example:
CfnRestApi.EndpointConfigurationProperty.Builder A builder for CfnRestApi.EndpointConfigurationProperty
CfnRestApi.S3LocationProperty Example:
CfnRestApi.S3LocationProperty.Builder A builder for CfnRestApi.S3LocationProperty
CfnRestApiProps Properties for defining a `AWS::ApiGateway::RestApi`.
CfnRestApiProps.Builder A builder for CfnRestApiProps
CfnStage A CloudFormation `AWS::ApiGateway::Stage`.
CfnStage.AccessLogSettingProperty Example:
CfnStage.AccessLogSettingProperty.Builder A builder for CfnStage.AccessLogSettingProperty
CfnStage.Builder A fluent builder for CfnStage.
CfnStage.CanarySettingProperty Example:
CfnStage.CanarySettingProperty.Builder A builder for CfnStage.CanarySettingProperty
CfnStage.MethodSettingProperty Example:
CfnStage.MethodSettingProperty.Builder A builder for CfnStage.MethodSettingProperty
CfnStageProps Properties for defining a `AWS::ApiGateway::Stage`.
CfnStageProps.Builder A builder for CfnStageProps
CfnUsagePlan A CloudFormation `AWS::ApiGateway::UsagePlan`.
CfnUsagePlan.ApiStageProperty Example:
CfnUsagePlan.ApiStageProperty.Builder A builder for CfnUsagePlan.ApiStageProperty
CfnUsagePlan.Builder A fluent builder for CfnUsagePlan.
CfnUsagePlan.QuotaSettingsProperty Example:
CfnUsagePlan.QuotaSettingsProperty.Builder A builder for CfnUsagePlan.QuotaSettingsProperty
CfnUsagePlan.ThrottleSettingsProperty Example:
CfnUsagePlan.ThrottleSettingsProperty.Builder A builder for CfnUsagePlan.ThrottleSettingsProperty
CfnUsagePlanKey A CloudFormation `AWS::ApiGateway::UsagePlanKey`.
CfnUsagePlanKey.Builder A fluent builder for CfnUsagePlanKey.
CfnUsagePlanKeyProps Properties for defining a `AWS::ApiGateway::UsagePlanKey`.
CfnUsagePlanKeyProps.Builder A builder for CfnUsagePlanKeyProps
CfnUsagePlanProps Properties for defining a `AWS::ApiGateway::UsagePlan`.
CfnUsagePlanProps.Builder A builder for CfnUsagePlanProps
CfnVpcLink A CloudFormation `AWS::ApiGateway::VpcLink`.
CfnVpcLink.Builder A fluent builder for CfnVpcLink.
CfnVpcLinkProps Properties for defining a `AWS::ApiGateway::VpcLink`.
CfnVpcLinkProps.Builder A builder for CfnVpcLinkProps
CognitoUserPoolsAuthorizer Cognito user pools based custom authorizer.
CognitoUserPoolsAuthorizer.Builder A fluent builder for CognitoUserPoolsAuthorizer.
CognitoUserPoolsAuthorizerProps Properties for CognitoUserPoolsAuthorizer.
CognitoUserPoolsAuthorizerProps.Builder A builder for CognitoUserPoolsAuthorizerProps
ConnectionType Example:
ContentHandling Example:
CorsOptions Example:
CorsOptions.Builder A builder for CorsOptions
Deployment A Deployment of a REST API.
Deployment.Builder A fluent builder for Deployment.
DeploymentProps Example:
DeploymentProps.Builder A builder for DeploymentProps
DomainName Example:
DomainName.Builder A fluent builder for DomainName.
DomainNameAttributes Example:
DomainNameAttributes.Builder A builder for DomainNameAttributes
DomainNameOptions Example:
DomainNameOptions.Builder A builder for DomainNameOptions
DomainNameProps Example:
DomainNameProps.Builder A builder for DomainNameProps
EndpointConfiguration The endpoint configuration of a REST API, including VPCs and endpoint types.
EndpointConfiguration.Builder A builder for EndpointConfiguration
EndpointType Example:
GatewayResponse Configure the response received by clients, produced from the API Gateway backend.
GatewayResponse.Builder A fluent builder for GatewayResponse.
GatewayResponseOptions Options to add gateway response.
GatewayResponseOptions.Builder A builder for GatewayResponseOptions
GatewayResponseProps Properties for a new gateway response.
GatewayResponseProps.Builder A builder for GatewayResponseProps
HttpIntegration You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.
HttpIntegration.Builder A fluent builder for HttpIntegration.
HttpIntegrationProps Example:
HttpIntegrationProps.Builder A builder for HttpIntegrationProps
IAccessLogDestination Access log destination for a RestApi Stage.
IAccessLogDestination.Jsii$Default Internal default implementation for IAccessLogDestination.
IApiKey API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.
IApiKey.Jsii$Default Internal default implementation for IApiKey.
IAuthorizer Represents an API Gateway authorizer.
IAuthorizer.Jsii$Default Internal default implementation for IAuthorizer.
IDomainName
IDomainName.Jsii$Default Internal default implementation for IDomainName.
IGatewayResponse Represents gateway response resource.
IGatewayResponse.Jsii$Default Internal default implementation for IGatewayResponse.
IModel
IModel.Jsii$Default Internal default implementation for IModel.
InlineApiDefinition OpenAPI specification from an inline JSON object.
Integration Base class for backend integrations for an API Gateway method.
Integration.Builder A fluent builder for Integration.
IntegrationConfig Result of binding an Integration to a Method.
IntegrationConfig.Builder A builder for IntegrationConfig
IntegrationOptions Example:
IntegrationOptions.Builder A builder for IntegrationOptions
IntegrationProps Example:
IntegrationProps.Builder A builder for IntegrationProps
IntegrationResponse Example:
IntegrationResponse.Builder A builder for IntegrationResponse
IntegrationType Example:
IRequestValidator
IRequestValidator.Jsii$Default Internal default implementation for IRequestValidator.
IResource
IRestApi
IRestApi.Jsii$Default Internal default implementation for IRestApi.
IStage Represents an APIGateway Stage.
IStage.Jsii$Default Internal default implementation for IStage.
IUsagePlan A UsagePlan, either managed by this CDK app, or imported.
IUsagePlan.Jsii$Default Internal default implementation for IUsagePlan.
IVpcLink Represents an API Gateway VpcLink.
IVpcLink.Jsii$Default Internal default implementation for IVpcLink.
JsonSchema Represents a JSON schema definition of the structure of a REST API model.
JsonSchema.Builder A builder for JsonSchema
JsonSchemaType Example:
JsonSchemaVersion Example:
JsonWithStandardFieldProps Properties for controlling items output in JSON standard format.
JsonWithStandardFieldProps.Builder A builder for JsonWithStandardFieldProps
LambdaAuthorizerProps Base properties for all lambda authorizers.
LambdaAuthorizerProps.Builder A builder for LambdaAuthorizerProps
LambdaIntegration Integrates an AWS Lambda function to an API Gateway method.
LambdaIntegration.Builder A fluent builder for LambdaIntegration.
LambdaIntegrationOptions Example:
LambdaIntegrationOptions.Builder A builder for LambdaIntegrationOptions
LambdaRestApi Defines an API Gateway REST API with AWS Lambda proxy integration.
LambdaRestApi.Builder A fluent builder for LambdaRestApi.
LambdaRestApiProps Example:
LambdaRestApiProps.Builder A builder for LambdaRestApiProps
Method Example:
Method.Builder A fluent builder for Method.
MethodDeploymentOptions Example:
MethodDeploymentOptions.Builder A builder for MethodDeploymentOptions
MethodLoggingLevel Example:
MethodOptions Example:
MethodOptions.Builder A builder for MethodOptions
MethodProps Example:
MethodProps.Builder A builder for MethodProps
MethodResponse Example:
MethodResponse.Builder A builder for MethodResponse
MockIntegration This type of integration lets API Gateway return a response without sending the request further to the backend.
MockIntegration.Builder A fluent builder for MockIntegration.
Model Example:
Model.Builder A fluent builder for Model.
ModelOptions Example:
ModelOptions.Builder A builder for ModelOptions
ModelProps Example:
ModelProps.Builder A builder for ModelProps
MTLSConfig The mTLS authentication configuration for a custom domain name.
MTLSConfig.Builder A builder for MTLSConfig
PassthroughBehavior Example:
Period Time period for which quota settings apply.
ProxyResource Defines a {proxy+} greedy resource and an ANY method on a route.
ProxyResource.Builder A fluent builder for ProxyResource.
ProxyResourceOptions Example:
ProxyResourceOptions.Builder A builder for ProxyResourceOptions
ProxyResourceProps Example:
ProxyResourceProps.Builder A builder for ProxyResourceProps
QuotaSettings Specifies the maximum number of requests that clients can make to API Gateway APIs.
QuotaSettings.Builder A builder for QuotaSettings
RateLimitedApiKey An API Gateway ApiKey, for which a rate limiting configuration can be specified.
RateLimitedApiKey.Builder A fluent builder for RateLimitedApiKey.
RateLimitedApiKeyProps RateLimitedApiKey properties.
RateLimitedApiKeyProps.Builder A builder for 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.
RequestAuthorizer.Builder A fluent builder for RequestAuthorizer.
RequestAuthorizerProps Properties for RequestAuthorizer.
RequestAuthorizerProps.Builder A builder for RequestAuthorizerProps
RequestContext Configure what must be included in the `requestContext`.
RequestContext.Builder A builder for RequestContext
RequestValidator Example:
RequestValidator.Builder A fluent builder for RequestValidator.
RequestValidatorOptions Example:
RequestValidatorOptions.Builder A builder for RequestValidatorOptions
RequestValidatorProps Example:
RequestValidatorProps.Builder A builder for RequestValidatorProps
Resource Example:
Resource.Builder A fluent builder for Resource.
ResourceAttributes Attributes that can be specified when importing a Resource.
ResourceAttributes.Builder A builder for ResourceAttributes
ResourceBase
ResourceOptions Example:
ResourceOptions.Builder A builder for ResourceOptions
ResourceProps Example:
ResourceProps.Builder A builder for ResourceProps
ResponseType Supported types of gateway responses.
RestApi Represents a REST API in Amazon API Gateway.
RestApi.Builder A fluent builder for RestApi.
RestApiAttributes Attributes that can be specified when importing a RestApi.
RestApiAttributes.Builder A builder for RestApiAttributes
RestApiBase Base implementation that are common to various implementations of IRestApi.
RestApiBaseProps Represents the props that all Rest APIs share.
RestApiBaseProps.Builder A builder for RestApiBaseProps
RestApiProps Props to create a new instance of RestApi.
RestApiProps.Builder A builder for 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.
SpecRestApi.Builder A fluent builder for SpecRestApi.
SpecRestApiProps Props to instantiate a new SpecRestApi.
SpecRestApiProps.Builder A builder for SpecRestApiProps
Stage Example:
Stage.Builder A fluent builder for Stage.
StageOptions Example:
StageOptions.Builder A builder for StageOptions
StageProps Example:
StageProps.Builder A builder for StageProps
StepFunctionsExecutionIntegrationOptions Options when configuring Step Functions synchronous integration with Rest API.
StepFunctionsExecutionIntegrationOptions.Builder A builder for StepFunctionsExecutionIntegrationOptions
StepFunctionsRestApi Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.
StepFunctionsRestApi.Builder A fluent builder for StepFunctionsRestApi.
StepFunctionsRestApiProps Properties for StepFunctionsRestApi.
StepFunctionsRestApiProps.Builder A builder for StepFunctionsRestApiProps
ThrottleSettings Container for defining throttling parameters to API stages or methods.
ThrottleSettings.Builder A builder for ThrottleSettings
ThrottlingPerMethod Represents per-method throttling for a resource.
ThrottlingPerMethod.Builder A builder for 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.
TokenAuthorizer.Builder A fluent builder for TokenAuthorizer.
TokenAuthorizerProps Properties for TokenAuthorizer.
TokenAuthorizerProps.Builder A builder for TokenAuthorizerProps
UsagePlan Example:
UsagePlan.Builder A fluent builder for UsagePlan.
UsagePlanPerApiStage Represents the API stages that a usage plan applies to.
UsagePlanPerApiStage.Builder A builder for UsagePlanPerApiStage
UsagePlanProps Example:
UsagePlanProps.Builder A builder for 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).
VpcLink.Builder A fluent builder for VpcLink.
VpcLinkProps Properties for a VpcLink.
VpcLinkProps.Builder A builder for VpcLinkProps

Classes in software.amazon.awscdk.services.apigateway used by software.amazon.awscdk.services.events.targets

Class and Description
RestApi Represents a REST API in Amazon API Gateway.

Classes in software.amazon.awscdk.services.apigateway used by software.amazon.awscdk.services.lambda.eventsources

Class and Description
AuthorizationType Example:
IAuthorizer Represents an API Gateway authorizer.
IModel
IRequestValidator
MethodOptions Example:
MethodResponse Example:
RequestValidatorOptions Example:

Classes in software.amazon.awscdk.services.apigateway used by software.amazon.awscdk.services.route53.targets

Class and Description
IDomainName
RestApiBase Base implementation that are common to various implementations of IRestApi.

Classes in software.amazon.awscdk.services.apigateway used by software.amazon.awscdk.services.stepfunctions.tasks

Class and Description
IRestApi