Uses of Package
software.amazon.awscdk.services.apigateway
Packages that use software.amazon.awscdk.services.apigateway
Package
Description
Amazon API Gateway Construct Library
CloudFront Origins for the CDK CloudFront Library
Event Targets for Amazon EventBridge
AWS Lambda Event Sources
Route53 Alias Record Targets for the CDK Route53 Library
Tasks for AWS Step Functions
-
Classes in software.amazon.awscdk.services.apigateway used by software.amazon.awscdk.services.apigatewayClassDescriptionOptions when binding a log destination to a RestApi Stage.A builder for
AccessLogDestinationConfigfactory methods for access log format.Options to the UsagePlan.addApiKey() method.A builder forAddApiKeyOptionsRepresents an OpenAPI definition asset.Post-Binding Configuration for a CDK construct.A builder forApiDefinitionConfigS3 location of the API definition file.A builder forApiDefinitionS3LocationAn API Gateway ApiKey.A fluent builder forApiKey.The options for creating an API Key.A builder forApiKeyOptionsApiKey Properties.A builder forApiKeyPropsOpenAPI specification from a local file.Example:Base class for all custom authorizers.This type of integration lets an API expose AWS service actions.A fluent builder forAwsIntegration.Example:A builder forAwsIntegrationPropsThis resource creates a base path that clients who call your API must use in the invocation URL.A fluent builder forBasePathMapping.Example:A builder forBasePathMappingOptionsExample:A builder forBasePathMappingPropsA CloudFormationAWS::ApiGateway::Account.A fluent builder forCfnAccount.Properties for defining aCfnAccount.A builder forCfnAccountPropsA CloudFormationAWS::ApiGateway::ApiKey.A fluent builder forCfnApiKey.StageKeyis a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key.A builder forCfnApiKey.StageKeyPropertyProperties for defining aCfnApiKey.A builder forCfnApiKeyPropsDeprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::Authorizer.A fluent builder forCfnAuthorizer.Properties for defining aCfnAuthorizer.A builder forCfnAuthorizerPropsDeprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::BasePathMapping.A fluent builder forCfnBasePathMapping.Properties for defining aCfnBasePathMapping.A builder forCfnBasePathMappingPropsA CloudFormationAWS::ApiGateway::ClientCertificate.A fluent builder forCfnClientCertificate.Properties for defining aCfnClientCertificate.A builder forCfnClientCertificatePropsA CloudFormationAWS::ApiGateway::Deployment.TheAccessLogSettingproperty type specifies settings for logging access in this stage.A builder forCfnDeployment.AccessLogSettingPropertyA fluent builder forCfnDeployment.TheCanarySettingproperty type specifies settings for the canary deployment in this stage.A builder forCfnDeployment.CanarySettingPropertyTheDeploymentCanarySettingsproperty type specifies settings for the canary deployment.A builder forCfnDeployment.DeploymentCanarySettingsPropertyTheMethodSettingproperty type configures settings for all methods in a stage.A builder forCfnDeployment.MethodSettingPropertyStageDescriptionis a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.A builder forCfnDeployment.StageDescriptionPropertyProperties for defining aCfnDeployment.A builder forCfnDeploymentPropsDeprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::DocumentationPart.A fluent builder forCfnDocumentationPart.TheLocationproperty specifies the location of the Amazon API Gateway API entity that the documentation applies to.A builder forCfnDocumentationPart.LocationPropertyProperties for defining aCfnDocumentationPart.A builder forCfnDocumentationPartPropsA CloudFormationAWS::ApiGateway::DocumentationVersion.A fluent builder forCfnDocumentationVersion.Properties for defining aCfnDocumentationVersion.A builder forCfnDocumentationVersionPropsA CloudFormationAWS::ApiGateway::DomainName.A fluent builder forCfnDomainName.TheEndpointConfigurationproperty type specifies the endpoint types of an Amazon API Gateway domain name.A builder forCfnDomainName.EndpointConfigurationPropertyThe mutual TLS authentication configuration for a custom domain name.A builder forCfnDomainName.MutualTlsAuthenticationPropertyProperties for defining aCfnDomainName.A builder forCfnDomainNamePropsDeprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::GatewayResponse.A fluent builder forCfnGatewayResponse.Properties for defining aCfnGatewayResponse.A builder forCfnGatewayResponsePropsDeprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::Method.A fluent builder forCfnMethod.Integrationis a property of the AWS::ApiGateway::Method resource that specifies information about the target backend that a method calls.A builder forCfnMethod.IntegrationPropertyIntegrationResponseis 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.A builder forCfnMethod.IntegrationResponsePropertyRepresents a method response of a given HTTP status code returned to the client.A builder forCfnMethod.MethodResponsePropertyProperties for defining aCfnMethod.A builder forCfnMethodPropsA CloudFormationAWS::ApiGateway::Model.A fluent builder forCfnModel.Properties for defining aCfnModel.A builder forCfnModelPropsDeprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::RequestValidator.A fluent builder forCfnRequestValidator.Properties for defining aCfnRequestValidator.A builder forCfnRequestValidatorPropsA CloudFormationAWS::ApiGateway::Resource.A fluent builder forCfnResource.Properties for defining aCfnResource.A builder forCfnResourcePropsA CloudFormationAWS::ApiGateway::RestApi.A fluent builder forCfnRestApi.TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.A builder forCfnRestApi.EndpointConfigurationPropertyS3Locationis 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.A builder forCfnRestApi.S3LocationPropertyProperties for defining aCfnRestApi.A builder forCfnRestApiPropsDeprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::Stage.TheAccessLogSettingproperty type specifies settings for logging access in this stage.A builder forCfnStage.AccessLogSettingPropertyA fluent builder forCfnStage.Configuration settings of a canary deployment.A builder forCfnStage.CanarySettingPropertyTheMethodSettingproperty type configures settings for all methods in a stage.A builder forCfnStage.MethodSettingPropertyProperties for defining aCfnStage.A builder forCfnStagePropsDeprecated.moved to package aws-apigatewayv2Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.Deprecated.moved to package aws-apigatewayv2Deprecated.A CloudFormationAWS::ApiGateway::UsagePlan.API stage name of the associated API stage in a usage plan.A builder forCfnUsagePlan.ApiStagePropertyA fluent builder forCfnUsagePlan.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.A builder forCfnUsagePlan.QuotaSettingsPropertyThrottleSettingsis 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.A builder forCfnUsagePlan.ThrottleSettingsPropertyA CloudFormationAWS::ApiGateway::UsagePlanKey.A fluent builder forCfnUsagePlanKey.Properties for defining aCfnUsagePlanKey.A builder forCfnUsagePlanKeyPropsProperties for defining aCfnUsagePlan.A builder forCfnUsagePlanPropsA CloudFormationAWS::ApiGateway::VpcLink.A fluent builder forCfnVpcLink.Properties for defining aCfnVpcLink.A builder forCfnVpcLinkPropsCognito user pools based custom authorizer.A fluent builder forCognitoUserPoolsAuthorizer.Properties for CognitoUserPoolsAuthorizer.A builder forCognitoUserPoolsAuthorizerPropsExample:Example:Example:A builder forCorsOptionsA Deployment of a REST API.A fluent builder forDeployment.Example:A builder forDeploymentPropsExample:A fluent builder forDomainName.Example:A builder forDomainNameAttributesExample:A builder forDomainNameOptionsExample:A builder forDomainNamePropsThe endpoint configuration of a REST API, including VPCs and endpoint types.A builder forEndpointConfigurationExample:Configure the response received by clients, produced from the API Gateway backend.A fluent builder forGatewayResponse.Options to add gateway response.A builder forGatewayResponseOptionsProperties for a new gateway response.A builder forGatewayResponsePropsYou can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.A fluent builder forHttpIntegration.Example:A builder forHttpIntegrationPropsAccess log destination for a RestApi Stage.Internal default implementation forIAccessLogDestination.API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.Internal default implementation forIApiKey.Represents an API Gateway authorizer.Internal default implementation forIAuthorizer.Internal default implementation forIDomainName.Represents gateway response resource.Internal default implementation forIGatewayResponse.Internal default implementation forIModel.OpenAPI specification from an inline JSON object.Base class for backend integrations for an API Gateway method.A fluent builder forIntegration.Result of binding an Integration to a Method.A builder forIntegrationConfigExample:A builder forIntegrationOptionsExample:A builder forIntegrationPropsExample:A builder forIntegrationResponseExample:Internal default implementation forIRequestValidator.Internal default implementation forIResource.Internal default implementation forIRestApi.Represents an APIGateway Stage.Internal default implementation forIStage.A UsagePlan, either managed by this CDK app, or imported.Internal default implementation forIUsagePlan.Represents an API Gateway VpcLink.Internal default implementation forIVpcLink.Represents a JSON schema definition of the structure of a REST API model.A builder forJsonSchemaExample:Example:Properties for controlling items output in JSON standard format.A builder forJsonWithStandardFieldPropsBase properties for all lambda authorizers.A builder forLambdaAuthorizerPropsIntegrates an AWS Lambda function to an API Gateway method.A fluent builder forLambdaIntegration.Example:A builder forLambdaIntegrationOptionsDefines an API Gateway REST API with AWS Lambda proxy integration.A fluent builder forLambdaRestApi.Example:A builder forLambdaRestApiPropsExample:A fluent builder forMethod.Example:A builder forMethodDeploymentOptionsExample:Example:A builder forMethodOptionsExample:A builder forMethodPropsExample:A builder forMethodResponseThis type of integration lets API Gateway return a response without sending the request further to the backend.A fluent builder forMockIntegration.Example:A fluent builder forModel.Example:A builder forModelOptionsExample:A builder forModelPropsThe mTLS authentication configuration for a custom domain name.A builder forMTLSConfigExample:Time period for which quota settings apply.Defines a {proxy+} greedy resource and an ANY method on a route.A fluent builder forProxyResource.Example:A builder forProxyResourceOptionsExample:A builder forProxyResourcePropsSpecifies the maximum number of requests that clients can make to API Gateway APIs.A builder forQuotaSettingsAn API Gateway ApiKey, for which a rate limiting configuration can be specified.A fluent builder forRateLimitedApiKey.RateLimitedApiKey properties.A builder forRateLimitedApiKeyPropsRequest-based lambda authorizer that recognizes the caller's identity via request parameters, such as headers, paths, query strings, stage variables, or context variables.A fluent builder forRequestAuthorizer.Properties for RequestAuthorizer.A builder forRequestAuthorizerPropsConfigure what must be included in therequestContext.A builder forRequestContextExample:A fluent builder forRequestValidator.Example:A builder forRequestValidatorOptionsExample:A builder forRequestValidatorPropsExample:A fluent builder forResource.Attributes that can be specified when importing a Resource.A builder forResourceAttributesExample:A builder forResourceOptionsExample:A builder forResourcePropsSupported types of gateway responses.Represents a REST API in Amazon API Gateway.A fluent builder forRestApi.Attributes that can be specified when importing a RestApi.A builder forRestApiAttributesBase implementation that are common to various implementations of IRestApi.Represents the props that all Rest APIs share.A builder forRestApiBasePropsDeprecated.superseded byRestApiBasePropsDeprecated.Props to create a new instance of RestApi.A builder forRestApiPropsOpenAPI specification from an S3 archive.The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.A fluent builder forSpecRestApi.Props to instantiate a new SpecRestApi.A builder forSpecRestApiPropsExample:A fluent builder forStage.Example:A builder forStageOptionsExample:A builder forStagePropsOptions when configuring Step Functions synchronous integration with Rest API.A builder forStepFunctionsExecutionIntegrationOptionsDefines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.A fluent builder forStepFunctionsRestApi.Properties for StepFunctionsRestApi.A builder forStepFunctionsRestApiPropsContainer for defining throttling parameters to API stages or methods.A builder forThrottleSettingsRepresents per-method throttling for a resource.A builder forThrottlingPerMethodToken based lambda authorizer that recognizes the caller's identity as a bearer token, such as a JSON Web Token (JWT) or an OAuth token.A fluent builder forTokenAuthorizer.Properties for TokenAuthorizer.A builder forTokenAuthorizerPropsExample:A fluent builder forUsagePlan.Represents the API stages that a usage plan applies to.A builder forUsagePlanPerApiStageExample:A builder forUsagePlanPropsDefine a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).A fluent builder forVpcLink.Properties for a VpcLink.A builder forVpcLinkProps -
-
-
-
Classes in software.amazon.awscdk.services.apigateway used by software.amazon.awscdk.services.route53.targetsClassDescriptionBase implementation that are common to various implementations of IRestApi.
-