Namespace Amazon.CDK.AWS.APIGateway
Classes
- AccessLogDestinationConfig
Options when binding a log destination to a RestApi Stage.
- AccessLogField
$context variables that can be used to customize access log pattern.
- AccessLogFormat
factory methods for access log format.
- AddApiKeyOptions
Options to the UsagePlan.addApiKey() method.
- ApiDefinition
Represents an OpenAPI definition asset.
- ApiDefinitionConfig
Post-Binding Configuration for a CDK construct.
- ApiDefinitionS3Location
S3 location of the API definition file.
- ApiKey
An API Gateway ApiKey.
- ApiKeyOptions
The options for creating an API Key.
- ApiKeyProps
ApiKey Properties.
- AssetApiDefinition
OpenAPI specification from a local file.
- Authorizer
Base class for all custom authorizers.
- AwsIntegration
This type of integration lets an API expose AWS service actions.
- BasePathMapping
This resource creates a base path that clients who call your API must use in the invocation URL.
- CfnAccount
A CloudFormation
AWS::ApiGateway::Account.
- CfnAccountProps
Properties for defining a
CfnAccount.
- CfnApiKey
A CloudFormation
AWS::ApiGateway::ApiKey.
- CfnApiKey.StageKeyProperty
StageKeyis a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.
- CfnApiKeyProps
Properties for defining a
CfnApiKey.
- CfnApiMappingV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::ApiMapping.
- CfnApiMappingV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::ApiMapping.
- CfnApiV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::Api.
- CfnApiV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Api.
- CfnAuthorizer
A CloudFormation
AWS::ApiGateway::Authorizer.
- CfnAuthorizerProps
Properties for defining a
CfnAuthorizer.
- CfnAuthorizerV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::Authorizer.
- CfnAuthorizerV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Authorizer.
- CfnBasePathMapping
A CloudFormation
AWS::ApiGateway::BasePathMapping.
- CfnBasePathMappingProps
Properties for defining a
CfnBasePathMapping.
- CfnClientCertificate
A CloudFormation
AWS::ApiGateway::ClientCertificate.
- CfnClientCertificateProps
Properties for defining a
CfnClientCertificate.
- CfnDeployment
A CloudFormation
AWS::ApiGateway::Deployment.
- CfnDeployment.AccessLogSettingProperty
The
AccessLogSettingproperty type specifies settings for logging access in this stage.
- CfnDeployment.CanarySettingProperty
The
CanarySettingproperty type specifies settings for the canary deployment in this stage.
- CfnDeployment.DeploymentCanarySettingsProperty
The
DeploymentCanarySettingsproperty type specifies settings for the canary deployment.
- CfnDeployment.MethodSettingProperty
The
MethodSettingproperty type configures settings for all methods in a stage.
- CfnDeployment.StageDescriptionProperty
StageDescriptionis a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.
- CfnDeploymentProps
Properties for defining a
CfnDeployment.
- CfnDeploymentV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::Deployment.
- CfnDeploymentV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Deployment.
- CfnDocumentationPart
A CloudFormation
AWS::ApiGateway::DocumentationPart.
- CfnDocumentationPart.LocationProperty
The
Locationproperty specifies the location of the Amazon API Gateway API entity that the documentation applies to.
- CfnDocumentationPartProps
Properties for defining a
CfnDocumentationPart.
- CfnDocumentationVersion
A CloudFormation
AWS::ApiGateway::DocumentationVersion.
- CfnDocumentationVersionProps
Properties for defining a
CfnDocumentationVersion.
- CfnDomainName
A CloudFormation
AWS::ApiGateway::DomainName.
- CfnDomainName.EndpointConfigurationProperty
The
EndpointConfigurationproperty type specifies the endpoint types of an Amazon API Gateway domain name.
- CfnDomainName.MutualTlsAuthenticationProperty
The mutual TLS authentication configuration for a custom domain name.
- CfnDomainNameProps
Properties for defining a
CfnDomainName.
- CfnDomainNameV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::DomainName.
- CfnDomainNameV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::DomainName.
- CfnGatewayResponse
A CloudFormation
AWS::ApiGateway::GatewayResponse.
- CfnGatewayResponseProps
Properties for defining a
CfnGatewayResponse.
- CfnIntegrationResponseV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::IntegrationResponse.
- CfnIntegrationResponseV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::IntegrationResponse.
- CfnIntegrationV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::Integration.
- CfnIntegrationV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Integration.
- CfnMethod
A CloudFormation
AWS::ApiGateway::Method.
- CfnMethod.IntegrationProperty
Integrationis a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.
- CfnMethod.IntegrationResponseProperty
IntegrationResponseis a property of the Amazon API Gateway Method Integration property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.
- CfnMethod.MethodResponseProperty
Represents a method response of a given HTTP status code returned to the client.
- CfnMethodProps
Properties for defining a
CfnMethod.
- CfnModel
A CloudFormation
AWS::ApiGateway::Model.
- CfnModelProps
Properties for defining a
CfnModel.
- CfnModelV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::Model.
- CfnModelV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Model.
- CfnRequestValidator
A CloudFormation
AWS::ApiGateway::RequestValidator.
- CfnRequestValidatorProps
Properties for defining a
CfnRequestValidator.
- CfnResource
A CloudFormation
AWS::ApiGateway::Resource.
- CfnResourceProps
Properties for defining a
CfnResource.
- CfnRestApi
A CloudFormation
AWS::ApiGateway::RestApi.
- CfnRestApi.EndpointConfigurationProperty
The
EndpointConfigurationproperty type specifies the endpoint types of a REST API.
- CfnRestApi.S3LocationProperty
S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.
- CfnRestApiProps
Properties for defining a
CfnRestApi.
- CfnRouteResponseV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::RouteResponse.
- CfnRouteResponseV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::RouteResponse.
- CfnRouteV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::Route.
- CfnRouteV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Route.
- CfnStage
A CloudFormation
AWS::ApiGateway::Stage.
- CfnStage.AccessLogSettingProperty
The
AccessLogSettingproperty type specifies settings for logging access in this stage.
- CfnStage.CanarySettingProperty
Configuration settings of a canary deployment.
- CfnStage.MethodSettingProperty
The
MethodSettingproperty type configures settings for all methods in a stage.
- CfnStageProps
Properties for defining a
CfnStage.
- CfnStageV2
(deprecated) A CloudFormation
AWS::ApiGatewayV2::Stage.
- CfnStageV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Stage.
- CfnUsagePlan
A CloudFormation
AWS::ApiGateway::UsagePlan.
- CfnUsagePlan.ApiStageProperty
API stage name of the associated API stage in a usage plan.
- CfnUsagePlan.QuotaSettingsProperty
QuotaSettingsis a property of the AWS::ApiGateway::UsagePlan resource that specifies a target for the maximum number of requests users can make to your REST APIs.
- CfnUsagePlan.ThrottleSettingsProperty
ThrottleSettingsis a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
- CfnUsagePlanKey
A CloudFormation
AWS::ApiGateway::UsagePlanKey.
- CfnUsagePlanKeyProps
Properties for defining a
CfnUsagePlanKey.
- CfnUsagePlanProps
Properties for defining a
CfnUsagePlan.
- CfnVpcLink
A CloudFormation
AWS::ApiGateway::VpcLink.
- CfnVpcLinkProps
Properties for defining a
CfnVpcLink.
- CognitoUserPoolsAuthorizer
Cognito user pools based custom authorizer.
- CognitoUserPoolsAuthorizerProps
Properties for CognitoUserPoolsAuthorizer.
- Deployment
A Deployment of a REST API.
- EmptyModel
(deprecated) Represents a reference to a REST API's Empty model, which is available as part of the model collection by default.
- EndpointConfiguration
The endpoint configuration of a REST API, including VPCs and endpoint types.
- 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
Options to add gateway response.
- GatewayResponseProps
Properties for a new gateway response.
- HttpIntegration
You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.
- 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
Result of binding an Integration to a Method.
- JsonSchema
Represents a JSON schema definition of the structure of a REST API model.
- JsonWithStandardFieldProps
Properties for controlling items output in JSON standard format.
- LambdaAuthorizerProps
Base properties for all lambda authorizers.
- LambdaIntegration
Integrates an AWS Lambda function to an API Gateway method.
- LambdaRestApi
Defines an API Gateway REST API with AWS Lambda proxy integration.
- LogGroupLogDestination
Use CloudWatch Logs as a custom access log destination for API Gateway.
- MTLSConfig
The mTLS authentication configuration for a custom domain name.
- MockIntegration
This type of integration lets API Gateway return a response without sending the request further to the backend.
- ProxyResource
Defines a {proxy+} greedy resource and an ANY method on a route.
- QuotaSettings
Specifies the maximum number of requests that clients can make to API Gateway APIs.
- RateLimitedApiKey
An API Gateway ApiKey, for which a rate limiting configuration can be specified.
- RateLimitedApiKeyProps
RateLimitedApiKey properties.
- 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
Properties for RequestAuthorizer.
- RequestContext
Configure what must be included in the
requestContext.
- ResourceAttributes
Attributes that can be specified when importing a Resource.
- ResponseType_
Supported types of gateway responses.
- RestApi
Represents a REST API in Amazon API Gateway.
- RestApiAttributes
Attributes that can be specified when importing a RestApi.
- RestApiBase
Base implementation that are common to various implementations of IRestApi.
- RestApiBaseProps
Represents the props that all Rest APIs share.
- RestApiOptions
(deprecated) Represents the props that all Rest APIs share.
- RestApiProps
Props to create a new instance of RestApi.
- S3ApiDefinition
OpenAPI specification from an S3 archive.
- SpecRestApi
Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.
- SpecRestApiProps
Props to instantiate a new SpecRestApi.
- StepFunctionsExecutionIntegrationOptions
Options when configuring Step Functions synchronous integration with Rest API.
- 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
Properties for StepFunctionsRestApi.
- ThrottleSettings
Container for defining throttling parameters to API stages or methods.
- ThrottlingPerMethod
Represents per-method throttling for a resource.
- 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
Properties for TokenAuthorizer.
- UsagePlanPerApiStage
Represents the API stages that a usage plan applies to.
- 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
Properties for a VpcLink.
Interfaces
- CfnApiKey.IStageKeyProperty
StageKeyis a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.
- CfnDeployment.IAccessLogSettingProperty
The
AccessLogSettingproperty type specifies settings for logging access in this stage.
- CfnDeployment.ICanarySettingProperty
The
CanarySettingproperty type specifies settings for the canary deployment in this stage.
- CfnDeployment.IDeploymentCanarySettingsProperty
The
DeploymentCanarySettingsproperty type specifies settings for the canary deployment.
- CfnDeployment.IMethodSettingProperty
The
MethodSettingproperty type configures settings for all methods in a stage.
- CfnDeployment.IStageDescriptionProperty
StageDescriptionis a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.
- CfnDocumentationPart.ILocationProperty
The
Locationproperty specifies the location of the Amazon API Gateway API entity that the documentation applies to.
- CfnDomainName.IEndpointConfigurationProperty
The
EndpointConfigurationproperty type specifies the endpoint types of an Amazon API Gateway domain name.
- CfnDomainName.IMutualTlsAuthenticationProperty
The mutual TLS authentication configuration for a custom domain name.
- CfnMethod.IIntegrationProperty
Integrationis a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.
- CfnMethod.IIntegrationResponseProperty
IntegrationResponseis a property of the Amazon API Gateway Method Integration property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.
- CfnMethod.IMethodResponseProperty
Represents a method response of a given HTTP status code returned to the client.
- CfnRestApi.IEndpointConfigurationProperty
The
EndpointConfigurationproperty type specifies the endpoint types of a REST API.
- CfnRestApi.IS3LocationProperty
S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.
- CfnStage.IAccessLogSettingProperty
The
AccessLogSettingproperty type specifies settings for logging access in this stage.
- CfnStage.ICanarySettingProperty
Configuration settings of a canary deployment.
- CfnStage.IMethodSettingProperty
The
MethodSettingproperty type configures settings for all methods in a stage.
- CfnUsagePlan.IApiStageProperty
API stage name of the associated API stage in a usage plan.
- CfnUsagePlan.IQuotaSettingsProperty
QuotaSettingsis a property of the AWS::ApiGateway::UsagePlan resource that specifies a target for the maximum number of requests users can make to your REST APIs.
- CfnUsagePlan.IThrottleSettingsProperty
ThrottleSettingsis a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
- IAccessLogDestination
Access log destination for a RestApi Stage.
- IAccessLogDestinationConfig
Options when binding a log destination to a RestApi Stage.
- IAddApiKeyOptions
Options to the UsagePlan.addApiKey() method.
- IApiDefinitionConfig
Post-Binding Configuration for a CDK construct.
- IApiDefinitionS3Location
S3 location of the API definition file.
- IApiKey
API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.
- IApiKeyOptions
The options for creating an API Key.
- IApiKeyProps
ApiKey Properties.
- IAuthorizer
Represents an API Gateway authorizer.
- ICfnAccountProps
Properties for defining a
CfnAccount.
- ICfnApiKeyProps
Properties for defining a
CfnApiKey.
- ICfnApiMappingV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::ApiMapping.
- ICfnApiV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Api.
- ICfnAuthorizerProps
Properties for defining a
CfnAuthorizer.
- ICfnAuthorizerV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Authorizer.
- ICfnBasePathMappingProps
Properties for defining a
CfnBasePathMapping.
- ICfnClientCertificateProps
Properties for defining a
CfnClientCertificate.
- ICfnDeploymentProps
Properties for defining a
CfnDeployment.
- ICfnDeploymentV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Deployment.
- ICfnDocumentationPartProps
Properties for defining a
CfnDocumentationPart.
- ICfnDocumentationVersionProps
Properties for defining a
CfnDocumentationVersion.
- ICfnDomainNameProps
Properties for defining a
CfnDomainName.
- ICfnDomainNameV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::DomainName.
- ICfnGatewayResponseProps
Properties for defining a
CfnGatewayResponse.
- ICfnIntegrationResponseV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::IntegrationResponse.
- ICfnIntegrationV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Integration.
- ICfnMethodProps
Properties for defining a
CfnMethod.
- ICfnModelProps
Properties for defining a
CfnModel.
- ICfnModelV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Model.
- ICfnRequestValidatorProps
Properties for defining a
CfnRequestValidator.
- ICfnResourceProps
Properties for defining a
CfnResource.
- ICfnRestApiProps
Properties for defining a
CfnRestApi.
- ICfnRouteResponseV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::RouteResponse.
- ICfnRouteV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Route.
- ICfnStageProps
Properties for defining a
CfnStage.
- ICfnStageV2Props
(deprecated) Properties for defining a
AWS::ApiGatewayV2::Stage.
- ICfnUsagePlanKeyProps
Properties for defining a
CfnUsagePlanKey.
- ICfnUsagePlanProps
Properties for defining a
CfnUsagePlan.
- ICfnVpcLinkProps
Properties for defining a
CfnVpcLink.
- ICognitoUserPoolsAuthorizerProps
Properties for CognitoUserPoolsAuthorizer.
- IEndpointConfiguration
The endpoint configuration of a REST API, including VPCs and endpoint types.
- IGatewayResponse
Represents gateway response resource.
- IGatewayResponseOptions
Options to add gateway response.
- IGatewayResponseProps
Properties for a new gateway response.
- IIntegrationConfig
Result of binding an Integration to a Method.
- IJsonSchema
Represents a JSON schema definition of the structure of a REST API model.
- IJsonWithStandardFieldProps
Properties for controlling items output in JSON standard format.
- ILambdaAuthorizerProps
Base properties for all lambda authorizers.
- IMTLSConfig
The mTLS authentication configuration for a custom domain name.
- IQuotaSettings
Specifies the maximum number of requests that clients can make to API Gateway APIs.
- IRateLimitedApiKeyProps
RateLimitedApiKey properties.
- IRequestAuthorizerProps
Properties for RequestAuthorizer.
- IRequestContext
Configure what must be included in the
requestContext.
- IResourceAttributes
Attributes that can be specified when importing a Resource.
- IRestApiAttributes
Attributes that can be specified when importing a RestApi.
- IRestApiBaseProps
Represents the props that all Rest APIs share.
- IRestApiOptions
(deprecated) Represents the props that all Rest APIs share.
- IRestApiProps
Props to create a new instance of RestApi.
- ISpecRestApiProps
Props to instantiate a new SpecRestApi.
- IStage
Represents an APIGateway Stage.
- IStepFunctionsExecutionIntegrationOptions
Options when configuring Step Functions synchronous integration with Rest API.
- IStepFunctionsRestApiProps
Properties for StepFunctionsRestApi.
- IThrottleSettings
Container for defining throttling parameters to API stages or methods.
- IThrottlingPerMethod
Represents per-method throttling for a resource.
- ITokenAuthorizerProps
Properties for TokenAuthorizer.
- IUsagePlan
A UsagePlan, either managed by this CDK app, or imported.
- IUsagePlanPerApiStage
Represents the API stages that a usage plan applies to.
- IVpcLink
Represents an API Gateway VpcLink.
- IVpcLinkProps
Properties for a VpcLink.
Enums
- Period
Time period for which quota settings apply.
- SecurityPolicy
The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.