Top / Amazon Web Service / AWS API Gateway

API Gateway

83 examples and best practices for AWS API Gateway, including AWS API Gateway Account and AWS API Gateway API Key.

terraform-logo

Review your .tf file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Account
aws_api_gateway_account (4 example cases)
AWS::ApiGateway::Account (0 example case)
API Key
aws_api_gateway_api_key (3 example cases)
AWS::ApiGateway::ApiKey (0 example case)
Authorizer
aws_api_gateway_authorizer (2 example cases)
AWS::ApiGateway::Authorizer (0 example case)
Base Path Mapping
aws_api_gateway_base_path_mapping (1 example case)
AWS::ApiGateway::BasePathMapping (0 example case)
Client Certificate
aws_api_gateway_client_certificate (2 example cases)
AWS::ApiGateway::ClientCertificate (0 example case)
Deployment
aws_api_gateway_deployment (5 example cases)
AWS::ApiGateway::Method Dependency (0 example case)
Documentation Part
aws_api_gateway_documentation_part (3 example cases)
AWS::ApiGateway::DocumentationPart (0 example case)
Documentation Version
aws_api_gateway_documentation_version (1 example case)
AWS::ApiGateway::DocumentationVersion (0 example case)
Domain Name
aws_api_gateway_domain_name (5 example cases)
1 best security practice
  1. Ensure to use modern TLS protocols
AWS::ApiGateway::DomainName (0 example case)
Gateway Response
aws_api_gateway_gateway_response (3 example cases)
AWS::ApiGateway::GatewayResponse (0 example case)
Integration
aws_api_gateway_integration (4 example cases)
AWS::ApiGateway::Method Integration (0 example case)
Integration Response
aws_api_gateway_integration_response (1 example case)
AWS::ApiGateway::Method IntegrationResponse (0 example case)
Method
aws_api_gateway_method (4 example cases)
1 best security practice
  1. Ensure that your API Gateway method blocks unwanted access
AWS::ApiGateway::Method (0 example case)
Method Response
aws_api_gateway_method_response (1 example case)
AWS::ApiGateway::Method MethodResponse (0 example case)
Method Settings
aws_api_gateway_method_settings (4 example cases)
1 best security practice
  1. Ensure that API Gateway stage-level cache is encrypted
AWS::ApiGateway::Deployment MethodSetting (0 example case)
Model
aws_api_gateway_model (5 example cases)
AWS::ApiGateway::Model (0 example case)
Request Validator
aws_api_gateway_request_validator (3 example cases)
AWS::ApiGateway::RequestValidator (0 example case)
Resource
aws_api_gateway_resource (2 example cases)
AWS::ApiGateway::Resource (0 example case)
Rest API
aws_api_gateway_rest_api (4 example cases)
AWS::ApiGateway::RestApi (5 example cases)
Rest API Policy
aws_api_gateway_rest_api_policy (3 example cases)
AWS::ApiGateway::RestApi EndpointConfiguration (0 example case)
Stage
aws_api_gateway_stage (5 example cases)
2 best security practices
  1. Ensure to enable access logging of your API Gateway stage (v1)
  2. Ensure to enable API Gateway X-Ray tracing
AWS::ApiGateway::Stage (5 example cases)
Usage Plan
aws_api_gateway_usage_plan (3 example cases)
AWS::ApiGateway::UsagePlan (0 example case)
Usage Plan Key
aws_api_gateway_usage_plan_key (2 example cases)
AWS::ApiGateway::UsagePlanKey (0 example case)
VPC Link
aws_api_gateway_vpc_link (3 example cases)
AWS::ApiGateway::VpcLink (0 example case)