AWS ApiGateway

22 CloudFormation resource types available for ApiGateway.

Account

AWS::ApiGateway::Account

The AWS::ApiGateway::Account resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one

ApiKey

AWS::ApiGateway::ApiKey

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. To specify which API key cl

Authorizer

AWS::ApiGateway::Authorizer

The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client c

BasePathMapping

AWS::ApiGateway::BasePathMapping

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL. Supported only for public custom domain names.

BasePathMappingV2

AWS::ApiGateway::BasePathMappingV2

Resource Type definition for AWS::ApiGateway::BasePathMappingV2

ClientCertificate

AWS::ApiGateway::ClientCertificate

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.

Deployment

AWS::ApiGateway::Deployment

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

DocumentationPart

AWS::ApiGateway::DocumentationPart

The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/

DocumentationVersion

AWS::ApiGateway::DocumentationVersion

The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.a

DomainName

AWS::ApiGateway::DomainName

The AWS::ApiGateway::DomainName resource specifies a public custom domain name for your API in API Gateway. To create a custom domain name for private APIs, use [AWS::ApiGateway::DomainNameV2](ht

DomainNameAccessAssociation

AWS::ApiGateway::DomainNameAccessAssociation

Resource Type definition for AWS::ApiGateway::DomainNameAccessAssociation.

DomainNameV2

AWS::ApiGateway::DomainNameV2

Resource Type definition for AWS::ApiGateway::DomainNameV2.

GatewayResponse

AWS::ApiGateway::GatewayResponse

The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. When you delete a stack containing this resource, your custom gateway responses are reset. For more informati

Method

AWS::ApiGateway::Method

The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

Model

AWS::ApiGateway::Model

The AWS::ApiGateway::Model resource defines the structure of a request or response payload for an API method.

RequestValidator

AWS::ApiGateway::RequestValidator

The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gatewa

Resource

AWS::ApiGateway::Resource

The AWS::ApiGateway::Resource resource creates a resource in an API.

RestApi

AWS::ApiGateway::RestApi

The AWS::ApiGateway::RestApi resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Ga

Stage

AWS::ApiGateway::Stage

The AWS::ApiGateway::Stage resource creates a stage for a deployment.

UsagePlan

AWS::ApiGateway::UsagePlan

The AWS::ApiGateway::UsagePlan resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information,

UsagePlanKey

AWS::ApiGateway::UsagePlanKey

The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

VpcLink

AWS::ApiGateway::VpcLink

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). For more information, see [vpclink:create](https:

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Stats

Resource Types: 22
Service Namespace: AWS::ApiGateway::*