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

awstools · awstools · commit 7528ca99f2a2 · 2025-03-28T18:16:15.000Z
diff --git a/clients/client-apigatewayv2/src/commands/CreateApiCommand.ts b/clients/client-apigatewayv2/src/commands/CreateApiCommand.ts
@@ -57,6 +57,7 @@ export interface CreateApiCommandOutput extends CreateApiResponse, __MetadataBea
  *   Description: "STRING_VALUE",
  *   DisableSchemaValidation: true || false,
  *   DisableExecuteApiEndpoint: true || false,
+ *   IpAddressType: "ipv4" || "dualstack",
  *   Name: "STRING_VALUE", // required
  *   ProtocolType: "WEBSOCKET" || "HTTP", // required
  *   RouteKey: "STRING_VALUE",
@@ -97,6 +98,7 @@ export interface CreateApiCommandOutput extends CreateApiResponse, __MetadataBea
  * //   ImportInfo: [ // __listOf__string
  * //     "STRING_VALUE",
  * //   ],
+ * //   IpAddressType: "ipv4" || "dualstack",
  * //   Name: "STRING_VALUE",
  * //   ProtocolType: "WEBSOCKET" || "HTTP",
  * //   RouteSelectionExpression: "STRING_VALUE",
diff --git a/clients/client-apigatewayv2/src/commands/CreateDomainNameCommand.ts b/clients/client-apigatewayv2/src/commands/CreateDomainNameCommand.ts
@@ -47,6 +47,7 @@ export interface CreateDomainNameCommandOutput extends CreateDomainNameResponse,
  *       DomainNameStatusMessage: "STRING_VALUE",
  *       EndpointType: "REGIONAL" || "EDGE",
  *       HostedZoneId: "STRING_VALUE",
+ *       IpAddressType: "ipv4" || "dualstack",
  *       SecurityPolicy: "TLS_1_0" || "TLS_1_2",
  *       OwnershipVerificationCertificateArn: "STRING_VALUE",
  *     },
@@ -74,6 +75,7 @@ export interface CreateDomainNameCommandOutput extends CreateDomainNameResponse,
  * //       DomainNameStatusMessage: "STRING_VALUE",
  * //       EndpointType: "REGIONAL" || "EDGE",
  * //       HostedZoneId: "STRING_VALUE",
+ * //       IpAddressType: "ipv4" || "dualstack",
  * //       SecurityPolicy: "TLS_1_0" || "TLS_1_2",
  * //       OwnershipVerificationCertificateArn: "STRING_VALUE",
  * //     },
diff --git a/clients/client-apigatewayv2/src/commands/GetApiCommand.ts b/clients/client-apigatewayv2/src/commands/GetApiCommand.ts
@@ -68,6 +68,7 @@ export interface GetApiCommandOutput extends GetApiResponse, __MetadataBearer {}
  * //   ImportInfo: [ // __listOf__string
  * //     "STRING_VALUE",
  * //   ],
+ * //   IpAddressType: "ipv4" || "dualstack",
  * //   Name: "STRING_VALUE",
  * //   ProtocolType: "WEBSOCKET" || "HTTP",
  * //   RouteSelectionExpression: "STRING_VALUE",
diff --git a/clients/client-apigatewayv2/src/commands/GetApisCommand.ts b/clients/client-apigatewayv2/src/commands/GetApisCommand.ts
@@ -71,6 +71,7 @@ export interface GetApisCommandOutput extends GetApisResponse, __MetadataBearer
  * //       ImportInfo: [ // __listOf__string
  * //         "STRING_VALUE",
  * //       ],
+ * //       IpAddressType: "ipv4" || "dualstack",
  * //       Name: "STRING_VALUE", // required
  * //       ProtocolType: "WEBSOCKET" || "HTTP", // required
  * //       RouteSelectionExpression: "STRING_VALUE", // required
diff --git a/clients/client-apigatewayv2/src/commands/GetDomainNameCommand.ts b/clients/client-apigatewayv2/src/commands/GetDomainNameCommand.ts
@@ -53,6 +53,7 @@ export interface GetDomainNameCommandOutput extends GetDomainNameResponse, __Met
  * //       DomainNameStatusMessage: "STRING_VALUE",
  * //       EndpointType: "REGIONAL" || "EDGE",
  * //       HostedZoneId: "STRING_VALUE",
+ * //       IpAddressType: "ipv4" || "dualstack",
  * //       SecurityPolicy: "TLS_1_0" || "TLS_1_2",
  * //       OwnershipVerificationCertificateArn: "STRING_VALUE",
  * //     },
diff --git a/clients/client-apigatewayv2/src/commands/GetDomainNamesCommand.ts b/clients/client-apigatewayv2/src/commands/GetDomainNamesCommand.ts
@@ -56,6 +56,7 @@ export interface GetDomainNamesCommandOutput extends GetDomainNamesResponse, __M
  * //           DomainNameStatusMessage: "STRING_VALUE",
  * //           EndpointType: "REGIONAL" || "EDGE",
  * //           HostedZoneId: "STRING_VALUE",
+ * //           IpAddressType: "ipv4" || "dualstack",
  * //           SecurityPolicy: "TLS_1_0" || "TLS_1_2",
  * //           OwnershipVerificationCertificateArn: "STRING_VALUE",
  * //         },
diff --git a/clients/client-apigatewayv2/src/commands/ImportApiCommand.ts b/clients/client-apigatewayv2/src/commands/ImportApiCommand.ts
@@ -70,6 +70,7 @@ export interface ImportApiCommandOutput extends ImportApiResponse, __MetadataBea
  * //   ImportInfo: [ // __listOf__string
  * //     "STRING_VALUE",
  * //   ],
+ * //   IpAddressType: "ipv4" || "dualstack",
  * //   Name: "STRING_VALUE",
  * //   ProtocolType: "WEBSOCKET" || "HTTP",
  * //   RouteSelectionExpression: "STRING_VALUE",
diff --git a/clients/client-apigatewayv2/src/commands/ReimportApiCommand.ts b/clients/client-apigatewayv2/src/commands/ReimportApiCommand.ts
@@ -71,6 +71,7 @@ export interface ReimportApiCommandOutput extends ReimportApiResponse, __Metadat
  * //   ImportInfo: [ // __listOf__string
  * //     "STRING_VALUE",
  * //   ],
+ * //   IpAddressType: "ipv4" || "dualstack",
  * //   Name: "STRING_VALUE",
  * //   ProtocolType: "WEBSOCKET" || "HTTP",
  * //   RouteSelectionExpression: "STRING_VALUE",
diff --git a/clients/client-apigatewayv2/src/commands/UpdateApiCommand.ts b/clients/client-apigatewayv2/src/commands/UpdateApiCommand.ts
@@ -58,6 +58,7 @@ export interface UpdateApiCommandOutput extends UpdateApiResponse, __MetadataBea
  *   Description: "STRING_VALUE",
  *   DisableSchemaValidation: true || false,
  *   DisableExecuteApiEndpoint: true || false,
+ *   IpAddressType: "ipv4" || "dualstack",
  *   Name: "STRING_VALUE",
  *   RouteKey: "STRING_VALUE",
  *   RouteSelectionExpression: "STRING_VALUE",
@@ -94,6 +95,7 @@ export interface UpdateApiCommandOutput extends UpdateApiResponse, __MetadataBea
  * //   ImportInfo: [ // __listOf__string
  * //     "STRING_VALUE",
  * //   ],
+ * //   IpAddressType: "ipv4" || "dualstack",
  * //   Name: "STRING_VALUE",
  * //   ProtocolType: "WEBSOCKET" || "HTTP",
  * //   RouteSelectionExpression: "STRING_VALUE",
diff --git a/clients/client-apigatewayv2/src/commands/UpdateDomainNameCommand.ts b/clients/client-apigatewayv2/src/commands/UpdateDomainNameCommand.ts
@@ -47,6 +47,7 @@ export interface UpdateDomainNameCommandOutput extends UpdateDomainNameResponse,
  *       DomainNameStatusMessage: "STRING_VALUE",
  *       EndpointType: "REGIONAL" || "EDGE",
  *       HostedZoneId: "STRING_VALUE",
+ *       IpAddressType: "ipv4" || "dualstack",
  *       SecurityPolicy: "TLS_1_0" || "TLS_1_2",
  *       OwnershipVerificationCertificateArn: "STRING_VALUE",
  *     },
@@ -71,6 +72,7 @@ export interface UpdateDomainNameCommandOutput extends UpdateDomainNameResponse,
  * //       DomainNameStatusMessage: "STRING_VALUE",
  * //       EndpointType: "REGIONAL" || "EDGE",
  * //       HostedZoneId: "STRING_VALUE",
+ * //       IpAddressType: "ipv4" || "dualstack",
  * //       SecurityPolicy: "TLS_1_0" || "TLS_1_2",
  * //       OwnershipVerificationCertificateArn: "STRING_VALUE",
  * //     },
diff --git a/clients/client-apigatewayv2/src/models/models_0.ts b/clients/client-apigatewayv2/src/models/models_0.ts
@@ -45,6 +45,20 @@ export interface Cors {
   MaxAge?: number | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const IpAddressType = {
+  dualstack: "dualstack",
+  ipv4: "ipv4",
+} as const;
+
+/**
+ * @public
+ */
+export type IpAddressType = (typeof IpAddressType)[keyof typeof IpAddressType];
+
 /**
  * @public
  * @enum
@@ -124,6 +138,12 @@ export interface Api {
    */
   ImportInfo?: string[] | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the API.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
@@ -451,6 +471,12 @@ export interface DomainNameConfiguration {
    */
   HostedZoneId?: string | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the domain name. Use ipv4 to allow only IPv4 addresses to invoke your domain name, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your domain name.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>
    * @public
@@ -1315,6 +1341,12 @@ export interface CreateApiRequest {
    */
   DisableExecuteApiEndpoint?: boolean | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the API.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
@@ -1422,6 +1454,12 @@ export interface CreateApiResponse {
    */
   ImportInfo?: string[] | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the API.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
@@ -3189,6 +3227,12 @@ export interface GetApiResponse {
    */
   ImportInfo?: string[] | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the API.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
@@ -4674,6 +4718,12 @@ export interface ImportApiResponse {
    */
   ImportInfo?: string[] | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the API.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
@@ -4805,6 +4855,12 @@ export interface ReimportApiResponse {
    */
   ImportInfo?: string[] | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the API.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
@@ -4946,6 +5002,12 @@ export interface UpdateApiRequest {
    */
   DisableExecuteApiEndpoint?: boolean | undefined;
 
+  /**
+   * <p>The IP address types that can invoke your API or domain name.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
@@ -5041,6 +5103,12 @@ export interface UpdateApiResponse {
    */
   ImportInfo?: string[] | undefined;
 
+  /**
+   * <p>The IP address types that can invoke the API.</p>
+   * @public
+   */
+  IpAddressType?: IpAddressType | undefined;
+
   /**
    * <p>The name of the API.</p>
    * @public
diff --git a/clients/client-apigatewayv2/src/protocols/Aws_restJson1.ts b/clients/client-apigatewayv2/src/protocols/Aws_restJson1.ts
@@ -190,6 +190,7 @@ export const se_CreateApiCommand = async (
       description: [, , `Description`],
       disableExecuteApiEndpoint: [, , `DisableExecuteApiEndpoint`],
       disableSchemaValidation: [, , `DisableSchemaValidation`],
+      ipAddressType: [, , `IpAddressType`],
       name: [, , `Name`],
       protocolType: [, , `ProtocolType`],
       routeKey: [, , `RouteKey`],
@@ -1420,6 +1421,7 @@ export const se_UpdateApiCommand = async (
       description: [, , `Description`],
       disableExecuteApiEndpoint: [, , `DisableExecuteApiEndpoint`],
       disableSchemaValidation: [, , `DisableSchemaValidation`],
+      ipAddressType: [, , `IpAddressType`],
       name: [, , `Name`],
       routeKey: [, , `RouteKey`],
       routeSelectionExpression: [, , `RouteSelectionExpression`],
@@ -1775,6 +1777,7 @@ export const de_CreateApiCommand = async (
     DisableExecuteApiEndpoint: [, __expectBoolean, `disableExecuteApiEndpoint`],
     DisableSchemaValidation: [, __expectBoolean, `disableSchemaValidation`],
     ImportInfo: [, _json, `importInfo`],
+    IpAddressType: [, __expectString, `ipAddressType`],
     Name: [, __expectString, `name`],
     ProtocolType: [, __expectString, `protocolType`],
     RouteSelectionExpression: [, __expectString, `routeSelectionExpression`],
@@ -2419,6 +2422,7 @@ export const de_GetApiCommand = async (
     DisableExecuteApiEndpoint: [, __expectBoolean, `disableExecuteApiEndpoint`],
     DisableSchemaValidation: [, __expectBoolean, `disableSchemaValidation`],
     ImportInfo: [, _json, `importInfo`],
+    IpAddressType: [, __expectString, `ipAddressType`],
     Name: [, __expectString, `name`],
     ProtocolType: [, __expectString, `protocolType`],
     RouteSelectionExpression: [, __expectString, `routeSelectionExpression`],
@@ -3079,6 +3083,7 @@ export const de_ImportApiCommand = async (
     DisableExecuteApiEndpoint: [, __expectBoolean, `disableExecuteApiEndpoint`],
     DisableSchemaValidation: [, __expectBoolean, `disableSchemaValidation`],
     ImportInfo: [, _json, `importInfo`],
+    IpAddressType: [, __expectString, `ipAddressType`],
     Name: [, __expectString, `name`],
     ProtocolType: [, __expectString, `protocolType`],
     RouteSelectionExpression: [, __expectString, `routeSelectionExpression`],
@@ -3115,6 +3120,7 @@ export const de_ReimportApiCommand = async (
     DisableExecuteApiEndpoint: [, __expectBoolean, `disableExecuteApiEndpoint`],
     DisableSchemaValidation: [, __expectBoolean, `disableSchemaValidation`],
     ImportInfo: [, _json, `importInfo`],
+    IpAddressType: [, __expectString, `ipAddressType`],
     Name: [, __expectString, `name`],
     ProtocolType: [, __expectString, `protocolType`],
     RouteSelectionExpression: [, __expectString, `routeSelectionExpression`],
@@ -3202,6 +3208,7 @@ export const de_UpdateApiCommand = async (
     DisableExecuteApiEndpoint: [, __expectBoolean, `disableExecuteApiEndpoint`],
     DisableSchemaValidation: [, __expectBoolean, `disableSchemaValidation`],
     ImportInfo: [, _json, `importInfo`],
+    IpAddressType: [, __expectString, `ipAddressType`],
     Name: [, __expectString, `name`],
     ProtocolType: [, __expectString, `protocolType`],
     RouteSelectionExpression: [, __expectString, `routeSelectionExpression`],
@@ -3707,6 +3714,7 @@ const se_DomainNameConfiguration = (input: DomainNameConfiguration, context: __S
     domainNameStatusMessage: [, , `DomainNameStatusMessage`],
     endpointType: [, , `EndpointType`],
     hostedZoneId: [, , `HostedZoneId`],
+    ipAddressType: [, , `IpAddressType`],
     ownershipVerificationCertificateArn: [, , `OwnershipVerificationCertificateArn`],
     securityPolicy: [, , `SecurityPolicy`],
   });
@@ -3989,6 +3997,7 @@ const de_Api = (output: any, context: __SerdeContext): Api => {
     DisableExecuteApiEndpoint: [, __expectBoolean, `disableExecuteApiEndpoint`],
     DisableSchemaValidation: [, __expectBoolean, `disableSchemaValidation`],
     ImportInfo: [, _json, `importInfo`],
+    IpAddressType: [, __expectString, `ipAddressType`],
     Name: [, __expectString, `name`],
     ProtocolType: [, __expectString, `protocolType`],
     RouteSelectionExpression: [, __expectString, `routeSelectionExpression`],
@@ -4095,6 +4104,7 @@ const de_DomainNameConfiguration = (output: any, context: __SerdeContext): Domai
     DomainNameStatusMessage: [, __expectString, `domainNameStatusMessage`],
     EndpointType: [, __expectString, `endpointType`],
     HostedZoneId: [, __expectString, `hostedZoneId`],
+    IpAddressType: [, __expectString, `ipAddressType`],
     OwnershipVerificationCertificateArn: [, __expectString, `ownershipVerificationCertificateArn`],
     SecurityPolicy: [, __expectString, `securityPolicy`],
   }) as any;
diff --git a/codegen/sdk-codegen/aws-models/apigatewayv2.json b/codegen/sdk-codegen/aws-models/apigatewayv2.json
