Terraform AWS API Gateway v2
HTTP and WebSocket APIs with routes, stages, custom domains, TLS certificates, access logs, JWT or Lambda authorizers, throttling, and private or public integrations.
Quick start
module "apigateway-v2" {
source = "awswellarchitected.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}module "apigateway-v2" {
source = "nistcsf.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}module "apigateway-v2" {
source = "pcidss.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}module "apigateway-v2" {
source = "soc2.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}module "apigateway-v2" {
source = "iso27001.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}module "apigateway-v2" {
source = "acscessentialeight.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}module "apigateway-v2" {
source = "cfrpart11.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}module "apigateway-v2" {
source = "eugmpannex11.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
# ... your arguments here
}This module on the compliance.tf registry lists its versions, inputs and outputs. The Get Started guide and Registry Endpoints cover authentication and how to customize the module for your requirements.
Migration from upstream
Already using terraform-aws-modules? Change only the source URL:
module "apigateway-v2" {
source = "terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
}module "apigateway-v2" {
source = "soc2.compliance.tf/terraform-aws-modules/apigateway-v2/aws"
version = "~> 6.1"
}Same arguments. Same outputs. Controls are checked at terraform plan. The Migration Guide has the step-by-step version.
Reversibility
No lock-in. Switch back by reverting the source URL:
module "apigateway-v2" {
source = "terraform-aws-modules/apigateway-v2/aws"
}Run terraform init -upgrade. Terraform state is unchanged: same resource addresses, same provider, no compliance.tf-specific resources. Controls you already applied remain in AWS.
Controls enforced
Up to 5 controls are checked at terraform plan when this module comes from a compliance.tf endpoint. Which ones are active depends on the endpoint; see Framework coverage.
Mapped compliance frameworks
| Clause | Controls from this module |
|---|---|
| Data protection | |
| Detection | |
| Identity and access management |
| Clause | Controls from this module |
|---|---|
| PR.DS-1 | |
| PR.DS-5 | |
| RC.RP-06 |
| Clause | Controls from this module |
|---|---|
| 1.5.1 Security controls are implemented on any computing devices, including company- and employee-owned devices, that connect to both untrusted networks | |
| 10.2.1.1: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.1.2: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.1.3: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.1.4: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.1.5: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.1.6: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.1.7: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.1: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.2.2: Audit logs are implemented to support the detection of anomalies and suspicious activity, and the forensic analysis of events. | |
| 10.3.1: Audit logs are protected from destruction and unauthorized modifications. | |
| 10.3.2: Audit logs are protected from destruction and unauthorized modifications. | |
| 10.3.3: Audit log files, including those for externalfacing technologies, are promptly backed up to a secure, central, internal log server(s) or other media that is difficult to modify | |
| 10.3.4: File integrity monitoring or change-detection mechanisms is used on audit logs to ensure that existing log data cannot be changed without generating alerts | |
| 10.5.1: Retain audit log history for at least 12 months, with at least the most recent three months immediately available for analysis | |
| 10.6.3: Time-synchronization mechanisms support consistent time settings across all systems. | |
| 3.2.1: Storage of account data is kept to a minimum. | |
| 3.3.1.1: Sensitive authentication data (SAD) is not stored after authorization. | |
| 3.3.1.3: Sensitive authentication data (SAD) is not stored after authorization. | |
| 3.3.2: Sensitive authentication data (SAD) is not stored after authorization. | |
| 3.3.3: Sensitive authentication data (SAD) is not stored after authorization. | |
| 3.5.1: Primary account number (PAN) is secured wherever it is stored. | |
| 5.3.4: Anti-malware mechanisms and processes are active, maintained, and monitored. | |
| 8.3.2: Strong cryptography is used to render all authentication factors unreadable during transmission and storage on all system components | |
| A1.2.3: Processes or mechanisms are implemented for reporting and addressing suspected or confirmed security incidents and vulnerabilities |
| Clause | Controls from this module |
|---|---|
| A1.2 The entity authorizes, designs, develops or acquires, implements, operates, approves, maintains, and monitors environmental protections, software, data back-up processes, and recovery infrastructure to meet its objectives | |
| C1.2 The entity disposes of confidential information to meet the entity's objectives related to confidentiality | |
| CC6.1 The entity implements logical access security software, infrastructure, and architectures over protected information assets to protect them from security events to meet the entity's objectives | |
| CC7.2: The entity monitors system components and the operation of those components for anomalies that are indicative of malicious acts, natural disasters, and errors affecting the entity's ability to meet its objectives; anomalies are analyzed to determine whether they represent security events. | |
| CC7.3 The entity evaluates security events to determine whether they could or have resulted in a failure of the entity to meet its objectives (security incidents) and, if so, takes actions to prevent or address such failures | |
| P4.2 The entity retains personal information consistent with the entity's objectives related to privacy | |
| PI1.2 System inputs are measured and recorded completely, accurately, and timely to meet the entity's processing integrity commitments and system requirements | |
| PI1.4 System outputs are complete, accurate, distributed only to intended parties, and retained to meet the entity's processing integrity commitments and system requirements |
| Clause | Controls from this module |
|---|---|
| A.8.15 Logging | |
| A.8.16 Monitoring activities | |
| A.8.24 Use of cryptography |
| Clause | Controls from this module |
|---|---|
| ACSC-EE-ML2-7.7: Multi-factor authentication ML2 | |
| ACSC-EE-ML3-7.9: Multi-factor authentication ML3 |
| Clause | Controls from this module |
|---|---|
| 11.10(c) Protection of records to enable their accurate and ready retrieval throughout the records retention period | |
| 11.10(e) Use of secure, computer-generated, time-stamped audit trails to independently record the date and time of operator entries and actions that create, modify, or delete electronic records | |
| 11.30 Controls for open systems |
| Clause | Controls from this module |
|---|---|
| 17 Archiving | |
| 7.1 Data Storage - Damage Protection |
Framework coverage
Which controls from this module are active under each framework endpoint. Your framework preferences choose the columns.
| Control | PCI DSS v4.0 | SOC 2 |
|---|---|---|
| API Gateway routes should require an authorization type | Enforced | Not active |
| API Gateway V2 routes should require an authorizer | Not active | Enforced |
| CloudWatch log groups should have retention period of at least 365 days | Enforced | Enforced |
| API Gateway V2 stages should have access logging configured | Enforced | Enforced |
| Log groups should have encryption at rest enabled | Enforced | Enforced |
5 controls enforced with a source URL change.