feat: add support for IpAddressType

br0connor · br0connor · commit d5b9f128fd05 · 2025-11-06T18:14:37.000Z
diff --git a/integration/resources/expected/single/api_with_ipaddresstype.json b/integration/resources/expected/single/api_with_ipaddresstype.json
@@ -0,0 +1,14 @@
+[
+  {
+    "LogicalResourceId": "MyApi",
+    "ResourceType": "AWS::ApiGateway::RestApi"
+  },
+  {
+    "LogicalResourceId": "MyApiDeployment",
+    "ResourceType": "AWS::ApiGateway::Deployment"
+  },
+  {
+    "LogicalResourceId": "MyApiProdStage",
+    "ResourceType": "AWS::ApiGateway::Stage"
+  }
+]
diff --git a/integration/resources/templates/single/api_with_ipaddresstype.yaml b/integration/resources/templates/single/api_with_ipaddresstype.yaml
@@ -0,0 +1,16 @@
+Parameters:
+  IpAddressType:
+    Type: String
+    Default: ipv4
+
+Resources:
+  MyApi:
+    Type: AWS::Serverless::Api
+    Properties:
+      StageName: Prod
+      DefinitionUri: ${definitionuri}
+      EndpointConfiguration:
+        Type: REGIONAL
+        IpAddressType: !Ref IpAddressType
+Metadata:
+  SamTransformTest: true
diff --git a/integration/single/test_api_with_ipaddresstype.py b/integration/single/test_api_with_ipaddresstype.py
@@ -0,0 +1,25 @@
+from unittest.case import skipIf
+
+from integration.config.service_names import REST_API
+from integration.helpers.base_test import BaseTest
+from integration.helpers.resource import current_region_does_not_support
+
+
+@skipIf(current_region_does_not_support([REST_API]), "Rest API is not supported in this testing region")
+class TestApiWithIpAddressType(BaseTest):
+    """
+    Test AWS::Serverless::Api with IpAddressType in EndpointConfiguration
+    """
+
+    def test_api_with_ipaddresstype(self):
+        """
+        Creates an API with IpAddressType set to ipv4
+        """
+        parameters = [{"ParameterKey": "IpAddressType", "ParameterValue": "ipv4"}]
+        self.create_and_verify_stack("single/api_with_ipaddresstype", parameters)
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        rest_api = self.client_provider.api_client.get_rest_api(restApiId=rest_api_id)
+
+        self.assertEqual(rest_api["endpointConfiguration"]["types"], ["REGIONAL"])
+        self.assertEqual(rest_api["endpointConfiguration"]["ipAddressType"], "ipv4")
diff --git a/samtranslator/internal/schema_source/aws_serverless_api.py b/samtranslator/internal/schema_source/aws_serverless_api.py
@@ -223,6 +223,11 @@ class EndpointConfiguration(BaseModel):
         "VPCEndpointIds",
         ["AWS::ApiGateway::RestApi.EndpointConfiguration", "VpcEndpointIds"],
     )
+    IpAddressType: Optional[PassThroughProp] = passthrough_prop(
+        ENDPOINT_CONFIGURATION_STEM,
+        "IpAddressType",
+        ["AWS::ApiGateway::RestApi.EndpointConfiguration", "IpAddressType"],
+    )
 
 
 Name = Optional[PassThroughProp]
diff --git a/samtranslator/internal/schema_source/sam-docs.json b/samtranslator/internal/schema_source/sam-docs.json
@@ -53,7 +53,8 @@
     },
     "sam-property-api-endpointconfiguration": {
       "Type": "The endpoint type of a REST API\\.  \n*Valid values*: `EDGE` or `REGIONAL` or `PRIVATE`  \n*Type*: String  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is passed directly to the [`Types`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types) property of the `AWS::ApiGateway::RestApi` `EndpointConfiguration` data type\\.",
-      "VPCEndpointIds": "A list of VPC endpoint IDs of a REST API against which to create Route53 aliases\\.  \n*Type*: List  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is passed directly to the [`VpcEndpointIds`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids) property of the `AWS::ApiGateway::RestApi` `EndpointConfiguration` data type\\."
+      "VPCEndpointIds": "A list of VPC endpoint IDs of a REST API against which to create Route53 aliases\\.  \n*Type*: List  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is passed directly to the [`VpcEndpointIds`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids) property of the `AWS::ApiGateway::RestApi` `EndpointConfiguration` data type\\.",
+      "IpAddressType": "The IP address type for the API Gateway endpoint\\.  \n*Valid values*: `ipv4` or `dualstack`  \n*Type*: String  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is passed directly to the [`IpAddressType`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype) property of the `AWS::ApiGateway::RestApi` `EndpointConfiguration` data type\\."
     },
     "sam-property-api-lambdarequestauthorizationidentity": {
       "Context": "Converts the given context strings to the mapping expressions of format `context.contextString`\\.  \n*Type*: List  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
diff --git a/samtranslator/model/api/api_generator.py b/samtranslator/model/api/api_generator.py
@@ -1537,6 +1537,10 @@ def _set_endpoint_configuration(self, rest_api: ApiGatewayRestApi, value: Union[
                 rest_api.EndpointConfiguration["VpcEndpointIds"] = value.get("VPCEndpointIds") or value.get(
                     "VpcEndpointIds"
                 )
+
+            # Handle IpAddressType if present
+            if "IpAddressType" in value:
+                rest_api.EndpointConfiguration["IpAddressType"] = value.get("IpAddressType")
         else:
             rest_api.EndpointConfiguration = {"Types": [value]}
             rest_api.Parameters = {"endpointConfigurationTypes": value}
diff --git a/samtranslator/schema/schema.json b/samtranslator/schema/schema.json
@@ -6478,6 +6478,11 @@
     "AWS::ApiGateway::RestApi.EndpointConfiguration": {
       "additionalProperties": false,
       "properties": {
+        "IpAddressType": {
+          "markdownDescription": "The IP address types that can invoke an API (RestApi). Use `ipv4` to allow only IPv4 addresses to invoke an API, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke an API. For the `PRIVATE` endpoint type, only `dualstack` is supported.",
+          "title": "IpAddressType",
+          "type": "string"
+        },
         "Types": {
           "items": {
             "type": "string"
@@ -274565,6 +274570,11 @@
     "EndpointConfiguration": {
       "additionalProperties": false,
       "properties": {
+        "IpAddressType": {
+          "markdownDescription": "The IP address type for the API Gateway endpoint\\.  \n*Valid values*: `ipv4` or `dualstack`  \n*Type*: String  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is passed directly to the [`IpAddressType`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype) property of the `AWS::ApiGateway::RestApi` `EndpointConfiguration` data type\\.",
+          "title": "IpAddressType",
+          "type": "string"
+        },
         "Type": {
           "items": {
             "type": "string"
diff --git a/schema_source/cloudformation.schema.json b/schema_source/cloudformation.schema.json
@@ -6471,6 +6471,11 @@
     "AWS::ApiGateway::RestApi.EndpointConfiguration": {
       "additionalProperties": false,
       "properties": {
+        "IpAddressType": {
+          "markdownDescription": "The IP address types that can invoke an API (RestApi). Use `ipv4` to allow only IPv4 addresses to invoke an API, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke an API. For the `PRIVATE` endpoint type, only `dualstack` is supported.",
+          "title": "IpAddressType",
+          "type": "string"
+        },
         "Types": {
           "items": {
             "type": "string"
diff --git a/schema_source/sam.schema.json b/schema_source/sam.schema.json
@@ -1164,6 +1164,23 @@
     "EndpointConfiguration": {
       "additionalProperties": false,
       "properties": {
+        "IpAddressType": {
+          "__samPassThrough": {
+            "markdownDescriptionOverride": "The IP address type for the API Gateway endpoint\\.  \n*Valid values*: `ipv4` or `dualstack`  \n*Type*: String  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is passed directly to the [`IpAddressType`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype) property of the `AWS::ApiGateway::RestApi` `EndpointConfiguration` data type\\.",
+            "schemaPath": [
+              "definitions",
+              "AWS::ApiGateway::RestApi.EndpointConfiguration",
+              "properties",
+              "IpAddressType"
+            ]
+          },
+          "allOf": [
+            {
+              "$ref": "#/definitions/PassThroughProp"
+            }
+          ],
+          "title": "IpAddressType"
+        },
         "Type": {
           "__samPassThrough": {
             "markdownDescriptionOverride": "The endpoint type of a REST API\\.  \n*Valid values*: `EDGE` or `REGIONAL` or `PRIVATE`  \n*Type*: String  \n*Required*: No  \n*AWS CloudFormation compatibility*: This property is passed directly to the [`Types`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types) property of the `AWS::ApiGateway::RestApi` `EndpointConfiguration` data type\\.",
diff --git a/tests/translator/input/api_endpoint_configuration_with_ipaddresstype.yaml b/tests/translator/input/api_endpoint_configuration_with_ipaddresstype.yaml
@@ -0,0 +1,39 @@
+Parameters:
+  EndpointConfigType:
+    Type: String
+  IpAddressType:
+    Type: String
+    Default: ipv4
+    AllowedValues:
+    - ipv4
+    - dualstack
+
+Globals:
+  Api:
+    # Overriding this property for Implicit API
+    EndpointConfiguration:
+      Type: {Ref: EndpointConfigType}
+      IpAddressType: {Ref: IpAddressType}
+
+Resources:
+  ImplicitApiFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: s3://sam-demo-bucket/member_portal.zip
+      Handler: index.gethtml
+      Runtime: nodejs12.x
+      Events:
+        GetHtml:
+          Type: Api
+          Properties:
+            Path: /
+            Method: get
+
+  ExplicitApi:
+    Type: AWS::Serverless::Api
+    Properties:
+      StageName: Prod
+      DefinitionUri: s3://sam-demo-bucket/webpage_swagger.json
+      EndpointConfiguration:
+        Type: REGIONAL
+        IpAddressType: ipv4
diff --git a/tests/translator/output/api_endpoint_configuration_with_ipaddresstype.json b/tests/translator/output/api_endpoint_configuration_with_ipaddresstype.json
@@ -0,0 +1,196 @@
+{
+  "Parameters": {
+    "EndpointConfigType": {
+      "Type": "String"
+    },
+    "IpAddressType": {
+      "AllowedValues": [
+        "ipv4",
+        "dualstack"
+      ],
+      "Default": "ipv4",
+      "Type": "String"
+    }
+  },
+  "Resources": {
+    "ExplicitApi": {
+      "Properties": {
+        "BodyS3Location": {
+          "Bucket": "sam-demo-bucket",
+          "Key": "webpage_swagger.json"
+        },
+        "EndpointConfiguration": {
+          "IpAddressType": "ipv4",
+          "Types": [
+            "REGIONAL"
+          ]
+        },
+        "Parameters": {
+          "endpointConfigurationTypes": "REGIONAL"
+        }
+      },
+      "Type": "AWS::ApiGateway::RestApi"
+    },
+    "ExplicitApiDeploymentf117c932f7": {
+      "Properties": {
+        "Description": "RestApi deployment id: f117c932f75cfa87d23dfed64e9430d0081ef289",
+        "RestApiId": {
+          "Ref": "ExplicitApi"
+        },
+        "StageName": "Stage"
+      },
+      "Type": "AWS::ApiGateway::Deployment"
+    },
+    "ExplicitApiProdStage": {
+      "Properties": {
+        "DeploymentId": {
+          "Ref": "ExplicitApiDeploymentf117c932f7"
+        },
+        "RestApiId": {
+          "Ref": "ExplicitApi"
+        },
+        "StageName": "Prod"
+      },
+      "Type": "AWS::ApiGateway::Stage"
+    },
+    "ImplicitApiFunction": {
+      "Properties": {
+        "Code": {
+          "S3Bucket": "sam-demo-bucket",
+          "S3Key": "member_portal.zip"
+        },
+        "Handler": "index.gethtml",
+        "Role": {
+          "Fn::GetAtt": [
+            "ImplicitApiFunctionRole",
+            "Arn"
+          ]
+        },
+        "Runtime": "nodejs12.x",
+        "Tags": [
+          {
+            "Key": "lambda:createdBy",
+            "Value": "SAM"
+          }
+        ]
+      },
+      "Type": "AWS::Lambda::Function"
+    },
+    "ImplicitApiFunctionGetHtmlPermissionProd": {
+      "Properties": {
+        "Action": "lambda:InvokeFunction",
+        "FunctionName": {
+          "Ref": "ImplicitApiFunction"
+        },
+        "Principal": "apigateway.amazonaws.com",
+        "SourceArn": {
+          "Fn::Sub": [
+            "arn:aws:execute-api:${AWS::Region}:${AWS::AccountId}:${__ApiId__}/${__Stage__}/GET/",
+            {
+              "__ApiId__": {
+                "Ref": "ServerlessRestApi"
+              },
+              "__Stage__": "*"
+            }
+          ]
+        }
+      },
+      "Type": "AWS::Lambda::Permission"
+    },
+    "ImplicitApiFunctionRole": {
+      "Properties": {
+        "AssumeRolePolicyDocument": {
+          "Statement": [
+            {
+              "Action": [
+                "sts:AssumeRole"
+              ],
+              "Effect": "Allow",
+              "Principal": {
+                "Service": [
+                  "lambda.amazonaws.com"
+                ]
+              }
+            }
+          ],
+          "Version": "2012-10-17"
+        },
+        "ManagedPolicyArns": [
+          "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"
+        ],
+        "Tags": [
+          {
+            "Key": "lambda:createdBy",
+            "Value": "SAM"
+          }
+        ]
+      },
+      "Type": "AWS::IAM::Role"
+    },
+    "ServerlessRestApi": {
+      "Properties": {
+        "Body": {
+          "info": {
+            "title": {
+              "Ref": "AWS::StackName"
+            },
+            "version": "1.0"
+          },
+          "paths": {
+            "/": {
+              "get": {
+                "responses": {},
+                "x-amazon-apigateway-integration": {
+                  "httpMethod": "POST",
+                  "type": "aws_proxy",
+                  "uri": {
+                    "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ImplicitApiFunction.Arn}/invocations"
+                  }
+                }
+              }
+            }
+          },
+          "swagger": "2.0"
+        },
+        "EndpointConfiguration": {
+          "IpAddressType": {
+            "Ref": "IpAddressType"
+          },
+          "Types": [
+            {
+              "Ref": "EndpointConfigType"
+            }
+          ]
+        },
+        "Parameters": {
+          "endpointConfigurationTypes": {
+            "Ref": "EndpointConfigType"
+          }
+        }
+      },
+      "Type": "AWS::ApiGateway::RestApi"
+    },
+    "ServerlessRestApiDeployment62b96c1a61": {
+      "Properties": {
+        "Description": "RestApi deployment id: 62b96c1a611878eefb13e8ef66dbc71b9ba3dd19",
+        "RestApiId": {
+          "Ref": "ServerlessRestApi"
+        },
+        "StageName": "Stage"
+      },
+      "Type": "AWS::ApiGateway::Deployment"
+    },
+    "ServerlessRestApiProdStage": {
+      "Properties": {
+        "DeploymentId": {
+          "Ref": "ServerlessRestApiDeployment62b96c1a61"
+        },
+        "RestApiId": {
+          "Ref": "ServerlessRestApi"
+        },
+        "StageName": "Prod"
+      },
+      "Type": "AWS::ApiGateway::Stage"
+    }
+  }
+}
diff --git a/tests/translator/output/aws-cn/api_endpoint_configuration_with_ipaddresstype.json b/tests/translator/output/aws-cn/api_endpoint_configuration_with_ipaddresstype.json
diff --git a/tests/translator/output/aws-us-gov/api_endpoint_configuration_with_ipaddresstype.json b/tests/translator/output/aws-us-gov/api_endpoint_configuration_with_ipaddresstype.json
