feat(client-api-gateway): Adds support for setting the IP address type to allow dual-stack or IPv4 address types to invoke your APIs or domain names.

Author: awstools

clients/client-api-gateway/src/commands/CreateDomainNameCommand.ts

@@ -48,6 +48,7 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
  *     types: [ // ListOfEndpointType
  *       "REGIONAL" || "EDGE" || "PRIVATE",
  *     ],
+ *     ipAddressType: "ipv4" || "dualstack",
  *     vpcEndpointIds: [ // ListOfString
  *       "STRING_VALUE",
  *     ],
@@ -82,6 +83,7 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [ // ListOfString
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/commands/CreateRestApiCommand.ts

@@ -49,6 +49,7 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {}
  *     types: [ // ListOfEndpointType
  *       "REGIONAL" || "EDGE" || "PRIVATE",
  *     ],
+ *     ipAddressType: "ipv4" || "dualstack",
  *     vpcEndpointIds: [
  *       "STRING_VALUE",
  *     ],
@@ -79,6 +80,7 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {}
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/commands/GetDomainNameCommand.ts

@@ -58,6 +58,7 @@ export interface GetDomainNameCommandOutput extends DomainName, __MetadataBearer
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [ // ListOfString
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/commands/GetDomainNamesCommand.ts

@@ -61,6 +61,7 @@ export interface GetDomainNamesCommandOutput extends DomainNames, __MetadataBear
  * //         types: [ // ListOfEndpointType
  * //           "REGIONAL" || "EDGE" || "PRIVATE",
  * //         ],
+ * //         ipAddressType: "ipv4" || "dualstack",
  * //         vpcEndpointIds: [ // ListOfString
  * //           "STRING_VALUE",
  * //         ],

clients/client-api-gateway/src/commands/GetRestApiCommand.ts

@@ -58,6 +58,7 @@ export interface GetRestApiCommandOutput extends RestApi, __MetadataBearer {}
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/commands/GetRestApisCommand.ts

@@ -61,6 +61,7 @@ export interface GetRestApisCommandOutput extends RestApis, __MetadataBearer {}
  * //         types: [ // ListOfEndpointType
  * //           "REGIONAL" || "EDGE" || "PRIVATE",
  * //         ],
+ * //         ipAddressType: "ipv4" || "dualstack",
  * //         vpcEndpointIds: [
  * //           "STRING_VALUE",
  * //         ],

clients/client-api-gateway/src/commands/ImportRestApiCommand.ts

@@ -69,6 +69,7 @@ export interface ImportRestApiCommandOutput extends RestApi, __MetadataBearer {}
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/commands/PutRestApiCommand.ts

@@ -72,6 +72,7 @@ export interface PutRestApiCommandOutput extends RestApi, __MetadataBearer {}
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/commands/UpdateDomainNameCommand.ts

@@ -66,6 +66,7 @@ export interface UpdateDomainNameCommandOutput extends DomainName, __MetadataBea
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [ // ListOfString
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/commands/UpdateRestApiCommand.ts

@@ -66,6 +66,7 @@ export interface UpdateRestApiCommandOutput extends RestApi, __MetadataBearer {}
  * //     types: [ // ListOfEndpointType
  * //       "REGIONAL" || "EDGE" || "PRIVATE",
  * //     ],
+ * //     ipAddressType: "ipv4" || "dualstack",
  * //     vpcEndpointIds: [
  * //       "STRING_VALUE",
  * //     ],

clients/client-api-gateway/src/models/models_0.ts

@@ -1031,6 +1031,20 @@ export interface DocumentationVersion {
   description?: string | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const IpAddressType = {
+  dualstack: "dualstack",
+  ipv4: "ipv4",
+} as const;
+
+/**
+ * @public
+ */
+export type IpAddressType = (typeof IpAddressType)[keyof typeof IpAddressType];
+
 /**
  * @public
  * @enum
@@ -1047,7 +1061,7 @@ export const EndpointType = {
 export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
 
 /**
- * <p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. </p>
+ * <p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it. </p>
  * @public
  */
 export interface EndpointConfiguration {
@@ -1057,6 +1071,14 @@ export interface EndpointConfiguration {
    */
   types?: EndpointType[] | undefined;
 
+  /**
+   * <p>The IP address types that can invoke an API (RestApi) or a DomainName. Use <code>ipv4</code> to allow only IPv4 addresses to
+   *     invoke an API or DomainName, or use <code>dualstack</code> to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the
+   *       <code>PRIVATE</code> endpoint type, only <code>dualstack</code> is supported.</p>
+   * @public
+   */
+  ipAddressType?: IpAddressType | undefined;
+
   /**
    * <p>A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type.</p>
    * @public
@@ -1156,7 +1178,7 @@ export interface CreateDomainNameRequest {
   regionalCertificateArn?: string | undefined;
 
   /**
-   * <p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>
+   * <p>The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name. </p>
    * @public
    */
   endpointConfiguration?: EndpointConfiguration | undefined;
@@ -1327,7 +1349,7 @@ export interface DomainName {
   distributionHostedZoneId?: string | undefined;
 
   /**
-   * <p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>
+   * <p>The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name. </p>
    * @public
    */
   endpointConfiguration?: EndpointConfiguration | undefined;
@@ -2044,7 +2066,7 @@ export interface CreateRestApiRequest {
   apiKeySource?: ApiKeySourceType | undefined;
 
   /**
-   * <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
+   * <p>The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API. </p>
    * @public
    */
   endpointConfiguration?: EndpointConfiguration | undefined;
@@ -2134,7 +2156,7 @@ export interface RestApi {
   apiKeySource?: ApiKeySourceType | undefined;
 
   /**
-   * <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
+   * <p>The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API. </p>
    * @public
    */
   endpointConfiguration?: EndpointConfiguration | undefined;

codegen/sdk-codegen/aws-models/api-gateway.json

@@ -2688,7 +2688,7 @@
         "endpointConfiguration": {
           "target": "com.amazonaws.apigateway#EndpointConfiguration",
           "traits": {
-            "smithy.api#documentation": "<p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>"
+            "smithy.api#documentation": "<p>The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name. </p>"
           }
         },
         "tags": {
@@ -3030,7 +3030,7 @@
         "endpointConfiguration": {
           "target": "com.amazonaws.apigateway#EndpointConfiguration",
           "traits": {
-            "smithy.api#documentation": "<p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>"
+            "smithy.api#documentation": "<p>The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API. </p>"
           }
         },
         "policy": {
@@ -5100,7 +5100,7 @@
         "endpointConfiguration": {
           "target": "com.amazonaws.apigateway#EndpointConfiguration",
           "traits": {
-            "smithy.api#documentation": "<p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>"
+            "smithy.api#documentation": "<p>The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name. </p>"
           }
         },
         "domainNameStatus": {
@@ -5285,6 +5285,12 @@
             "smithy.api#documentation": "<p>A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</p>"
           }
         },
+        "ipAddressType": {
+          "target": "com.amazonaws.apigateway#IpAddressType",
+          "traits": {
+            "smithy.api#documentation": "<p>The IP address types that can invoke an API (RestApi) or a DomainName. Use <code>ipv4</code> to allow only IPv4 addresses to\n    invoke an API or DomainName, or use <code>dualstack</code> to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the\n      <code>PRIVATE</code> endpoint type, only <code>dualstack</code> is supported.</p>"
+          }
+        },
         "vpcEndpointIds": {
           "target": "com.amazonaws.apigateway#ListOfString",
           "traits": {
@@ -5293,7 +5299,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. </p>"
+        "smithy.api#documentation": "<p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it. </p>"
       }
     },
     "com.amazonaws.apigateway#EndpointType": {
@@ -9078,6 +9084,23 @@
         "smithy.api#documentation": "<p>The integration type. The valid value is <code>HTTP</code> for integrating an API method with an HTTP backend; <code>AWS</code> with any Amazon Web Services service endpoints; <code>MOCK</code> for testing without actually invoking the backend; <code>HTTP_PROXY</code> for integrating with the HTTP proxy integration; <code>AWS_PROXY</code> for integrating with the Lambda proxy integration. </p>"
       }
     },
+    "com.amazonaws.apigateway#IpAddressType": {
+      "type": "enum",
+      "members": {
+        "ipv4": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "ipv4"
+          }
+        },
+        "dualstack": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "dualstack"
+          }
+        }
+      }
+    },
     "com.amazonaws.apigateway#LimitExceededException": {
       "type": "structure",
       "members": {
@@ -10737,7 +10760,7 @@
         "endpointConfiguration": {
           "target": "com.amazonaws.apigateway#EndpointConfiguration",
           "traits": {
-            "smithy.api#documentation": "<p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>"
+            "smithy.api#documentation": "<p>The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API. </p>"
           }
         },
         "policy": {