aws-cdk-lib 2.186.0__py3-none-any.whl → 2.188.0__py3-none-any.whl

aws_cdk/aws_apigateway/__init__.py

@@ -2834,6 +2834,7 @@ class ApiDefinition(
         file: builtins.str,
         *,
         deploy_time: typing.Optional[builtins.bool] = None,
+        display_name: typing.Optional[builtins.str] = None,
         readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
         source_kms_key: typing.Optional[_IKey_5f11635f] = None,
         asset_hash: typing.Optional[builtins.str] = None,
@@ -2847,6 +2848,7 @@ class ApiDefinition(
 
         :param file: -
         :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
+        :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
         :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
         :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
         :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -2861,6 +2863,7 @@ class ApiDefinition(
             check_type(argname="argument file", value=file, expected_type=type_hints["file"])
         options = _AssetOptions_2aa69621(
             deploy_time=deploy_time,
+            display_name=display_name,
             readers=readers,
             source_kms_key=source_kms_key,
             asset_hash=asset_hash,
@@ -3266,6 +3269,7 @@ class AssetApiDefinition(
         path: builtins.str,
         *,
         deploy_time: typing.Optional[builtins.bool] = None,
+        display_name: typing.Optional[builtins.str] = None,
         readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
         source_kms_key: typing.Optional[_IKey_5f11635f] = None,
         asset_hash: typing.Optional[builtins.str] = None,
@@ -3278,6 +3282,7 @@ class AssetApiDefinition(
         '''
         :param path: -
         :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
+        :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
         :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
         :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
         :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -3292,6 +3297,7 @@ class AssetApiDefinition(
             check_type(argname="argument path", value=path, expected_type=type_hints["path"])
         options = _AssetOptions_2aa69621(
             deploy_time=deploy_time,
+            display_name=display_name,
             readers=readers,
             source_kms_key=source_kms_key,
             asset_hash=asset_hash,
@@ -7703,6 +7709,7 @@ class CfnDomainName(
             certificate_arn="certificateArn",
             domain_name="domainName",
             endpoint_configuration=apigateway.CfnDomainName.EndpointConfigurationProperty(
+                ip_address_type="ipAddressType",
                 types=["types"]
             ),
             mutual_tls_authentication=apigateway.CfnDomainName.MutualTlsAuthenticationProperty(
@@ -7738,7 +7745,7 @@ class CfnDomainName(
         :param id: Construct identifier for this resource (unique in its scope).
         :param certificate_arn: The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.
         :param domain_name: The custom domain name as an API host name, for example, ``my-api.example.com`` .
-        :param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types of the domain name.
+        :param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
         :param mutual_tls_authentication: The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
         :param ownership_verification_certificate_arn: The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
         :param regional_certificate_arn: The reference to an AWS -managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
@@ -7878,7 +7885,7 @@ class CfnDomainName(
     def endpoint_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainName.EndpointConfigurationProperty"]]:
-        '''The endpoint configuration of this DomainName showing the endpoint types of the domain name.'''
+        '''The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainName.EndpointConfigurationProperty"]], jsii.get(self, "endpointConfiguration"))
 
     @endpoint_configuration.setter
@@ -7967,18 +7974,20 @@ class CfnDomainName(
     @jsii.data_type(
         jsii_type="aws-cdk-lib.aws_apigateway.CfnDomainName.EndpointConfigurationProperty",
         jsii_struct_bases=[],
-        name_mapping={"types": "types"},
+        name_mapping={"ip_address_type": "ipAddressType", "types": "types"},
     )
     class EndpointConfigurationProperty:
         def __init__(
             self,
             *,
+            ip_address_type: typing.Optional[builtins.str] = None,
             types: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''The ``EndpointConfiguration`` property type specifies the endpoint types of an Amazon API Gateway domain name.
+            '''The ``EndpointConfiguration`` property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.
 
             ``EndpointConfiguration`` is a property of the `AWS::ApiGateway::DomainName <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html>`_ resource.
 
+            :param ip_address_type: The IP address types that can invoke this DomainName. Use ``ipv4`` to allow only IPv4 addresses to invoke this DomainName, or use ``dualstack`` to allow both IPv4 and IPv6 addresses to invoke this DomainName. For the ``PRIVATE`` endpoint type, only ``dualstack`` is supported.
             :param types: 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 ``"EDGE"`` . For a regional API and its custom domain name, the endpoint type is ``REGIONAL`` . For a private API, the endpoint type is ``PRIVATE`` .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html
@@ -7991,16 +8000,31 @@ class CfnDomainName(
                 from aws_cdk import aws_apigateway as apigateway
                 
                 endpoint_configuration_property = apigateway.CfnDomainName.EndpointConfigurationProperty(
+                    ip_address_type="ipAddressType",
                     types=["types"]
                 )
             '''
             if __debug__:
                 type_hints = typing.get_type_hints(_typecheckingstub__1d33c3bf6996efa92019e1b28e2d6c1c9ad4dd0fa50f2ad639962efcfa774fb2)
+                check_type(argname="argument ip_address_type", value=ip_address_type, expected_type=type_hints["ip_address_type"])
                 check_type(argname="argument types", value=types, expected_type=type_hints["types"])
             self._values: typing.Dict[builtins.str, typing.Any] = {}
+            if ip_address_type is not None:
+                self._values["ip_address_type"] = ip_address_type
             if types is not None:
                 self._values["types"] = types
 
+        @builtins.property
+        def ip_address_type(self) -> typing.Optional[builtins.str]:
+            '''The IP address types that can invoke this DomainName.
+
+            Use ``ipv4`` to allow only IPv4 addresses to invoke this DomainName, or use ``dualstack`` to allow both IPv4 and IPv6 addresses to invoke this DomainName. For the ``PRIVATE`` endpoint type, only ``dualstack`` is supported.
+
+            :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-ipaddresstype
+            '''
+            result = self._values.get("ip_address_type")
+            return typing.cast(typing.Optional[builtins.str], result)
+
         @builtins.property
         def types(self) -> typing.Optional[typing.List[builtins.str]]:
             '''A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
@@ -8423,7 +8447,7 @@ class CfnDomainNameProps:
 
         :param certificate_arn: The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.
         :param domain_name: The custom domain name as an API host name, for example, ``my-api.example.com`` .
-        :param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types of the domain name.
+        :param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
         :param mutual_tls_authentication: The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
         :param ownership_verification_certificate_arn: The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
         :param regional_certificate_arn: The reference to an AWS -managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
@@ -8443,6 +8467,7 @@ class CfnDomainNameProps:
                 certificate_arn="certificateArn",
                 domain_name="domainName",
                 endpoint_configuration=apigateway.CfnDomainName.EndpointConfigurationProperty(
+                    ip_address_type="ipAddressType",
                     types=["types"]
                 ),
                 mutual_tls_authentication=apigateway.CfnDomainName.MutualTlsAuthenticationProperty(
@@ -8510,7 +8535,7 @@ class CfnDomainNameProps:
     def endpoint_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDomainName.EndpointConfigurationProperty]]:
-        '''The endpoint configuration of this DomainName showing the endpoint types of the domain name.
+        '''The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration
         '''
@@ -8640,7 +8665,7 @@ class CfnDomainNameV2(
         :param id: Construct identifier for this resource (unique in its scope).
         :param certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
         :param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
-        :param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
+        :param endpoint_configuration: 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.
         :param policy: A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration. You can use ``Fn::ToJsonString`` to enter your ``policy`` . For more information, see `Fn::ToJsonString <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html>`_ .
         :param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
         :param tags: The collection of tags. Each tag element is associated with a given resource.
@@ -8750,7 +8775,7 @@ class CfnDomainNameV2(
     def endpoint_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainNameV2.EndpointConfigurationProperty"]]:
-        '''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.'''
+        '''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.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainNameV2.EndpointConfigurationProperty"]], jsii.get(self, "endpointConfiguration"))
 
     @endpoint_configuration.setter
@@ -8813,7 +8838,7 @@ class CfnDomainNameV2(
             *,
             types: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
+            '''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.
 
             :param types: 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 ``"EDGE"`` . For a regional API and its custom domain name, the endpoint type is ``REGIONAL`` . For a private API, the endpoint type is ``PRIVATE`` .
 
@@ -8887,7 +8912,7 @@ class CfnDomainNameV2Props:
 
         :param certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
         :param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
-        :param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
+        :param endpoint_configuration: 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.
         :param policy: A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration. You can use ``Fn::ToJsonString`` to enter your ``policy`` . For more information, see `Fn::ToJsonString <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html>`_ .
         :param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
         :param tags: The collection of tags. Each tag element is associated with a given resource.
@@ -8963,7 +8988,7 @@ class CfnDomainNameV2Props:
     def endpoint_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDomainNameV2.EndpointConfigurationProperty]]:
-        '''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
+        '''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.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-endpointconfiguration
         '''
@@ -11452,6 +11477,7 @@ class CfnRestApi(
             description="description",
             disable_execute_api_endpoint=False,
             endpoint_configuration=apigateway.CfnRestApi.EndpointConfigurationProperty(
+                ip_address_type="ipAddressType",
                 types=["types"],
                 vpc_endpoint_ids=["vpcEndpointIds"]
             ),
@@ -11501,7 +11527,7 @@ class CfnRestApi(
         :param clone_from: The ID of the RestApi that you want to clone from.
         :param description: The description of the RestApi.
         :param disable_execute_api_endpoint: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
-        :param endpoint_configuration: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
+        :param endpoint_configuration: A list of the endpoint types and IP address types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
         :param fail_on_warnings: A query parameter to indicate whether to rollback the API update ( ``true`` ) or not ( ``false`` ) when a warning is encountered. The default value is ``false`` .
         :param minimum_compression_size: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
         :param mode: This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge`` . For ``overwrite`` , the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge`` , the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite`` . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
@@ -11702,7 +11728,7 @@ class CfnRestApi(
     def endpoint_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRestApi.EndpointConfigurationProperty"]]:
-        '''A list of the endpoint types of the API.'''
+        '''A list of the endpoint types and IP address types of the API.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRestApi.EndpointConfigurationProperty"]], jsii.get(self, "endpointConfiguration"))
 
     @endpoint_configuration.setter
@@ -11819,19 +11845,25 @@ class CfnRestApi(
     @jsii.data_type(
         jsii_type="aws-cdk-lib.aws_apigateway.CfnRestApi.EndpointConfigurationProperty",
         jsii_struct_bases=[],
-        name_mapping={"types": "types", "vpc_endpoint_ids": "vpcEndpointIds"},
+        name_mapping={
+            "ip_address_type": "ipAddressType",
+            "types": "types",
+            "vpc_endpoint_ids": "vpcEndpointIds",
+        },
     )
     class EndpointConfigurationProperty:
         def __init__(
             self,
             *,
+            ip_address_type: typing.Optional[builtins.str] = None,
             types: typing.Optional[typing.Sequence[builtins.str]] = None,
             vpc_endpoint_ids: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API.
+            '''The ``EndpointConfiguration`` property type specifies the endpoint types and IP address types of a REST API.
 
             ``EndpointConfiguration`` is a property of the `AWS::ApiGateway::RestApi <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html>`_ resource.
 
+            :param ip_address_type: 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.
             :param types: 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 ``"EDGE"`` . For a regional API and its custom domain name, the endpoint type is ``REGIONAL`` . For a private API, the endpoint type is ``PRIVATE`` .
             :param vpc_endpoint_ids: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type.
 
@@ -11845,20 +11877,35 @@ class CfnRestApi(
                 from aws_cdk import aws_apigateway as apigateway
                 
                 endpoint_configuration_property = apigateway.CfnRestApi.EndpointConfigurationProperty(
+                    ip_address_type="ipAddressType",
                     types=["types"],
                     vpc_endpoint_ids=["vpcEndpointIds"]
                 )
             '''
             if __debug__:
                 type_hints = typing.get_type_hints(_typecheckingstub__df9522828c39c6e4b1e829251c3b77d5b94051a139bf4f10dfa3ac8717e878b6)
+                check_type(argname="argument ip_address_type", value=ip_address_type, expected_type=type_hints["ip_address_type"])
                 check_type(argname="argument types", value=types, expected_type=type_hints["types"])
                 check_type(argname="argument vpc_endpoint_ids", value=vpc_endpoint_ids, expected_type=type_hints["vpc_endpoint_ids"])
             self._values: typing.Dict[builtins.str, typing.Any] = {}
+            if ip_address_type is not None:
+                self._values["ip_address_type"] = ip_address_type
             if types is not None:
                 self._values["types"] = types
             if vpc_endpoint_ids is not None:
                 self._values["vpc_endpoint_ids"] = vpc_endpoint_ids
 
+        @builtins.property
+        def ip_address_type(self) -> typing.Optional[builtins.str]:
+            '''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.
+
+            :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype
+            '''
+            result = self._values.get("ip_address_type")
+            return typing.cast(typing.Optional[builtins.str], result)
+
         @builtins.property
         def types(self) -> typing.Optional[typing.List[builtins.str]]:
             '''A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
@@ -12054,7 +12101,7 @@ class CfnRestApiProps:
         :param clone_from: The ID of the RestApi that you want to clone from.
         :param description: The description of the RestApi.
         :param disable_execute_api_endpoint: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
-        :param endpoint_configuration: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
+        :param endpoint_configuration: A list of the endpoint types and IP address types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
         :param fail_on_warnings: A query parameter to indicate whether to rollback the API update ( ``true`` ) or not ( ``false`` ) when a warning is encountered. The default value is ``false`` .
         :param minimum_compression_size: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
         :param mode: This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge`` . For ``overwrite`` , the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge`` , the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite`` . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
@@ -12089,6 +12136,7 @@ class CfnRestApiProps:
                 description="description",
                 disable_execute_api_endpoint=False,
                 endpoint_configuration=apigateway.CfnRestApi.EndpointConfigurationProperty(
+                    ip_address_type="ipAddressType",
                     types=["types"],
                     vpc_endpoint_ids=["vpcEndpointIds"]
                 ),
@@ -12234,7 +12282,7 @@ class CfnRestApiProps:
     def endpoint_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnRestApi.EndpointConfigurationProperty]]:
-        '''A list of the endpoint types of the API.
+        '''A list of the endpoint types and IP address types of the API.
 
         Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
 
@@ -33279,6 +33327,7 @@ def _typecheckingstub__931fac6af706dd0dae384cc682b2ecb066666ff6165060417e461a392
     file: builtins.str,
     *,
     deploy_time: typing.Optional[builtins.bool] = None,
+    display_name: typing.Optional[builtins.str] = None,
     readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
     source_kms_key: typing.Optional[_IKey_5f11635f] = None,
     asset_hash: typing.Optional[builtins.str] = None,
@@ -33346,6 +33395,7 @@ def _typecheckingstub__8d060d6bc8fc5b369cfe71dc05efc964aa6b083b674baa7dc17f1762a
     path: builtins.str,
     *,
     deploy_time: typing.Optional[builtins.bool] = None,
+    display_name: typing.Optional[builtins.str] = None,
     readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
     source_kms_key: typing.Optional[_IKey_5f11635f] = None,
     asset_hash: typing.Optional[builtins.str] = None,
@@ -34145,6 +34195,7 @@ def _typecheckingstub__30658cbd8b896f811f887630d934f0751b5370d775062da4c8686d7ca
 
 def _typecheckingstub__1d33c3bf6996efa92019e1b28e2d6c1c9ad4dd0fa50f2ad639962efcfa774fb2(
     *,
+    ip_address_type: typing.Optional[builtins.str] = None,
     types: typing.Optional[typing.Sequence[builtins.str]] = None,
 ) -> None:
     """Type checking stubs"""
@@ -34848,6 +34899,7 @@ def _typecheckingstub__9ae71bb5beb4f360ca0016003cbb508243a9ad4b5e494d1a4655780f8
 
 def _typecheckingstub__df9522828c39c6e4b1e829251c3b77d5b94051a139bf4f10dfa3ac8717e878b6(
     *,
+    ip_address_type: typing.Optional[builtins.str] = None,
     types: typing.Optional[typing.Sequence[builtins.str]] = None,
     vpc_endpoint_ids: typing.Optional[typing.Sequence[builtins.str]] = None,
 ) -> None:

aws_cdk/aws_apigatewayv2/__init__.py

@@ -842,6 +842,7 @@ class CfnApi(
             disable_execute_api_endpoint=False,
             disable_schema_validation=False,
             fail_on_warnings=False,
+            ip_address_type="ipAddressType",
             name="name",
             protocol_type="protocolType",
             route_key="routeKey",
@@ -869,6 +870,7 @@ class CfnApi(
         disable_execute_api_endpoint: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
         disable_schema_validation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
         fail_on_warnings: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
+        ip_address_type: typing.Optional[builtins.str] = None,
         name: typing.Optional[builtins.str] = None,
         protocol_type: typing.Optional[builtins.str] = None,
         route_key: typing.Optional[builtins.str] = None,
@@ -890,6 +892,7 @@ class CfnApi(
         :param disable_execute_api_endpoint: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
         :param disable_schema_validation: Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
         :param fail_on_warnings: Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
+        :param ip_address_type: The IP address types that can invoke the API. Use ``ipv4`` to allow only IPv4 addresses to invoke your API, or use ``dualstack`` to allow both IPv4 and IPv6 addresses to invoke your API. Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.
         :param name: The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation`` .
         :param protocol_type: The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP`` . Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation`` .
         :param route_key: This property is part of quick create. If you don't specify a ``routeKey`` , a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
@@ -913,6 +916,7 @@ class CfnApi(
             disable_execute_api_endpoint=disable_execute_api_endpoint,
             disable_schema_validation=disable_schema_validation,
             fail_on_warnings=fail_on_warnings,
+            ip_address_type=ip_address_type,
             name=name,
             protocol_type=protocol_type,
             route_key=route_key,
@@ -1143,6 +1147,19 @@ class CfnApi(
             check_type(argname="argument value", value=value, expected_type=type_hints["value"])
         jsii.set(self, "failOnWarnings", value) # pyright: ignore[reportArgumentType]
 
+    @builtins.property
+    @jsii.member(jsii_name="ipAddressType")
+    def ip_address_type(self) -> typing.Optional[builtins.str]:
+        '''The IP address types that can invoke the API.'''
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ipAddressType"))
+
+    @ip_address_type.setter
+    def ip_address_type(self, value: typing.Optional[builtins.str]) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__2a1eb652a1c167ca6cb7d9b75ef226df1b04d95736668747822e7afa0766e2fd)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "ipAddressType", value) # pyright: ignore[reportArgumentType]
+
     @builtins.property
     @jsii.member(jsii_name="name")
     def name(self) -> typing.Optional[builtins.str]:
@@ -2732,6 +2749,7 @@ class CfnApiMappingProps:
         "disable_execute_api_endpoint": "disableExecuteApiEndpoint",
         "disable_schema_validation": "disableSchemaValidation",
         "fail_on_warnings": "failOnWarnings",
+        "ip_address_type": "ipAddressType",
         "name": "name",
         "protocol_type": "protocolType",
         "route_key": "routeKey",
@@ -2755,6 +2773,7 @@ class CfnApiProps:
         disable_execute_api_endpoint: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
         disable_schema_validation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
         fail_on_warnings: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
+        ip_address_type: typing.Optional[builtins.str] = None,
         name: typing.Optional[builtins.str] = None,
         protocol_type: typing.Optional[builtins.str] = None,
         route_key: typing.Optional[builtins.str] = None,
@@ -2775,6 +2794,7 @@ class CfnApiProps:
         :param disable_execute_api_endpoint: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
         :param disable_schema_validation: Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
         :param fail_on_warnings: Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
+        :param ip_address_type: The IP address types that can invoke the API. Use ``ipv4`` to allow only IPv4 addresses to invoke your API, or use ``dualstack`` to allow both IPv4 and IPv6 addresses to invoke your API. Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.
         :param name: The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation`` .
         :param protocol_type: The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP`` . Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation`` .
         :param route_key: This property is part of quick create. If you don't specify a ``routeKey`` , a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
@@ -2817,6 +2837,7 @@ class CfnApiProps:
                 disable_execute_api_endpoint=False,
                 disable_schema_validation=False,
                 fail_on_warnings=False,
+                ip_address_type="ipAddressType",
                 name="name",
                 protocol_type="protocolType",
                 route_key="routeKey",
@@ -2840,6 +2861,7 @@ class CfnApiProps:
             check_type(argname="argument disable_execute_api_endpoint", value=disable_execute_api_endpoint, expected_type=type_hints["disable_execute_api_endpoint"])
             check_type(argname="argument disable_schema_validation", value=disable_schema_validation, expected_type=type_hints["disable_schema_validation"])
             check_type(argname="argument fail_on_warnings", value=fail_on_warnings, expected_type=type_hints["fail_on_warnings"])
+            check_type(argname="argument ip_address_type", value=ip_address_type, expected_type=type_hints["ip_address_type"])
             check_type(argname="argument name", value=name, expected_type=type_hints["name"])
             check_type(argname="argument protocol_type", value=protocol_type, expected_type=type_hints["protocol_type"])
             check_type(argname="argument route_key", value=route_key, expected_type=type_hints["route_key"])
@@ -2868,6 +2890,8 @@ class CfnApiProps:
             self._values["disable_schema_validation"] = disable_schema_validation
         if fail_on_warnings is not None:
             self._values["fail_on_warnings"] = fail_on_warnings
+        if ip_address_type is not None:
+            self._values["ip_address_type"] = ip_address_type
         if name is not None:
             self._values["name"] = name
         if protocol_type is not None:
@@ -3001,6 +3025,19 @@ class CfnApiProps:
         result = self._values.get("fail_on_warnings")
         return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], result)
 
+    @builtins.property
+    def ip_address_type(self) -> typing.Optional[builtins.str]:
+        '''The IP address types that can invoke the API.
+
+        Use ``ipv4`` to allow only IPv4 addresses to invoke your API, or use ``dualstack`` to allow both IPv4 and IPv6 addresses to invoke your API.
+
+        Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.
+
+        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-ipaddresstype
+        '''
+        result = self._values.get("ip_address_type")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def name(self) -> typing.Optional[builtins.str]:
         '''The name of the API.
@@ -3970,6 +4007,7 @@ class CfnDomainName(
                 certificate_arn="certificateArn",
                 certificate_name="certificateName",
                 endpoint_type="endpointType",
+                ip_address_type="ipAddressType",
                 ownership_verification_certificate_arn="ownershipVerificationCertificateArn",
                 security_policy="securityPolicy"
             )],
@@ -4156,6 +4194,7 @@ class CfnDomainName(
             "certificate_arn": "certificateArn",
             "certificate_name": "certificateName",
             "endpoint_type": "endpointType",
+            "ip_address_type": "ipAddressType",
             "ownership_verification_certificate_arn": "ownershipVerificationCertificateArn",
             "security_policy": "securityPolicy",
         },
@@ -4167,6 +4206,7 @@ class CfnDomainName(
             certificate_arn: typing.Optional[builtins.str] = None,
             certificate_name: typing.Optional[builtins.str] = None,
             endpoint_type: typing.Optional[builtins.str] = None,
+            ip_address_type: typing.Optional[builtins.str] = None,
             ownership_verification_certificate_arn: typing.Optional[builtins.str] = None,
             security_policy: typing.Optional[builtins.str] = None,
         ) -> None:
@@ -4177,6 +4217,7 @@ class CfnDomainName(
             :param certificate_arn: An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
             :param certificate_name: The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
             :param endpoint_type: The endpoint type.
+            :param ip_address_type: 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.
             :param ownership_verification_certificate_arn: The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager . This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
             :param security_policy: 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`` .
 
@@ -4193,6 +4234,7 @@ class CfnDomainName(
                     certificate_arn="certificateArn",
                     certificate_name="certificateName",
                     endpoint_type="endpointType",
+                    ip_address_type="ipAddressType",
                     ownership_verification_certificate_arn="ownershipVerificationCertificateArn",
                     security_policy="securityPolicy"
                 )
@@ -4202,6 +4244,7 @@ class CfnDomainName(
                 check_type(argname="argument certificate_arn", value=certificate_arn, expected_type=type_hints["certificate_arn"])
                 check_type(argname="argument certificate_name", value=certificate_name, expected_type=type_hints["certificate_name"])
                 check_type(argname="argument endpoint_type", value=endpoint_type, expected_type=type_hints["endpoint_type"])
+                check_type(argname="argument ip_address_type", value=ip_address_type, expected_type=type_hints["ip_address_type"])
                 check_type(argname="argument ownership_verification_certificate_arn", value=ownership_verification_certificate_arn, expected_type=type_hints["ownership_verification_certificate_arn"])
                 check_type(argname="argument security_policy", value=security_policy, expected_type=type_hints["security_policy"])
             self._values: typing.Dict[builtins.str, typing.Any] = {}
@@ -4211,6 +4254,8 @@ class CfnDomainName(
                 self._values["certificate_name"] = certificate_name
             if endpoint_type is not None:
                 self._values["endpoint_type"] = endpoint_type
+            if ip_address_type is not None:
+                self._values["ip_address_type"] = ip_address_type
             if ownership_verification_certificate_arn is not None:
                 self._values["ownership_verification_certificate_arn"] = ownership_verification_certificate_arn
             if security_policy is not None:
@@ -4245,6 +4290,17 @@ class CfnDomainName(
             result = self._values.get("endpoint_type")
             return typing.cast(typing.Optional[builtins.str], result)
 
+        @builtins.property
+        def ip_address_type(self) -> typing.Optional[builtins.str]:
+            '''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.
+
+            :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ipaddresstype
+            '''
+            result = self._values.get("ip_address_type")
+            return typing.cast(typing.Optional[builtins.str], result)
+
         @builtins.property
         def ownership_verification_certificate_arn(
             self,
@@ -4403,6 +4459,7 @@ class CfnDomainNameProps:
                     certificate_arn="certificateArn",
                     certificate_name="certificateName",
                     endpoint_type="endpointType",
+                    ip_address_type="ipAddressType",
                     ownership_verification_certificate_arn="ownershipVerificationCertificateArn",
                     security_policy="securityPolicy"
                 )],
@@ -10970,6 +11027,17 @@ class IHttpApi(IApi, typing_extensions.Protocol):
         '''
         ...
 
+    @builtins.property
+    @jsii.member(jsii_name="defaultStage")
+    def default_stage(self) -> typing.Optional["IHttpStage"]:
+        '''The default stage of this API.
+
+        :default: - a stage will be created
+
+        :attribute: true
+        '''
+        ...
+
     @jsii.member(jsii_name="addVpcLink")
     def add_vpc_link(
         self,
@@ -11241,6 +11309,17 @@ class _IHttpApiProxy(
         '''
         return typing.cast(typing.Optional["IHttpRouteAuthorizer"], jsii.get(self, "defaultAuthorizer"))
 
+    @builtins.property
+    @jsii.member(jsii_name="defaultStage")
+    def default_stage(self) -> typing.Optional["IHttpStage"]:
+        '''The default stage of this API.
+
+        :default: - a stage will be created
+
+        :attribute: true
+        '''
+        return typing.cast(typing.Optional["IHttpStage"], jsii.get(self, "defaultStage"))
+
     @jsii.member(jsii_name="addVpcLink")
     def add_vpc_link(
         self,
@@ -18812,6 +18891,7 @@ def _typecheckingstub__1db7633eb849c7234f54cf8f50ef6e4c6273ca1ab60db537f47e511e2
     disable_execute_api_endpoint: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
     disable_schema_validation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
     fail_on_warnings: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
+    ip_address_type: typing.Optional[builtins.str] = None,
     name: typing.Optional[builtins.str] = None,
     protocol_type: typing.Optional[builtins.str] = None,
     route_key: typing.Optional[builtins.str] = None,
@@ -18895,6 +18975,12 @@ def _typecheckingstub__2ce8eb7264be44ff3a6ae79c6be6a193c31eb617518209aeb51c346aa
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__2a1eb652a1c167ca6cb7d9b75ef226df1b04d95736668747822e7afa0766e2fd(
+    value: typing.Optional[builtins.str],
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__6de2f3d46e4a0275374cdfba39222daec1a50d7516f00756e898551462523fb6(
     value: typing.Optional[builtins.str],
 ) -> None:
@@ -19139,6 +19225,7 @@ def _typecheckingstub__de72efdeda792916a7e0a8d8953153208abe93b442ac8056802f749d4
     disable_execute_api_endpoint: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
     disable_schema_validation: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
     fail_on_warnings: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
+    ip_address_type: typing.Optional[builtins.str] = None,
     name: typing.Optional[builtins.str] = None,
     protocol_type: typing.Optional[builtins.str] = None,
     route_key: typing.Optional[builtins.str] = None,
@@ -19375,6 +19462,7 @@ def _typecheckingstub__faaf4905cea99e081f1f881fa68755b4ec1bc0ed8f4e145c30baf36d9
     certificate_arn: typing.Optional[builtins.str] = None,
     certificate_name: typing.Optional[builtins.str] = None,
     endpoint_type: typing.Optional[builtins.str] = None,
+    ip_address_type: typing.Optional[builtins.str] = None,
     ownership_verification_certificate_arn: typing.Optional[builtins.str] = None,
     security_policy: typing.Optional[builtins.str] = None,
 ) -> None: