aws-cdk-lib 2.181.1__py3-none-any.whl → 2.182.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +292 -8
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.181.1.jsii.tgz → aws-cdk-lib@2.182.0.jsii.tgz} +0 -0
- aws_cdk/assertions/__init__.py +59 -0
- aws_cdk/aws_apigateway/__init__.py +122 -66
- aws_cdk/aws_applicationautoscaling/__init__.py +4 -0
- aws_cdk/aws_appsync/__init__.py +30 -4
- aws_cdk/aws_autoscaling/__init__.py +409 -36
- aws_cdk/aws_batch/__init__.py +629 -11
- aws_cdk/aws_bedrock/__init__.py +204 -0
- aws_cdk/aws_certificatemanager/__init__.py +24 -0
- aws_cdk/aws_cloudformation/__init__.py +284 -2
- aws_cdk/aws_cloudfront/__init__.py +1 -0
- aws_cdk/aws_cloudtrail/__init__.py +4 -4
- aws_cdk/aws_datazone/__init__.py +82 -0
- aws_cdk/aws_ec2/__init__.py +32 -12
- aws_cdk/aws_ecr/__init__.py +10 -4
- aws_cdk/aws_ecs/__init__.py +58 -9
- aws_cdk/aws_eks/__init__.py +32 -3
- aws_cdk/aws_fsx/__init__.py +2 -0
- aws_cdk/aws_guardduty/__init__.py +38 -26
- aws_cdk/aws_iam/__init__.py +5 -2
- aws_cdk/aws_inspector/__init__.py +176 -0
- aws_cdk/aws_iotsitewise/__init__.py +2 -3
- aws_cdk/aws_kinesisfirehose/__init__.py +6 -0
- aws_cdk/aws_lambda/__init__.py +8 -0
- aws_cdk/aws_logs/__init__.py +2 -0
- aws_cdk/aws_mediapackagev2/__init__.py +22 -14
- aws_cdk/aws_opensearchservice/__init__.py +261 -1
- aws_cdk/aws_pcaconnectorad/__init__.py +30 -4
- aws_cdk/aws_pipes/__init__.py +6 -2
- aws_cdk/aws_quicksight/__init__.py +225 -451
- aws_cdk/aws_rds/__init__.py +50 -13
- aws_cdk/aws_s3/__init__.py +8 -0
- aws_cdk/aws_sagemaker/__init__.py +68 -13
- aws_cdk/aws_sns/__init__.py +76 -1
- aws_cdk/aws_vpclattice/__init__.py +144 -9
- aws_cdk/aws_wafv2/__init__.py +702 -0
- aws_cdk/aws_wisdom/__init__.py +3 -110
- aws_cdk/aws_workspacesthinclient/__init__.py +4 -4
- aws_cdk/aws_workspacesweb/__init__.py +179 -2
- aws_cdk/cloud_assembly_schema/__init__.py +224 -4
- aws_cdk/cx_api/__init__.py +2 -1
- {aws_cdk_lib-2.181.1.dist-info → aws_cdk_lib-2.182.0.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.181.1.dist-info → aws_cdk_lib-2.182.0.dist-info}/RECORD +49 -49
- {aws_cdk_lib-2.181.1.dist-info → aws_cdk_lib-2.182.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.181.1.dist-info → aws_cdk_lib-2.182.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.181.1.dist-info → aws_cdk_lib-2.182.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.181.1.dist-info → aws_cdk_lib-2.182.0.dist-info}/top_level.txt +0 -0
|
@@ -23589,6 +23589,7 @@ class RestApiBase(
|
|
|
23589
23589
|
description: typing.Optional[builtins.str] = None,
|
|
23590
23590
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
23591
23591
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
23592
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
23592
23593
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
23593
23594
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
23594
23595
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -23607,6 +23608,7 @@ class RestApiBase(
|
|
|
23607
23608
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
23608
23609
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
23609
23610
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
23611
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
23610
23612
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
23611
23613
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
23612
23614
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -23627,6 +23629,7 @@ class RestApiBase(
|
|
|
23627
23629
|
description=description,
|
|
23628
23630
|
disable_execute_api_endpoint=disable_execute_api_endpoint,
|
|
23629
23631
|
domain_name=domain_name,
|
|
23632
|
+
endpoint_configuration=endpoint_configuration,
|
|
23630
23633
|
endpoint_export_name=endpoint_export_name,
|
|
23631
23634
|
endpoint_types=endpoint_types,
|
|
23632
23635
|
fail_on_warnings=fail_on_warnings,
|
|
@@ -24361,6 +24364,7 @@ typing.cast(typing.Any, RestApiBase).__jsii_proxy_class__ = lambda : _RestApiBas
|
|
|
24361
24364
|
"description": "description",
|
|
24362
24365
|
"disable_execute_api_endpoint": "disableExecuteApiEndpoint",
|
|
24363
24366
|
"domain_name": "domainName",
|
|
24367
|
+
"endpoint_configuration": "endpointConfiguration",
|
|
24364
24368
|
"endpoint_export_name": "endpointExportName",
|
|
24365
24369
|
"endpoint_types": "endpointTypes",
|
|
24366
24370
|
"fail_on_warnings": "failOnWarnings",
|
|
@@ -24381,6 +24385,7 @@ class RestApiBaseProps:
|
|
|
24381
24385
|
description: typing.Optional[builtins.str] = None,
|
|
24382
24386
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
24383
24387
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24388
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24384
24389
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
24385
24390
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
24386
24391
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -24398,6 +24403,7 @@ class RestApiBaseProps:
|
|
|
24398
24403
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
24399
24404
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
24400
24405
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
24406
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
24401
24407
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
24402
24408
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
24403
24409
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -24415,6 +24421,7 @@ class RestApiBaseProps:
|
|
|
24415
24421
|
import aws_cdk as cdk
|
|
24416
24422
|
from aws_cdk import aws_apigateway as apigateway
|
|
24417
24423
|
from aws_cdk import aws_certificatemanager as certificatemanager
|
|
24424
|
+
from aws_cdk import aws_ec2 as ec2
|
|
24418
24425
|
from aws_cdk import aws_iam as iam
|
|
24419
24426
|
from aws_cdk import aws_s3 as s3
|
|
24420
24427
|
|
|
@@ -24423,6 +24430,7 @@ class RestApiBaseProps:
|
|
|
24423
24430
|
# bucket: s3.Bucket
|
|
24424
24431
|
# certificate: certificatemanager.Certificate
|
|
24425
24432
|
# policy_document: iam.PolicyDocument
|
|
24433
|
+
# vpc_endpoint: ec2.VpcEndpoint
|
|
24426
24434
|
|
|
24427
24435
|
rest_api_base_props = apigateway.RestApiBaseProps(
|
|
24428
24436
|
cloud_watch_role=False,
|
|
@@ -24480,6 +24488,12 @@ class RestApiBaseProps:
|
|
|
24480
24488
|
),
|
|
24481
24489
|
security_policy=apigateway.SecurityPolicy.TLS_1_0
|
|
24482
24490
|
),
|
|
24491
|
+
endpoint_configuration=apigateway.EndpointConfiguration(
|
|
24492
|
+
types=[apigateway.EndpointType.EDGE],
|
|
24493
|
+
|
|
24494
|
+
# the properties below are optional
|
|
24495
|
+
vpc_endpoints=[vpc_endpoint]
|
|
24496
|
+
),
|
|
24483
24497
|
endpoint_export_name="endpointExportName",
|
|
24484
24498
|
endpoint_types=[apigateway.EndpointType.EDGE],
|
|
24485
24499
|
fail_on_warnings=False,
|
|
@@ -24495,6 +24509,8 @@ class RestApiBaseProps:
|
|
|
24495
24509
|
deploy_options = StageOptions(**deploy_options)
|
|
24496
24510
|
if isinstance(domain_name, dict):
|
|
24497
24511
|
domain_name = DomainNameOptions(**domain_name)
|
|
24512
|
+
if isinstance(endpoint_configuration, dict):
|
|
24513
|
+
endpoint_configuration = EndpointConfiguration(**endpoint_configuration)
|
|
24498
24514
|
if __debug__:
|
|
24499
24515
|
type_hints = typing.get_type_hints(_typecheckingstub__f8db41d1cbb038cc89af89c87ca398274183966ac93d18298a50a87996e9aab5)
|
|
24500
24516
|
check_type(argname="argument cloud_watch_role", value=cloud_watch_role, expected_type=type_hints["cloud_watch_role"])
|
|
@@ -24504,6 +24520,7 @@ class RestApiBaseProps:
|
|
|
24504
24520
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
24505
24521
|
check_type(argname="argument disable_execute_api_endpoint", value=disable_execute_api_endpoint, expected_type=type_hints["disable_execute_api_endpoint"])
|
|
24506
24522
|
check_type(argname="argument domain_name", value=domain_name, expected_type=type_hints["domain_name"])
|
|
24523
|
+
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
24507
24524
|
check_type(argname="argument endpoint_export_name", value=endpoint_export_name, expected_type=type_hints["endpoint_export_name"])
|
|
24508
24525
|
check_type(argname="argument endpoint_types", value=endpoint_types, expected_type=type_hints["endpoint_types"])
|
|
24509
24526
|
check_type(argname="argument fail_on_warnings", value=fail_on_warnings, expected_type=type_hints["fail_on_warnings"])
|
|
@@ -24526,6 +24543,8 @@ class RestApiBaseProps:
|
|
|
24526
24543
|
self._values["disable_execute_api_endpoint"] = disable_execute_api_endpoint
|
|
24527
24544
|
if domain_name is not None:
|
|
24528
24545
|
self._values["domain_name"] = domain_name
|
|
24546
|
+
if endpoint_configuration is not None:
|
|
24547
|
+
self._values["endpoint_configuration"] = endpoint_configuration
|
|
24529
24548
|
if endpoint_export_name is not None:
|
|
24530
24549
|
self._values["endpoint_export_name"] = endpoint_export_name
|
|
24531
24550
|
if endpoint_types is not None:
|
|
@@ -24631,6 +24650,17 @@ class RestApiBaseProps:
|
|
|
24631
24650
|
result = self._values.get("domain_name")
|
|
24632
24651
|
return typing.cast(typing.Optional[DomainNameOptions], result)
|
|
24633
24652
|
|
|
24653
|
+
@builtins.property
|
|
24654
|
+
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
24655
|
+
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
24656
|
+
|
|
24657
|
+
:default: EndpointType.EDGE
|
|
24658
|
+
|
|
24659
|
+
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
24660
|
+
'''
|
|
24661
|
+
result = self._values.get("endpoint_configuration")
|
|
24662
|
+
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
24663
|
+
|
|
24634
24664
|
@builtins.property
|
|
24635
24665
|
def endpoint_export_name(self) -> typing.Optional[builtins.str]:
|
|
24636
24666
|
'''Export name for the CfnOutput containing the API endpoint.
|
|
@@ -24729,6 +24759,7 @@ class RestApiBaseProps:
|
|
|
24729
24759
|
"description": "description",
|
|
24730
24760
|
"disable_execute_api_endpoint": "disableExecuteApiEndpoint",
|
|
24731
24761
|
"domain_name": "domainName",
|
|
24762
|
+
"endpoint_configuration": "endpointConfiguration",
|
|
24732
24763
|
"endpoint_export_name": "endpointExportName",
|
|
24733
24764
|
"endpoint_types": "endpointTypes",
|
|
24734
24765
|
"fail_on_warnings": "failOnWarnings",
|
|
@@ -24739,7 +24770,6 @@ class RestApiBaseProps:
|
|
|
24739
24770
|
"api_key_source_type": "apiKeySourceType",
|
|
24740
24771
|
"binary_media_types": "binaryMediaTypes",
|
|
24741
24772
|
"clone_from": "cloneFrom",
|
|
24742
|
-
"endpoint_configuration": "endpointConfiguration",
|
|
24743
24773
|
"min_compression_size": "minCompressionSize",
|
|
24744
24774
|
"minimum_compression_size": "minimumCompressionSize",
|
|
24745
24775
|
},
|
|
@@ -24758,6 +24788,7 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24758
24788
|
description: typing.Optional[builtins.str] = None,
|
|
24759
24789
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
24760
24790
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24791
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24761
24792
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
24762
24793
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
24763
24794
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -24768,7 +24799,6 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24768
24799
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
24769
24800
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
24770
24801
|
clone_from: typing.Optional[IRestApi] = None,
|
|
24771
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24772
24802
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
24773
24803
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
24774
24804
|
) -> None:
|
|
@@ -24784,6 +24814,7 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24784
24814
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
24785
24815
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
24786
24816
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
24817
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
24787
24818
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
24788
24819
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
24789
24820
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -24794,7 +24825,6 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24794
24825
|
:param api_key_source_type: The source of the API key for metering requests according to a usage plan. Default: - Metering is disabled.
|
|
24795
24826
|
:param binary_media_types: The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream". Default: - RestApi supports only UTF-8-encoded text payloads.
|
|
24796
24827
|
:param clone_from: The ID of the API Gateway RestApi resource that you want to clone. Default: - None.
|
|
24797
|
-
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
24798
24828
|
:param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
24799
24829
|
:param minimum_compression_size: (deprecated) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
24800
24830
|
|
|
@@ -24834,6 +24864,7 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24834
24864
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
24835
24865
|
check_type(argname="argument disable_execute_api_endpoint", value=disable_execute_api_endpoint, expected_type=type_hints["disable_execute_api_endpoint"])
|
|
24836
24866
|
check_type(argname="argument domain_name", value=domain_name, expected_type=type_hints["domain_name"])
|
|
24867
|
+
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
24837
24868
|
check_type(argname="argument endpoint_export_name", value=endpoint_export_name, expected_type=type_hints["endpoint_export_name"])
|
|
24838
24869
|
check_type(argname="argument endpoint_types", value=endpoint_types, expected_type=type_hints["endpoint_types"])
|
|
24839
24870
|
check_type(argname="argument fail_on_warnings", value=fail_on_warnings, expected_type=type_hints["fail_on_warnings"])
|
|
@@ -24844,7 +24875,6 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24844
24875
|
check_type(argname="argument api_key_source_type", value=api_key_source_type, expected_type=type_hints["api_key_source_type"])
|
|
24845
24876
|
check_type(argname="argument binary_media_types", value=binary_media_types, expected_type=type_hints["binary_media_types"])
|
|
24846
24877
|
check_type(argname="argument clone_from", value=clone_from, expected_type=type_hints["clone_from"])
|
|
24847
|
-
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
24848
24878
|
check_type(argname="argument min_compression_size", value=min_compression_size, expected_type=type_hints["min_compression_size"])
|
|
24849
24879
|
check_type(argname="argument minimum_compression_size", value=minimum_compression_size, expected_type=type_hints["minimum_compression_size"])
|
|
24850
24880
|
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
@@ -24868,6 +24898,8 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24868
24898
|
self._values["disable_execute_api_endpoint"] = disable_execute_api_endpoint
|
|
24869
24899
|
if domain_name is not None:
|
|
24870
24900
|
self._values["domain_name"] = domain_name
|
|
24901
|
+
if endpoint_configuration is not None:
|
|
24902
|
+
self._values["endpoint_configuration"] = endpoint_configuration
|
|
24871
24903
|
if endpoint_export_name is not None:
|
|
24872
24904
|
self._values["endpoint_export_name"] = endpoint_export_name
|
|
24873
24905
|
if endpoint_types is not None:
|
|
@@ -24888,8 +24920,6 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
24888
24920
|
self._values["binary_media_types"] = binary_media_types
|
|
24889
24921
|
if clone_from is not None:
|
|
24890
24922
|
self._values["clone_from"] = clone_from
|
|
24891
|
-
if endpoint_configuration is not None:
|
|
24892
|
-
self._values["endpoint_configuration"] = endpoint_configuration
|
|
24893
24923
|
if min_compression_size is not None:
|
|
24894
24924
|
self._values["min_compression_size"] = min_compression_size
|
|
24895
24925
|
if minimum_compression_size is not None:
|
|
@@ -25014,6 +25044,17 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
25014
25044
|
result = self._values.get("domain_name")
|
|
25015
25045
|
return typing.cast(typing.Optional[DomainNameOptions], result)
|
|
25016
25046
|
|
|
25047
|
+
@builtins.property
|
|
25048
|
+
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
25049
|
+
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
25050
|
+
|
|
25051
|
+
:default: EndpointType.EDGE
|
|
25052
|
+
|
|
25053
|
+
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
25054
|
+
'''
|
|
25055
|
+
result = self._values.get("endpoint_configuration")
|
|
25056
|
+
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
25057
|
+
|
|
25017
25058
|
@builtins.property
|
|
25018
25059
|
def endpoint_export_name(self) -> typing.Optional[builtins.str]:
|
|
25019
25060
|
'''Export name for the CfnOutput containing the API endpoint.
|
|
@@ -25113,17 +25154,6 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
|
|
|
25113
25154
|
result = self._values.get("clone_from")
|
|
25114
25155
|
return typing.cast(typing.Optional[IRestApi], result)
|
|
25115
25156
|
|
|
25116
|
-
@builtins.property
|
|
25117
|
-
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
25118
|
-
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
25119
|
-
|
|
25120
|
-
:default: EndpointType.EDGE
|
|
25121
|
-
|
|
25122
|
-
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
25123
|
-
'''
|
|
25124
|
-
result = self._values.get("endpoint_configuration")
|
|
25125
|
-
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
25126
|
-
|
|
25127
25157
|
@builtins.property
|
|
25128
25158
|
def min_compression_size(self) -> typing.Optional[_Size_7b441c34]:
|
|
25129
25159
|
'''A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
|
|
@@ -25583,6 +25613,7 @@ class SpecRestApi(
|
|
|
25583
25613
|
description: typing.Optional[builtins.str] = None,
|
|
25584
25614
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
25585
25615
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25616
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25586
25617
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
25587
25618
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
25588
25619
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -25603,6 +25634,7 @@ class SpecRestApi(
|
|
|
25603
25634
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
25604
25635
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
25605
25636
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
25637
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
25606
25638
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
25607
25639
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
25608
25640
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -25625,6 +25657,7 @@ class SpecRestApi(
|
|
|
25625
25657
|
description=description,
|
|
25626
25658
|
disable_execute_api_endpoint=disable_execute_api_endpoint,
|
|
25627
25659
|
domain_name=domain_name,
|
|
25660
|
+
endpoint_configuration=endpoint_configuration,
|
|
25628
25661
|
endpoint_export_name=endpoint_export_name,
|
|
25629
25662
|
endpoint_types=endpoint_types,
|
|
25630
25663
|
fail_on_warnings=fail_on_warnings,
|
|
@@ -25690,6 +25723,7 @@ class SpecRestApi(
|
|
|
25690
25723
|
"description": "description",
|
|
25691
25724
|
"disable_execute_api_endpoint": "disableExecuteApiEndpoint",
|
|
25692
25725
|
"domain_name": "domainName",
|
|
25726
|
+
"endpoint_configuration": "endpointConfiguration",
|
|
25693
25727
|
"endpoint_export_name": "endpointExportName",
|
|
25694
25728
|
"endpoint_types": "endpointTypes",
|
|
25695
25729
|
"fail_on_warnings": "failOnWarnings",
|
|
@@ -25712,6 +25746,7 @@ class SpecRestApiProps(RestApiBaseProps):
|
|
|
25712
25746
|
description: typing.Optional[builtins.str] = None,
|
|
25713
25747
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
25714
25748
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25749
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
25715
25750
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
25716
25751
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
25717
25752
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -25731,6 +25766,7 @@ class SpecRestApiProps(RestApiBaseProps):
|
|
|
25731
25766
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
25732
25767
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
25733
25768
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
25769
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
25734
25770
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
25735
25771
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
25736
25772
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -25759,6 +25795,8 @@ class SpecRestApiProps(RestApiBaseProps):
|
|
|
25759
25795
|
deploy_options = StageOptions(**deploy_options)
|
|
25760
25796
|
if isinstance(domain_name, dict):
|
|
25761
25797
|
domain_name = DomainNameOptions(**domain_name)
|
|
25798
|
+
if isinstance(endpoint_configuration, dict):
|
|
25799
|
+
endpoint_configuration = EndpointConfiguration(**endpoint_configuration)
|
|
25762
25800
|
if __debug__:
|
|
25763
25801
|
type_hints = typing.get_type_hints(_typecheckingstub__4506705cb637aa3098ad358d76fa29dd7a218f7542020d2e9dbfe8182f9cc797)
|
|
25764
25802
|
check_type(argname="argument cloud_watch_role", value=cloud_watch_role, expected_type=type_hints["cloud_watch_role"])
|
|
@@ -25768,6 +25806,7 @@ class SpecRestApiProps(RestApiBaseProps):
|
|
|
25768
25806
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
25769
25807
|
check_type(argname="argument disable_execute_api_endpoint", value=disable_execute_api_endpoint, expected_type=type_hints["disable_execute_api_endpoint"])
|
|
25770
25808
|
check_type(argname="argument domain_name", value=domain_name, expected_type=type_hints["domain_name"])
|
|
25809
|
+
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
25771
25810
|
check_type(argname="argument endpoint_export_name", value=endpoint_export_name, expected_type=type_hints["endpoint_export_name"])
|
|
25772
25811
|
check_type(argname="argument endpoint_types", value=endpoint_types, expected_type=type_hints["endpoint_types"])
|
|
25773
25812
|
check_type(argname="argument fail_on_warnings", value=fail_on_warnings, expected_type=type_hints["fail_on_warnings"])
|
|
@@ -25794,6 +25833,8 @@ class SpecRestApiProps(RestApiBaseProps):
|
|
|
25794
25833
|
self._values["disable_execute_api_endpoint"] = disable_execute_api_endpoint
|
|
25795
25834
|
if domain_name is not None:
|
|
25796
25835
|
self._values["domain_name"] = domain_name
|
|
25836
|
+
if endpoint_configuration is not None:
|
|
25837
|
+
self._values["endpoint_configuration"] = endpoint_configuration
|
|
25797
25838
|
if endpoint_export_name is not None:
|
|
25798
25839
|
self._values["endpoint_export_name"] = endpoint_export_name
|
|
25799
25840
|
if endpoint_types is not None:
|
|
@@ -25901,6 +25942,17 @@ class SpecRestApiProps(RestApiBaseProps):
|
|
|
25901
25942
|
result = self._values.get("domain_name")
|
|
25902
25943
|
return typing.cast(typing.Optional[DomainNameOptions], result)
|
|
25903
25944
|
|
|
25945
|
+
@builtins.property
|
|
25946
|
+
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
25947
|
+
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
25948
|
+
|
|
25949
|
+
:default: EndpointType.EDGE
|
|
25950
|
+
|
|
25951
|
+
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
25952
|
+
'''
|
|
25953
|
+
result = self._values.get("endpoint_configuration")
|
|
25954
|
+
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
25955
|
+
|
|
25904
25956
|
@builtins.property
|
|
25905
25957
|
def endpoint_export_name(self) -> typing.Optional[builtins.str]:
|
|
25906
25958
|
'''Export name for the CfnOutput containing the API endpoint.
|
|
@@ -27901,6 +27953,7 @@ class StepFunctionsIntegration(
|
|
|
27901
27953
|
"description": "description",
|
|
27902
27954
|
"disable_execute_api_endpoint": "disableExecuteApiEndpoint",
|
|
27903
27955
|
"domain_name": "domainName",
|
|
27956
|
+
"endpoint_configuration": "endpointConfiguration",
|
|
27904
27957
|
"endpoint_export_name": "endpointExportName",
|
|
27905
27958
|
"endpoint_types": "endpointTypes",
|
|
27906
27959
|
"fail_on_warnings": "failOnWarnings",
|
|
@@ -27911,7 +27964,6 @@ class StepFunctionsIntegration(
|
|
|
27911
27964
|
"api_key_source_type": "apiKeySourceType",
|
|
27912
27965
|
"binary_media_types": "binaryMediaTypes",
|
|
27913
27966
|
"clone_from": "cloneFrom",
|
|
27914
|
-
"endpoint_configuration": "endpointConfiguration",
|
|
27915
27967
|
"min_compression_size": "minCompressionSize",
|
|
27916
27968
|
"minimum_compression_size": "minimumCompressionSize",
|
|
27917
27969
|
"state_machine": "stateMachine",
|
|
@@ -27938,6 +27990,7 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
27938
27990
|
description: typing.Optional[builtins.str] = None,
|
|
27939
27991
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
27940
27992
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
27993
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
27941
27994
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
27942
27995
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
27943
27996
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -27948,7 +28001,6 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
27948
28001
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
27949
28002
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
27950
28003
|
clone_from: typing.Optional[IRestApi] = None,
|
|
27951
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
27952
28004
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
27953
28005
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
27954
28006
|
state_machine: _IStateMachine_73e8d2b0,
|
|
@@ -27972,6 +28024,7 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
27972
28024
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
27973
28025
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
27974
28026
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
28027
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
27975
28028
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
27976
28029
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
27977
28030
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -27982,7 +28035,6 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
27982
28035
|
:param api_key_source_type: The source of the API key for metering requests according to a usage plan. Default: - Metering is disabled.
|
|
27983
28036
|
:param binary_media_types: The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream". Default: - RestApi supports only UTF-8-encoded text payloads.
|
|
27984
28037
|
:param clone_from: The ID of the API Gateway RestApi resource that you want to clone. Default: - None.
|
|
27985
|
-
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
27986
28038
|
:param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
27987
28039
|
:param minimum_compression_size: (deprecated) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
27988
28040
|
:param state_machine: The default State Machine that handles all requests from this API. This stateMachine will be used as a the default integration for all methods in this API, unless specified otherwise in ``addMethod``.
|
|
@@ -28030,6 +28082,7 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
28030
28082
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
28031
28083
|
check_type(argname="argument disable_execute_api_endpoint", value=disable_execute_api_endpoint, expected_type=type_hints["disable_execute_api_endpoint"])
|
|
28032
28084
|
check_type(argname="argument domain_name", value=domain_name, expected_type=type_hints["domain_name"])
|
|
28085
|
+
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
28033
28086
|
check_type(argname="argument endpoint_export_name", value=endpoint_export_name, expected_type=type_hints["endpoint_export_name"])
|
|
28034
28087
|
check_type(argname="argument endpoint_types", value=endpoint_types, expected_type=type_hints["endpoint_types"])
|
|
28035
28088
|
check_type(argname="argument fail_on_warnings", value=fail_on_warnings, expected_type=type_hints["fail_on_warnings"])
|
|
@@ -28040,7 +28093,6 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
28040
28093
|
check_type(argname="argument api_key_source_type", value=api_key_source_type, expected_type=type_hints["api_key_source_type"])
|
|
28041
28094
|
check_type(argname="argument binary_media_types", value=binary_media_types, expected_type=type_hints["binary_media_types"])
|
|
28042
28095
|
check_type(argname="argument clone_from", value=clone_from, expected_type=type_hints["clone_from"])
|
|
28043
|
-
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
28044
28096
|
check_type(argname="argument min_compression_size", value=min_compression_size, expected_type=type_hints["min_compression_size"])
|
|
28045
28097
|
check_type(argname="argument minimum_compression_size", value=minimum_compression_size, expected_type=type_hints["minimum_compression_size"])
|
|
28046
28098
|
check_type(argname="argument state_machine", value=state_machine, expected_type=type_hints["state_machine"])
|
|
@@ -28074,6 +28126,8 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
28074
28126
|
self._values["disable_execute_api_endpoint"] = disable_execute_api_endpoint
|
|
28075
28127
|
if domain_name is not None:
|
|
28076
28128
|
self._values["domain_name"] = domain_name
|
|
28129
|
+
if endpoint_configuration is not None:
|
|
28130
|
+
self._values["endpoint_configuration"] = endpoint_configuration
|
|
28077
28131
|
if endpoint_export_name is not None:
|
|
28078
28132
|
self._values["endpoint_export_name"] = endpoint_export_name
|
|
28079
28133
|
if endpoint_types is not None:
|
|
@@ -28094,8 +28148,6 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
28094
28148
|
self._values["binary_media_types"] = binary_media_types
|
|
28095
28149
|
if clone_from is not None:
|
|
28096
28150
|
self._values["clone_from"] = clone_from
|
|
28097
|
-
if endpoint_configuration is not None:
|
|
28098
|
-
self._values["endpoint_configuration"] = endpoint_configuration
|
|
28099
28151
|
if min_compression_size is not None:
|
|
28100
28152
|
self._values["min_compression_size"] = min_compression_size
|
|
28101
28153
|
if minimum_compression_size is not None:
|
|
@@ -28234,6 +28286,17 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
28234
28286
|
result = self._values.get("domain_name")
|
|
28235
28287
|
return typing.cast(typing.Optional[DomainNameOptions], result)
|
|
28236
28288
|
|
|
28289
|
+
@builtins.property
|
|
28290
|
+
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
28291
|
+
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
28292
|
+
|
|
28293
|
+
:default: EndpointType.EDGE
|
|
28294
|
+
|
|
28295
|
+
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
28296
|
+
'''
|
|
28297
|
+
result = self._values.get("endpoint_configuration")
|
|
28298
|
+
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
28299
|
+
|
|
28237
28300
|
@builtins.property
|
|
28238
28301
|
def endpoint_export_name(self) -> typing.Optional[builtins.str]:
|
|
28239
28302
|
'''Export name for the CfnOutput containing the API endpoint.
|
|
@@ -28333,17 +28396,6 @@ class StepFunctionsRestApiProps(RestApiProps):
|
|
|
28333
28396
|
result = self._values.get("clone_from")
|
|
28334
28397
|
return typing.cast(typing.Optional[IRestApi], result)
|
|
28335
28398
|
|
|
28336
|
-
@builtins.property
|
|
28337
|
-
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
28338
|
-
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
28339
|
-
|
|
28340
|
-
:default: EndpointType.EDGE
|
|
28341
|
-
|
|
28342
|
-
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
28343
|
-
'''
|
|
28344
|
-
result = self._values.get("endpoint_configuration")
|
|
28345
|
-
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
28346
|
-
|
|
28347
28399
|
@builtins.property
|
|
28348
28400
|
def min_compression_size(self) -> typing.Optional[_Size_7b441c34]:
|
|
28349
28401
|
'''A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
|
|
@@ -30639,6 +30691,7 @@ class LambdaIntegration(
|
|
|
30639
30691
|
"description": "description",
|
|
30640
30692
|
"disable_execute_api_endpoint": "disableExecuteApiEndpoint",
|
|
30641
30693
|
"domain_name": "domainName",
|
|
30694
|
+
"endpoint_configuration": "endpointConfiguration",
|
|
30642
30695
|
"endpoint_export_name": "endpointExportName",
|
|
30643
30696
|
"endpoint_types": "endpointTypes",
|
|
30644
30697
|
"fail_on_warnings": "failOnWarnings",
|
|
@@ -30649,7 +30702,6 @@ class LambdaIntegration(
|
|
|
30649
30702
|
"api_key_source_type": "apiKeySourceType",
|
|
30650
30703
|
"binary_media_types": "binaryMediaTypes",
|
|
30651
30704
|
"clone_from": "cloneFrom",
|
|
30652
|
-
"endpoint_configuration": "endpointConfiguration",
|
|
30653
30705
|
"min_compression_size": "minCompressionSize",
|
|
30654
30706
|
"minimum_compression_size": "minimumCompressionSize",
|
|
30655
30707
|
"handler": "handler",
|
|
@@ -30671,6 +30723,7 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30671
30723
|
description: typing.Optional[builtins.str] = None,
|
|
30672
30724
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
30673
30725
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
30726
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
30674
30727
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
30675
30728
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
30676
30729
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -30681,7 +30734,6 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30681
30734
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
30682
30735
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
30683
30736
|
clone_from: typing.Optional[IRestApi] = None,
|
|
30684
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
30685
30737
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
30686
30738
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
30687
30739
|
handler: _IFunction_6adb0ab8,
|
|
@@ -30699,6 +30751,7 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30699
30751
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
30700
30752
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
30701
30753
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
30754
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
30702
30755
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
30703
30756
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
30704
30757
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -30709,7 +30762,6 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30709
30762
|
:param api_key_source_type: The source of the API key for metering requests according to a usage plan. Default: - Metering is disabled.
|
|
30710
30763
|
:param binary_media_types: The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream". Default: - RestApi supports only UTF-8-encoded text payloads.
|
|
30711
30764
|
:param clone_from: The ID of the API Gateway RestApi resource that you want to clone. Default: - None.
|
|
30712
|
-
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
30713
30765
|
:param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
30714
30766
|
:param minimum_compression_size: (deprecated) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
30715
30767
|
:param handler: The default Lambda function that handles all requests from this API. This handler will be used as a the default integration for all methods in this API, unless specified otherwise in ``addMethod``.
|
|
@@ -30761,6 +30813,7 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30761
30813
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
30762
30814
|
check_type(argname="argument disable_execute_api_endpoint", value=disable_execute_api_endpoint, expected_type=type_hints["disable_execute_api_endpoint"])
|
|
30763
30815
|
check_type(argname="argument domain_name", value=domain_name, expected_type=type_hints["domain_name"])
|
|
30816
|
+
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
30764
30817
|
check_type(argname="argument endpoint_export_name", value=endpoint_export_name, expected_type=type_hints["endpoint_export_name"])
|
|
30765
30818
|
check_type(argname="argument endpoint_types", value=endpoint_types, expected_type=type_hints["endpoint_types"])
|
|
30766
30819
|
check_type(argname="argument fail_on_warnings", value=fail_on_warnings, expected_type=type_hints["fail_on_warnings"])
|
|
@@ -30771,7 +30824,6 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30771
30824
|
check_type(argname="argument api_key_source_type", value=api_key_source_type, expected_type=type_hints["api_key_source_type"])
|
|
30772
30825
|
check_type(argname="argument binary_media_types", value=binary_media_types, expected_type=type_hints["binary_media_types"])
|
|
30773
30826
|
check_type(argname="argument clone_from", value=clone_from, expected_type=type_hints["clone_from"])
|
|
30774
|
-
check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
|
|
30775
30827
|
check_type(argname="argument min_compression_size", value=min_compression_size, expected_type=type_hints["min_compression_size"])
|
|
30776
30828
|
check_type(argname="argument minimum_compression_size", value=minimum_compression_size, expected_type=type_hints["minimum_compression_size"])
|
|
30777
30829
|
check_type(argname="argument handler", value=handler, expected_type=type_hints["handler"])
|
|
@@ -30800,6 +30852,8 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30800
30852
|
self._values["disable_execute_api_endpoint"] = disable_execute_api_endpoint
|
|
30801
30853
|
if domain_name is not None:
|
|
30802
30854
|
self._values["domain_name"] = domain_name
|
|
30855
|
+
if endpoint_configuration is not None:
|
|
30856
|
+
self._values["endpoint_configuration"] = endpoint_configuration
|
|
30803
30857
|
if endpoint_export_name is not None:
|
|
30804
30858
|
self._values["endpoint_export_name"] = endpoint_export_name
|
|
30805
30859
|
if endpoint_types is not None:
|
|
@@ -30820,8 +30874,6 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30820
30874
|
self._values["binary_media_types"] = binary_media_types
|
|
30821
30875
|
if clone_from is not None:
|
|
30822
30876
|
self._values["clone_from"] = clone_from
|
|
30823
|
-
if endpoint_configuration is not None:
|
|
30824
|
-
self._values["endpoint_configuration"] = endpoint_configuration
|
|
30825
30877
|
if min_compression_size is not None:
|
|
30826
30878
|
self._values["min_compression_size"] = min_compression_size
|
|
30827
30879
|
if minimum_compression_size is not None:
|
|
@@ -30950,6 +31002,17 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
30950
31002
|
result = self._values.get("domain_name")
|
|
30951
31003
|
return typing.cast(typing.Optional[DomainNameOptions], result)
|
|
30952
31004
|
|
|
31005
|
+
@builtins.property
|
|
31006
|
+
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
31007
|
+
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
31008
|
+
|
|
31009
|
+
:default: EndpointType.EDGE
|
|
31010
|
+
|
|
31011
|
+
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
31012
|
+
'''
|
|
31013
|
+
result = self._values.get("endpoint_configuration")
|
|
31014
|
+
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
31015
|
+
|
|
30953
31016
|
@builtins.property
|
|
30954
31017
|
def endpoint_export_name(self) -> typing.Optional[builtins.str]:
|
|
30955
31018
|
'''Export name for the CfnOutput containing the API endpoint.
|
|
@@ -31049,17 +31112,6 @@ class LambdaRestApiProps(RestApiProps):
|
|
|
31049
31112
|
result = self._values.get("clone_from")
|
|
31050
31113
|
return typing.cast(typing.Optional[IRestApi], result)
|
|
31051
31114
|
|
|
31052
|
-
@builtins.property
|
|
31053
|
-
def endpoint_configuration(self) -> typing.Optional[EndpointConfiguration]:
|
|
31054
|
-
'''The EndpointConfiguration property type specifies the endpoint types of a REST API.
|
|
31055
|
-
|
|
31056
|
-
:default: EndpointType.EDGE
|
|
31057
|
-
|
|
31058
|
-
:see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
|
|
31059
|
-
'''
|
|
31060
|
-
result = self._values.get("endpoint_configuration")
|
|
31061
|
-
return typing.cast(typing.Optional[EndpointConfiguration], result)
|
|
31062
|
-
|
|
31063
31115
|
@builtins.property
|
|
31064
31116
|
def min_compression_size(self) -> typing.Optional[_Size_7b441c34]:
|
|
31065
31117
|
'''A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
|
|
@@ -32007,7 +32059,6 @@ class RestApi(
|
|
|
32007
32059
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
32008
32060
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
32009
32061
|
clone_from: typing.Optional[IRestApi] = None,
|
|
32010
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32011
32062
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
32012
32063
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
32013
32064
|
default_cors_preflight_options: typing.Optional[typing.Union[CorsOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -32020,6 +32071,7 @@ class RestApi(
|
|
|
32020
32071
|
description: typing.Optional[builtins.str] = None,
|
|
32021
32072
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
32022
32073
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32074
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32023
32075
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
32024
32076
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
32025
32077
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -32034,7 +32086,6 @@ class RestApi(
|
|
|
32034
32086
|
:param api_key_source_type: The source of the API key for metering requests according to a usage plan. Default: - Metering is disabled.
|
|
32035
32087
|
:param binary_media_types: The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream". Default: - RestApi supports only UTF-8-encoded text payloads.
|
|
32036
32088
|
:param clone_from: The ID of the API Gateway RestApi resource that you want to clone. Default: - None.
|
|
32037
|
-
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
32038
32089
|
:param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
32039
32090
|
:param minimum_compression_size: (deprecated) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
32040
32091
|
:param default_cors_preflight_options: Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using ``addCorsPreflight``. Default: - CORS is disabled
|
|
@@ -32047,6 +32098,7 @@ class RestApi(
|
|
|
32047
32098
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
32048
32099
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
32049
32100
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
32101
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
32050
32102
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
32051
32103
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
32052
32104
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -32063,7 +32115,6 @@ class RestApi(
|
|
|
32063
32115
|
api_key_source_type=api_key_source_type,
|
|
32064
32116
|
binary_media_types=binary_media_types,
|
|
32065
32117
|
clone_from=clone_from,
|
|
32066
|
-
endpoint_configuration=endpoint_configuration,
|
|
32067
32118
|
min_compression_size=min_compression_size,
|
|
32068
32119
|
minimum_compression_size=minimum_compression_size,
|
|
32069
32120
|
default_cors_preflight_options=default_cors_preflight_options,
|
|
@@ -32076,6 +32127,7 @@ class RestApi(
|
|
|
32076
32127
|
description=description,
|
|
32077
32128
|
disable_execute_api_endpoint=disable_execute_api_endpoint,
|
|
32078
32129
|
domain_name=domain_name,
|
|
32130
|
+
endpoint_configuration=endpoint_configuration,
|
|
32079
32131
|
endpoint_export_name=endpoint_export_name,
|
|
32080
32132
|
endpoint_types=endpoint_types,
|
|
32081
32133
|
fail_on_warnings=fail_on_warnings,
|
|
@@ -32525,7 +32577,6 @@ class StepFunctionsRestApi(
|
|
|
32525
32577
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
32526
32578
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
32527
32579
|
clone_from: typing.Optional[IRestApi] = None,
|
|
32528
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32529
32580
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
32530
32581
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
32531
32582
|
default_cors_preflight_options: typing.Optional[typing.Union[CorsOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -32538,6 +32589,7 @@ class StepFunctionsRestApi(
|
|
|
32538
32589
|
description: typing.Optional[builtins.str] = None,
|
|
32539
32590
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
32540
32591
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32592
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32541
32593
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
32542
32594
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
32543
32595
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -32560,7 +32612,6 @@ class StepFunctionsRestApi(
|
|
|
32560
32612
|
:param api_key_source_type: The source of the API key for metering requests according to a usage plan. Default: - Metering is disabled.
|
|
32561
32613
|
:param binary_media_types: The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream". Default: - RestApi supports only UTF-8-encoded text payloads.
|
|
32562
32614
|
:param clone_from: The ID of the API Gateway RestApi resource that you want to clone. Default: - None.
|
|
32563
|
-
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
32564
32615
|
:param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
32565
32616
|
:param minimum_compression_size: (deprecated) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
32566
32617
|
:param default_cors_preflight_options: Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using ``addCorsPreflight``. Default: - CORS is disabled
|
|
@@ -32573,6 +32624,7 @@ class StepFunctionsRestApi(
|
|
|
32573
32624
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
32574
32625
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
32575
32626
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
32627
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
32576
32628
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
32577
32629
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
32578
32630
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -32597,7 +32649,6 @@ class StepFunctionsRestApi(
|
|
|
32597
32649
|
api_key_source_type=api_key_source_type,
|
|
32598
32650
|
binary_media_types=binary_media_types,
|
|
32599
32651
|
clone_from=clone_from,
|
|
32600
|
-
endpoint_configuration=endpoint_configuration,
|
|
32601
32652
|
min_compression_size=min_compression_size,
|
|
32602
32653
|
minimum_compression_size=minimum_compression_size,
|
|
32603
32654
|
default_cors_preflight_options=default_cors_preflight_options,
|
|
@@ -32610,6 +32661,7 @@ class StepFunctionsRestApi(
|
|
|
32610
32661
|
description=description,
|
|
32611
32662
|
disable_execute_api_endpoint=disable_execute_api_endpoint,
|
|
32612
32663
|
domain_name=domain_name,
|
|
32664
|
+
endpoint_configuration=endpoint_configuration,
|
|
32613
32665
|
endpoint_export_name=endpoint_export_name,
|
|
32614
32666
|
endpoint_types=endpoint_types,
|
|
32615
32667
|
fail_on_warnings=fail_on_warnings,
|
|
@@ -32786,7 +32838,6 @@ class LambdaRestApi(
|
|
|
32786
32838
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
32787
32839
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
32788
32840
|
clone_from: typing.Optional[IRestApi] = None,
|
|
32789
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32790
32841
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
32791
32842
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
32792
32843
|
default_cors_preflight_options: typing.Optional[typing.Union[CorsOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -32799,6 +32850,7 @@ class LambdaRestApi(
|
|
|
32799
32850
|
description: typing.Optional[builtins.str] = None,
|
|
32800
32851
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
32801
32852
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32853
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
32802
32854
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
32803
32855
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
32804
32856
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -32816,7 +32868,6 @@ class LambdaRestApi(
|
|
|
32816
32868
|
:param api_key_source_type: The source of the API key for metering requests according to a usage plan. Default: - Metering is disabled.
|
|
32817
32869
|
:param binary_media_types: The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream". Default: - RestApi supports only UTF-8-encoded text payloads.
|
|
32818
32870
|
:param clone_from: The ID of the API Gateway RestApi resource that you want to clone. Default: - None.
|
|
32819
|
-
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
32820
32871
|
:param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
32821
32872
|
:param minimum_compression_size: (deprecated) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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. Default: - Compression is disabled.
|
|
32822
32873
|
:param default_cors_preflight_options: Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using ``addCorsPreflight``. Default: - CORS is disabled
|
|
@@ -32829,6 +32880,7 @@ class LambdaRestApi(
|
|
|
32829
32880
|
:param description: A description of the RestApi construct. Default: - 'Automatically created by the RestApi construct'
|
|
32830
32881
|
:param disable_execute_api_endpoint: Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. Default: false
|
|
32831
32882
|
:param domain_name: Configure a custom domain name and map it to this API. Default: - no domain name is defined, use ``addDomainName`` or directly define a ``DomainName``.
|
|
32883
|
+
:param endpoint_configuration: The EndpointConfiguration property type specifies the endpoint types of a REST API. Default: EndpointType.EDGE
|
|
32832
32884
|
:param endpoint_export_name: Export name for the CfnOutput containing the API endpoint. Default: - when no export name is given, output will be created without export
|
|
32833
32885
|
:param endpoint_types: A list of the endpoint types of the API. Use this property when creating an API. Default: EndpointType.EDGE
|
|
32834
32886
|
:param fail_on_warnings: Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. Default: false
|
|
@@ -32848,7 +32900,6 @@ class LambdaRestApi(
|
|
|
32848
32900
|
api_key_source_type=api_key_source_type,
|
|
32849
32901
|
binary_media_types=binary_media_types,
|
|
32850
32902
|
clone_from=clone_from,
|
|
32851
|
-
endpoint_configuration=endpoint_configuration,
|
|
32852
32903
|
min_compression_size=min_compression_size,
|
|
32853
32904
|
minimum_compression_size=minimum_compression_size,
|
|
32854
32905
|
default_cors_preflight_options=default_cors_preflight_options,
|
|
@@ -32861,6 +32912,7 @@ class LambdaRestApi(
|
|
|
32861
32912
|
description=description,
|
|
32862
32913
|
disable_execute_api_endpoint=disable_execute_api_endpoint,
|
|
32863
32914
|
domain_name=domain_name,
|
|
32915
|
+
endpoint_configuration=endpoint_configuration,
|
|
32864
32916
|
endpoint_export_name=endpoint_export_name,
|
|
32865
32917
|
endpoint_types=endpoint_types,
|
|
32866
32918
|
fail_on_warnings=fail_on_warnings,
|
|
@@ -36089,6 +36141,7 @@ def _typecheckingstub__cab2ea56ffb268ab13c508da12aeaa9c6b545e7c3f37a170d09ef138f
|
|
|
36089
36141
|
description: typing.Optional[builtins.str] = None,
|
|
36090
36142
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
36091
36143
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36144
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36092
36145
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
36093
36146
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
36094
36147
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -36219,6 +36272,7 @@ def _typecheckingstub__f8db41d1cbb038cc89af89c87ca398274183966ac93d18298a50a8799
|
|
|
36219
36272
|
description: typing.Optional[builtins.str] = None,
|
|
36220
36273
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
36221
36274
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36275
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36222
36276
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
36223
36277
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
36224
36278
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -36242,6 +36296,7 @@ def _typecheckingstub__edb4c50a5394bb1e1b27cdf2e1b593a161a3d26d31adcd03f57d290d6
|
|
|
36242
36296
|
description: typing.Optional[builtins.str] = None,
|
|
36243
36297
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
36244
36298
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36299
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36245
36300
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
36246
36301
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
36247
36302
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -36252,7 +36307,6 @@ def _typecheckingstub__edb4c50a5394bb1e1b27cdf2e1b593a161a3d26d31adcd03f57d290d6
|
|
|
36252
36307
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
36253
36308
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
36254
36309
|
clone_from: typing.Optional[IRestApi] = None,
|
|
36255
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36256
36310
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
36257
36311
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
36258
36312
|
) -> None:
|
|
@@ -36304,6 +36358,7 @@ def _typecheckingstub__4722b635be09e87466169ef31b6610061f0fa16d1cff99382f0584fde
|
|
|
36304
36358
|
description: typing.Optional[builtins.str] = None,
|
|
36305
36359
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
36306
36360
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36361
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36307
36362
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
36308
36363
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
36309
36364
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -36330,6 +36385,7 @@ def _typecheckingstub__4506705cb637aa3098ad358d76fa29dd7a218f7542020d2e9dbfe8182
|
|
|
36330
36385
|
description: typing.Optional[builtins.str] = None,
|
|
36331
36386
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
36332
36387
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36388
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36333
36389
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
36334
36390
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
36335
36391
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -36511,6 +36567,7 @@ def _typecheckingstub__7ea75392d4f0b942659ba0c4985da0e39fb4b27fe67d648c8b71b2efe
|
|
|
36511
36567
|
description: typing.Optional[builtins.str] = None,
|
|
36512
36568
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
36513
36569
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36570
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36514
36571
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
36515
36572
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
36516
36573
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -36521,7 +36578,6 @@ def _typecheckingstub__7ea75392d4f0b942659ba0c4985da0e39fb4b27fe67d648c8b71b2efe
|
|
|
36521
36578
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
36522
36579
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
36523
36580
|
clone_from: typing.Optional[IRestApi] = None,
|
|
36524
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36525
36581
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
36526
36582
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
36527
36583
|
state_machine: _IStateMachine_73e8d2b0,
|
|
@@ -36875,6 +36931,7 @@ def _typecheckingstub__a7bb3ee97313e20338b42cc6e9cf80c86b22fd22b98efa62b4243d578
|
|
|
36875
36931
|
description: typing.Optional[builtins.str] = None,
|
|
36876
36932
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
36877
36933
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36934
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36878
36935
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
36879
36936
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
36880
36937
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -36885,7 +36942,6 @@ def _typecheckingstub__a7bb3ee97313e20338b42cc6e9cf80c86b22fd22b98efa62b4243d578
|
|
|
36885
36942
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
36886
36943
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
36887
36944
|
clone_from: typing.Optional[IRestApi] = None,
|
|
36888
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36889
36945
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
36890
36946
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
36891
36947
|
handler: _IFunction_6adb0ab8,
|
|
@@ -36986,7 +37042,6 @@ def _typecheckingstub__03c7bedeb96f802134d573bf77dcec6f582d1d55c65ab809481df36f0
|
|
|
36986
37042
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
36987
37043
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
36988
37044
|
clone_from: typing.Optional[IRestApi] = None,
|
|
36989
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
36990
37045
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
36991
37046
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
36992
37047
|
default_cors_preflight_options: typing.Optional[typing.Union[CorsOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -36999,6 +37054,7 @@ def _typecheckingstub__03c7bedeb96f802134d573bf77dcec6f582d1d55c65ab809481df36f0
|
|
|
36999
37054
|
description: typing.Optional[builtins.str] = None,
|
|
37000
37055
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
37001
37056
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37057
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37002
37058
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
37003
37059
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
37004
37060
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -37140,7 +37196,6 @@ def _typecheckingstub__64b7d6f5079fb7e19afa5aac36a722a6cffb78f9dce681e4dcafb5a54
|
|
|
37140
37196
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
37141
37197
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
37142
37198
|
clone_from: typing.Optional[IRestApi] = None,
|
|
37143
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37144
37199
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
37145
37200
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
37146
37201
|
default_cors_preflight_options: typing.Optional[typing.Union[CorsOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -37153,6 +37208,7 @@ def _typecheckingstub__64b7d6f5079fb7e19afa5aac36a722a6cffb78f9dce681e4dcafb5a54
|
|
|
37153
37208
|
description: typing.Optional[builtins.str] = None,
|
|
37154
37209
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
37155
37210
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37211
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37156
37212
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
37157
37213
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
37158
37214
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|
|
@@ -37194,7 +37250,6 @@ def _typecheckingstub__d5f9d6fc9ab6dabb33b90fdf6d8c19556ef01f9f73f929196ff7c0078
|
|
|
37194
37250
|
api_key_source_type: typing.Optional[ApiKeySourceType] = None,
|
|
37195
37251
|
binary_media_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
37196
37252
|
clone_from: typing.Optional[IRestApi] = None,
|
|
37197
|
-
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37198
37253
|
min_compression_size: typing.Optional[_Size_7b441c34] = None,
|
|
37199
37254
|
minimum_compression_size: typing.Optional[jsii.Number] = None,
|
|
37200
37255
|
default_cors_preflight_options: typing.Optional[typing.Union[CorsOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -37207,6 +37262,7 @@ def _typecheckingstub__d5f9d6fc9ab6dabb33b90fdf6d8c19556ef01f9f73f929196ff7c0078
|
|
|
37207
37262
|
description: typing.Optional[builtins.str] = None,
|
|
37208
37263
|
disable_execute_api_endpoint: typing.Optional[builtins.bool] = None,
|
|
37209
37264
|
domain_name: typing.Optional[typing.Union[DomainNameOptions, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37265
|
+
endpoint_configuration: typing.Optional[typing.Union[EndpointConfiguration, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
37210
37266
|
endpoint_export_name: typing.Optional[builtins.str] = None,
|
|
37211
37267
|
endpoint_types: typing.Optional[typing.Sequence[EndpointType]] = None,
|
|
37212
37268
|
fail_on_warnings: typing.Optional[builtins.bool] = None,
|