| Interface | Description |
|---|---|
| AccessLogDestinationConfig |
(experimental) Options when binding a log destination to a RestApi Stage.
|
| ApiDefinitionConfig |
(experimental) Post-Binding Configuration for a CDK construct.
|
| ApiDefinitionS3Location |
(experimental) S3 location of the API definition file.
|
| ApiKeyOptions |
(experimental) The options for creating an API Key.
|
| ApiKeyProps |
(experimental) ApiKey Properties.
|
| AwsIntegrationProps | |
| BasePathMappingOptions | |
| BasePathMappingProps | |
| CfnAccountProps |
Properties for defining a `AWS::ApiGateway::Account`.
|
| CfnApiKey.StageKeyProperty | |
| CfnApiKeyProps |
Properties for defining a `AWS::ApiGateway::ApiKey`.
|
| CfnApiMappingV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnApiV2.BodyS3LocationProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnApiV2.CorsProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnApiV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnAuthorizerProps |
Properties for defining a `AWS::ApiGateway::Authorizer`.
|
| CfnAuthorizerV2.JWTConfigurationProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnAuthorizerV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnBasePathMappingProps |
Properties for defining a `AWS::ApiGateway::BasePathMapping`.
|
| CfnClientCertificateProps |
Properties for defining a `AWS::ApiGateway::ClientCertificate`.
|
| CfnDeployment.AccessLogSettingProperty | |
| CfnDeployment.CanarySettingProperty | |
| CfnDeployment.DeploymentCanarySettingsProperty | |
| CfnDeployment.MethodSettingProperty | |
| CfnDeployment.StageDescriptionProperty | |
| CfnDeploymentProps |
Properties for defining a `AWS::ApiGateway::Deployment`.
|
| CfnDeploymentV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnDocumentationPart.LocationProperty | |
| CfnDocumentationPartProps |
Properties for defining a `AWS::ApiGateway::DocumentationPart`.
|
| CfnDocumentationVersionProps |
Properties for defining a `AWS::ApiGateway::DocumentationVersion`.
|
| CfnDomainName.EndpointConfigurationProperty | |
| CfnDomainName.MutualTlsAuthenticationProperty | |
| CfnDomainNameProps |
Properties for defining a `AWS::ApiGateway::DomainName`.
|
| CfnDomainNameV2.DomainNameConfigurationProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnDomainNameV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnGatewayResponseProps |
Properties for defining a `AWS::ApiGateway::GatewayResponse`.
|
| CfnIntegrationResponseV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnIntegrationV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnMethod.IntegrationProperty | |
| CfnMethod.IntegrationResponseProperty | |
| CfnMethod.MethodResponseProperty | |
| CfnMethodProps |
Properties for defining a `AWS::ApiGateway::Method`.
|
| CfnModelProps |
Properties for defining a `AWS::ApiGateway::Model`.
|
| CfnModelV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnRequestValidatorProps |
Properties for defining a `AWS::ApiGateway::RequestValidator`.
|
| CfnResourceProps |
Properties for defining a `AWS::ApiGateway::Resource`.
|
| CfnRestApi.EndpointConfigurationProperty | |
| CfnRestApi.S3LocationProperty | |
| CfnRestApiProps |
Properties for defining a `AWS::ApiGateway::RestApi`.
|
| CfnRouteResponseV2.ParameterConstraintsProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnRouteResponseV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnRouteV2.ParameterConstraintsProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnRouteV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnStage.AccessLogSettingProperty | |
| CfnStage.CanarySettingProperty | |
| CfnStage.MethodSettingProperty | |
| CfnStageProps |
Properties for defining a `AWS::ApiGateway::Stage`.
|
| CfnStageV2.AccessLogSettingsProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnStageV2.RouteSettingsProperty | Deprecated
moved to package aws-apigatewayv2
|
| CfnStageV2Props | Deprecated
moved to package aws-apigatewayv2
|
| CfnUsagePlan.ApiStageProperty | |
| CfnUsagePlan.QuotaSettingsProperty | |
| CfnUsagePlan.ThrottleSettingsProperty | |
| CfnUsagePlanKeyProps |
Properties for defining a `AWS::ApiGateway::UsagePlanKey`.
|
| CfnUsagePlanProps |
Properties for defining a `AWS::ApiGateway::UsagePlan`.
|
| CfnVpcLinkProps |
Properties for defining a `AWS::ApiGateway::VpcLink`.
|
| CorsOptions | |
| DeploymentProps | |
| DomainNameAttributes | |
| DomainNameOptions | |
| DomainNameProps | |
| EndpointConfiguration |
(experimental) The endpoint configuration of a REST API, including VPCs and endpoint types.
|
| GatewayResponseOptions |
(experimental) Options to add gateway response.
|
| GatewayResponseProps |
(experimental) Properties for a new gateway response.
|
| HttpIntegrationProps | |
| IAccessLogDestination |
(experimental) Access log destination for a RestApi Stage.
|
| IAccessLogDestination.Jsii$Default |
Internal default implementation for
IAccessLogDestination. |
| IApiKey |
(experimental) 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 |
(experimental) Represents an API Gateway authorizer.
|
| IAuthorizer.Jsii$Default |
Internal default implementation for
IAuthorizer. |
| IDomainName | |
| IDomainName.Jsii$Default |
Internal default implementation for
IDomainName. |
| IGatewayResponse |
(experimental) Represents gateway response resource.
|
| IGatewayResponse.Jsii$Default |
Internal default implementation for
IGatewayResponse. |
| IModel | |
| IModel.Jsii$Default |
Internal default implementation for
IModel. |
| IntegrationConfig |
(experimental) Result of binding an Integration to a Method.
|
| IntegrationOptions | |
| IntegrationProps | |
| IntegrationResponse | |
| IRequestValidator | |
| IRequestValidator.Jsii$Default |
Internal default implementation for
IRequestValidator. |
| IResource | |
| IResource.Jsii$Default |
Internal default implementation for
IResource. |
| IRestApi | |
| IRestApi.Jsii$Default |
Internal default implementation for
IRestApi. |
| IStage |
(experimental) Represents an APIGateway Stage.
|
| IStage.Jsii$Default |
Internal default implementation for
IStage. |
| IVpcLink |
(experimental) Represents an API Gateway VpcLink.
|
| IVpcLink.Jsii$Default |
Internal default implementation for
IVpcLink. |
| JsonSchema |
(experimental) Represents a JSON schema definition of the structure of a REST API model.
|
| JsonWithStandardFieldProps |
(experimental) Properties for controlling items output in JSON standard format.
|
| LambdaAuthorizerProps |
(experimental) Base properties for all lambda authorizers.
|
| LambdaIntegrationOptions | |
| LambdaRestApiProps | |
| MethodDeploymentOptions | |
| MethodOptions | |
| MethodProps | |
| MethodResponse | |
| ModelOptions | |
| ModelProps | |
| MTLSConfig |
(experimental) The mTLS authentication configuration for a custom domain name.
|
| ProxyResourceOptions | |
| ProxyResourceProps | |
| QuotaSettings |
(experimental) Specifies the maximum number of requests that clients can make to API Gateway APIs.
|
| RateLimitedApiKeyProps |
(experimental) RateLimitedApiKey properties.
|
| RequestAuthorizerProps |
(experimental) Properties for RequestAuthorizer.
|
| RequestValidatorOptions | |
| RequestValidatorProps | |
| ResourceOptions | |
| ResourceProps | |
| RestApiAttributes |
(experimental) Attributes that can be specified when importing a RestApi.
|
| RestApiBaseProps |
(experimental) Represents the props that all Rest APIs share.
|
| RestApiOptions | Deprecated
- superceded by `RestApiBaseProps`
|
| RestApiProps |
(experimental) Props to create a new instance of RestApi.
|
| SpecRestApiProps |
(experimental) Props to instantiate a new SpecRestApi.
|
| StageOptions | |
| StageProps | |
| ThrottleSettings |
(experimental) Container for defining throttling parameters to API stages or methods.
|
| ThrottlingPerMethod |
(experimental) Represents per-method throttling for a resource.
|
| TokenAuthorizerProps |
(experimental) Properties for TokenAuthorizer.
|
| UsagePlanPerApiStage |
(experimental) Represents the API stages that a usage plan applies to.
|
| UsagePlanProps | |
| VpcLinkProps |
(experimental) Properties for a VpcLink.
|
| Enum | Description |
|---|---|
| ApiKeySourceType | |
| AuthorizationType | |
| ConnectionType | |
| ContentHandling | |
| EndpointType | |
| IntegrationType | |
| JsonSchemaType | |
| JsonSchemaVersion | |
| MethodLoggingLevel | |
| PassthroughBehavior | |
| Period |
(experimental) Time period for which quota settings apply.
|
| SecurityPolicy |
(experimental) The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.
|
Copyright © 2020. All rights reserved.