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.
ApiKeyGrants	Collection of grant methods for a IApiKeyRef.
ApiKeyOptions	The options for creating an API Key.
ApiKeyProps	ApiKey Properties.
ApiMappingOptions	Options for creating an api mapping.
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.
AwsIntegrationProps
BasePathMapping	This resource creates a base path that clients who call your API must use in the invocation URL.
BasePathMappingOptions
BasePathMappingProps
CfnAccount	The AWS::ApiGateway::Account resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs.
CfnAccountProps	Properties for defining a CfnAccount.
CfnApiKey	The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key.
CfnApiKey.StageKeyProperty	StageKey is 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.
CfnAuthorizer	The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled.
CfnAuthorizerProps	Properties for defining a CfnAuthorizer.
CfnBasePathMapping	The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.
CfnBasePathMappingProps	Properties for defining a CfnBasePathMapping.
CfnBasePathMappingV2	The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.
CfnBasePathMappingV2Props	Properties for defining a CfnBasePathMappingV2.
CfnClientCertificate	The AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
CfnClientCertificateProps	Properties for defining a CfnClientCertificate.
CfnDeployment	The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.
CfnDeployment.AccessLogSettingProperty	The AccessLogSetting property type specifies settings for logging access in this stage.
CfnDeployment.CanarySettingProperty	The CanarySetting property type specifies settings for the canary deployment in this stage.
CfnDeployment.DeploymentCanarySettingsProperty	The DeploymentCanarySettings property type specifies settings for the canary deployment.
CfnDeployment.MethodSettingProperty	The MethodSetting property type configures settings for all methods in a stage.
CfnDeployment.StageDescriptionProperty	StageDescription is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.
CfnDeploymentProps	Properties for defining a CfnDeployment.
CfnDocumentationPart	The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API.
CfnDocumentationPart.LocationProperty	The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to.
CfnDocumentationPartProps	Properties for defining a CfnDocumentationPart.
CfnDocumentationVersion	The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API.
CfnDocumentationVersionProps	Properties for defining a CfnDocumentationVersion.
CfnDomainName	The AWS::ApiGateway::DomainName resource specifies a public custom domain name for your API in API Gateway.
CfnDomainName.EndpointConfigurationProperty	The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.
CfnDomainName.MutualTlsAuthenticationProperty	The mutual TLS authentication configuration for a custom domain name.
CfnDomainNameAccessAssociation	The AWS::ApiGateway::DomainNameAccessAssociation resource creates a domain name access association between an access association source and a private custom domain name.
CfnDomainNameAccessAssociationProps	Properties for defining a CfnDomainNameAccessAssociation.
CfnDomainNameProps	Properties for defining a CfnDomainName.
CfnDomainNameV2	The AWS::ApiGateway::DomainNameV2 resource specifies a custom domain name for your private APIs in API Gateway.
CfnDomainNameV2.EndpointConfigurationProperty	The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
CfnDomainNameV2Props	Properties for defining a CfnDomainNameV2.
CfnGatewayResponse	The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API.
CfnGatewayResponseProps	Properties for defining a CfnGatewayResponse.
CfnMethod	The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
CfnMethod.IntegrationProperty	Integration is a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.
CfnMethod.IntegrationResponseProperty	IntegrationResponse is 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	The AWS::ApiGateway::Model resource defines the structure of a request or response payload for an API method.
CfnModelProps	Properties for defining a CfnModel.
CfnRequestValidator	The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API.
CfnRequestValidatorProps	Properties for defining a CfnRequestValidator.
CfnResource	The AWS::ApiGateway::Resource resource creates a resource in an API.
CfnResourceProps	Properties for defining a CfnResource.
CfnRestApi	The AWS::ApiGateway::RestApi resource creates a REST API.
CfnRestApi.EndpointConfigurationProperty	The EndpointConfiguration property type specifies the endpoint types and IP address types of a REST API.
CfnRestApi.S3LocationProperty	S3Location is 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.
CfnStage	The AWS::ApiGateway::Stage resource creates a stage for a deployment.
CfnStage.AccessLogSettingProperty	The AccessLogSetting property type specifies settings for logging access in this stage.
CfnStage.CanarySettingProperty	Configuration settings of a canary deployment.
CfnStage.MethodSettingProperty	The MethodSetting property type configures settings for all methods in a stage.
CfnStageProps	Properties for defining a CfnStage.
CfnUsagePlan	The AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs.
CfnUsagePlan.ApiStageProperty	API stage name of the associated API stage in a usage plan.
CfnUsagePlan.QuotaSettingsProperty	QuotaSettings is 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	ThrottleSettings is 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	The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan.
CfnUsagePlanKeyProps	Properties for defining a CfnUsagePlanKey.
CfnUsagePlanProps	Properties for defining a CfnUsagePlan.
CfnVpcLink	The AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC).
CfnVpcLinkProps	Properties for defining a CfnVpcLink.
CognitoUserPoolsAuthorizer	Cognito user pools based custom authorizer.
CognitoUserPoolsAuthorizerProps	Properties for CognitoUserPoolsAuthorizer.
Cors
CorsOptions
Deployment	A Deployment of a REST API.
DeploymentProps
DomainNameAttributes
DomainNameOptions
DomainNameProps
DomainName_
EndpointConfiguration	The endpoint configuration of a REST API, including VPCs and endpoint types.
FirehoseLogDestination	Use a Firehose delivery stream as a custom access log destination for API Gateway.
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,.
HttpIntegrationProps
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.
IntegrationOptions
IntegrationProps
IntegrationResponse
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.
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	The mTLS authentication configuration for a custom domain name.
Method
MethodDeploymentOptions
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
ProxyResource	Defines a {proxy+} greedy resource and an ANY method on a route.
ProxyResourceOptions
ProxyResourceProps
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.
RequestValidator
RequestValidatorOptions
RequestValidatorProps
Resource
ResourceAttributes	Attributes that can be specified when importing a Resource.
ResourceBase
ResourceOptions
ResourceProps
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.
RestApiProps	Props to create a new instance of RestApi.
S3ApiDefinition	OpenAPI specification from an S3 archive.
SagemakerIntegration	Integrates an AWS Sagemaker Endpoint to an API Gateway method.
SagemakerIntegrationOptions	Options for SageMakerIntegration.
SpecRestApi	Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.
SpecRestApiProps	Props to instantiate a new SpecRestApi.
Stage
StageAttributes	The attributes of an imported Stage.
StageBase	Base class for an ApiGateway Stage.
StageOptions
StageProps
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.
UsagePlan
UsagePlanPerApiStage	Represents the API stages that a usage plan applies to.
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	Properties for a VpcLink.

Interfaces

CfnApiKey.IStageKeyProperty	StageKey is 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 AccessLogSetting property type specifies settings for logging access in this stage.
CfnDeployment.ICanarySettingProperty	The CanarySetting property type specifies settings for the canary deployment in this stage.
CfnDeployment.IDeploymentCanarySettingsProperty	The DeploymentCanarySettings property type specifies settings for the canary deployment.
CfnDeployment.IMethodSettingProperty	The MethodSetting property type configures settings for all methods in a stage.
CfnDeployment.IStageDescriptionProperty	StageDescription is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.
CfnDocumentationPart.ILocationProperty	The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to.
CfnDomainName.IEndpointConfigurationProperty	The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.
CfnDomainName.IMutualTlsAuthenticationProperty	The mutual TLS authentication configuration for a custom domain name.
CfnDomainNameV2.IEndpointConfigurationProperty	The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
CfnMethod.IIntegrationProperty	Integration is a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.
CfnMethod.IIntegrationResponseProperty	IntegrationResponse is 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 EndpointConfiguration property type specifies the endpoint types and IP address types of a REST API.
CfnRestApi.IS3LocationProperty	S3Location is 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 AccessLogSetting property type specifies settings for logging access in this stage.
CfnStage.ICanarySettingProperty	Configuration settings of a canary deployment.
CfnStage.IMethodSettingProperty	The MethodSetting property 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	QuotaSettings is 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	ThrottleSettings is 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.
IApiMappingOptions	Options for creating an api mapping.
IAuthorizer	Represents an API Gateway authorizer.
IAwsIntegrationProps
IBasePathMappingOptions
IBasePathMappingProps
ICfnAccountProps	Properties for defining a CfnAccount.
ICfnApiKeyProps	Properties for defining a CfnApiKey.
ICfnAuthorizerProps	Properties for defining a CfnAuthorizer.
ICfnBasePathMappingProps	Properties for defining a CfnBasePathMapping.
ICfnBasePathMappingV2Props	Properties for defining a CfnBasePathMappingV2.
ICfnClientCertificateProps	Properties for defining a CfnClientCertificate.
ICfnDeploymentProps	Properties for defining a CfnDeployment.
ICfnDocumentationPartProps	Properties for defining a CfnDocumentationPart.
ICfnDocumentationVersionProps	Properties for defining a CfnDocumentationVersion.
ICfnDomainNameAccessAssociationProps	Properties for defining a CfnDomainNameAccessAssociation.
ICfnDomainNameProps	Properties for defining a CfnDomainName.
ICfnDomainNameV2Props	Properties for defining a CfnDomainNameV2.
ICfnGatewayResponseProps	Properties for defining a CfnGatewayResponse.
ICfnMethodProps	Properties for defining a CfnMethod.
ICfnModelProps	Properties for defining a CfnModel.
ICfnRequestValidatorProps	Properties for defining a CfnRequestValidator.
ICfnResourceProps	Properties for defining a CfnResource.
ICfnRestApiProps	Properties for defining a CfnRestApi.
ICfnStageProps	Properties for defining a CfnStage.
ICfnUsagePlanKeyProps	Properties for defining a CfnUsagePlanKey.
ICfnUsagePlanProps	Properties for defining a CfnUsagePlan.
ICfnVpcLinkProps	Properties for defining a CfnVpcLink.
ICognitoUserPoolsAuthorizerProps	Properties for CognitoUserPoolsAuthorizer.
ICorsOptions
IDeploymentProps
IDomainName
IDomainNameAttributes
IDomainNameOptions
IDomainNameProps
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.
IHttpIntegrationProps
IIntegrationConfig	Result of binding an Integration to a Method.
IIntegrationOptions
IIntegrationProps
IIntegrationResponse
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.
ILambdaIntegrationOptions
ILambdaRestApiProps
IMTLSConfig	The mTLS authentication configuration for a custom domain name.
IMethodDeploymentOptions
IMethodOptions
IMethodProps
IMethodResponse
IModel
IModelOptions
IModelProps
IProxyResourceOptions
IProxyResourceProps
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.
IRequestValidator
IRequestValidatorOptions
IRequestValidatorProps
IResource
IResourceAttributes	Attributes that can be specified when importing a Resource.
IResourceOptions
IResourceProps
IRestApi
IRestApiAttributes	Attributes that can be specified when importing a RestApi.
IRestApiBaseProps	Represents the props that all Rest APIs share.
IRestApiProps	Props to create a new instance of RestApi.
ISagemakerIntegrationOptions	Options for SageMakerIntegration.
ISpecRestApiProps	Props to instantiate a new SpecRestApi.
IStage	Represents an APIGateway Stage.
IStageAttributes	The attributes of an imported Stage.
IStageOptions
IStageProps
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.
IUsagePlanProps
IVpcLink	Represents an API Gateway VpcLink.
IVpcLinkProps	Properties for a VpcLink.

Enums

ApiKeySourceType
AuthorizationType
ConnectionType
ContentHandling
EndpointAccessMode	The endpoint access mode for the domain name.
EndpointType
IntegrationType
IpAddressType	Supported IP Address Types.
JsonSchemaType
JsonSchemaVersion
MethodLoggingLevel
PassthroughBehavior
Period	Time period for which quota settings apply.
ResponseTransferMode	The response transfer mode of the integration.
RestApiMode	The Mode that determines how API Gateway handles resource updates when importing an OpenAPI definition.
SecurityPolicy	The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.