aws-cdk-lib 2.187.0__py3-none-any.whl → 2.189.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 +24 -3
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.187.0.jsii.tgz → aws-cdk-lib@2.189.0.jsii.tgz} +0 -0
- aws_cdk/aws_amplify/__init__.py +21 -9
- aws_cdk/aws_apigateway/__init__.py +27 -19
- aws_cdk/aws_apigatewayv2/__init__.py +170 -0
- aws_cdk/aws_appconfig/__init__.py +30 -14
- aws_cdk/aws_arczonalshift/__init__.py +4 -4
- aws_cdk/aws_batch/__init__.py +2 -0
- aws_cdk/aws_bedrock/__init__.py +629 -32
- aws_cdk/aws_budgets/__init__.py +8 -8
- aws_cdk/aws_cassandra/__init__.py +3 -1
- aws_cdk/aws_ce/__init__.py +2 -2
- aws_cdk/aws_cloudformation/__init__.py +3 -3
- aws_cdk/aws_codebuild/__init__.py +23 -1
- aws_cdk/aws_codepipeline/__init__.py +47 -32
- aws_cdk/aws_codepipeline_actions/__init__.py +2786 -1042
- aws_cdk/aws_codestarnotifications/__init__.py +16 -16
- aws_cdk/aws_cognito/__init__.py +8 -2
- aws_cdk/aws_dsql/__init__.py +366 -0
- aws_cdk/aws_dynamodb/__init__.py +4 -4
- aws_cdk/aws_ec2/__init__.py +2130 -237
- aws_cdk/aws_eks/__init__.py +112 -10
- aws_cdk/aws_events_targets/__init__.py +136 -0
- aws_cdk/aws_fsx/__init__.py +2 -8
- aws_cdk/aws_gamelift/__init__.py +140 -14
- aws_cdk/aws_groundstation/__init__.py +4 -2
- aws_cdk/aws_iam/__init__.py +6 -4
- aws_cdk/aws_identitystore/__init__.py +15 -13
- aws_cdk/aws_kinesisfirehose/__init__.py +38 -0
- aws_cdk/aws_lambda_event_sources/__init__.py +22 -22
- aws_cdk/aws_lex/__init__.py +21 -17
- aws_cdk/aws_logs/__init__.py +18 -0
- aws_cdk/aws_logs_destinations/__init__.py +146 -0
- aws_cdk/aws_notifications/__init__.py +4 -4
- aws_cdk/aws_omics/__init__.py +9 -1
- aws_cdk/aws_opensearchserverless/__init__.py +31 -23
- aws_cdk/aws_organizations/__init__.py +1 -1
- aws_cdk/aws_paymentcryptography/__init__.py +6 -2
- aws_cdk/aws_pcaconnectorad/__init__.py +3 -2
- aws_cdk/aws_quicksight/__init__.py +35 -22
- aws_cdk/aws_rds/__init__.py +84 -0
- aws_cdk/aws_redshiftserverless/__init__.py +166 -0
- aws_cdk/aws_route53/__init__.py +3 -3
- aws_cdk/aws_route53recoverycontrol/__init__.py +4 -6
- aws_cdk/aws_rum/__init__.py +13 -10
- aws_cdk/aws_s3/__init__.py +3 -6
- aws_cdk/aws_sagemaker/__init__.py +41 -0
- aws_cdk/aws_ssmincidents/__init__.py +10 -10
- aws_cdk/aws_systemsmanagersap/__init__.py +17 -7
- aws_cdk/aws_transfer/__init__.py +19 -10
- aws_cdk/aws_wafv2/__init__.py +80 -35
- aws_cdk/cx_api/__init__.py +23 -2
- aws_cdk/pipelines/__init__.py +71 -1
- {aws_cdk_lib-2.187.0.dist-info → aws_cdk_lib-2.189.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.187.0.dist-info → aws_cdk_lib-2.189.0.dist-info}/RECORD +60 -59
- {aws_cdk_lib-2.187.0.dist-info → aws_cdk_lib-2.189.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.187.0.dist-info → aws_cdk_lib-2.189.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.187.0.dist-info → aws_cdk_lib-2.189.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.187.0.dist-info → aws_cdk_lib-2.189.0.dist-info}/top_level.txt +0 -0
aws_cdk/__init__.py
CHANGED
|
@@ -3879,6 +3879,7 @@ class CfnAutoScalingReplacingUpdate:
|
|
|
3879
3879
|
jsii_struct_bases=[],
|
|
3880
3880
|
name_mapping={
|
|
3881
3881
|
"max_batch_size": "maxBatchSize",
|
|
3882
|
+
"min_active_instances_percent": "minActiveInstancesPercent",
|
|
3882
3883
|
"min_instances_in_service": "minInstancesInService",
|
|
3883
3884
|
"min_successful_instances_percent": "minSuccessfulInstancesPercent",
|
|
3884
3885
|
"pause_time": "pauseTime",
|
|
@@ -3891,6 +3892,7 @@ class CfnAutoScalingRollingUpdate:
|
|
|
3891
3892
|
self,
|
|
3892
3893
|
*,
|
|
3893
3894
|
max_batch_size: typing.Optional[jsii.Number] = None,
|
|
3895
|
+
min_active_instances_percent: typing.Optional[jsii.Number] = None,
|
|
3894
3896
|
min_instances_in_service: typing.Optional[jsii.Number] = None,
|
|
3895
3897
|
min_successful_instances_percent: typing.Optional[jsii.Number] = None,
|
|
3896
3898
|
pause_time: typing.Optional[builtins.str] = None,
|
|
@@ -3903,6 +3905,7 @@ class CfnAutoScalingRollingUpdate:
|
|
|
3903
3905
|
group in batches or all at once.
|
|
3904
3906
|
|
|
3905
3907
|
:param max_batch_size: Specifies the maximum number of instances that AWS CloudFormation updates.
|
|
3908
|
+
:param min_active_instances_percent: Specifies the percentage of instances in an Auto Scaling group that must remain in service while AWS CloudFormation updates old instances. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum active percentage of 50, three instances must remain in service.
|
|
3906
3909
|
:param min_instances_in_service: Specifies the minimum number of instances that must be in service within the Auto Scaling group while AWS CloudFormation updates old instances.
|
|
3907
3910
|
:param min_successful_instances_percent: Specifies the percentage of instances in an Auto Scaling rolling update that must signal success for an update to succeed. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum successful percentage of 50, three instances must signal success. If an instance doesn't send a signal within the time specified in the PauseTime property, AWS CloudFormation assumes that the instance wasn't updated. If you specify this property, you must also enable the WaitOnResourceSignals and PauseTime properties.
|
|
3908
3911
|
:param pause_time: The amount of time that AWS CloudFormation pauses after making a change to a batch of instances to give those instances time to start software applications. For example, you might need to specify PauseTime when scaling up the number of instances in an Auto Scaling group. If you enable the WaitOnResourceSignals property, PauseTime is the amount of time that AWS CloudFormation should wait for the Auto Scaling group to receive the required number of valid signals from added or replaced instances. If the PauseTime is exceeded before the Auto Scaling group receives the required number of signals, the update fails. For best results, specify a time period that gives your applications sufficient time to get started. If the update needs to be rolled back, a short PauseTime can cause the rollback to fail. Specify PauseTime in the ISO8601 duration format (in the format PT#H#M#S, where each # is the number of hours, minutes, and seconds, respectively). The maximum PauseTime is one hour (PT1H).
|
|
@@ -3919,6 +3922,7 @@ class CfnAutoScalingRollingUpdate:
|
|
|
3919
3922
|
|
|
3920
3923
|
cfn_auto_scaling_rolling_update = cdk.CfnAutoScalingRollingUpdate(
|
|
3921
3924
|
max_batch_size=123,
|
|
3925
|
+
min_active_instances_percent=123,
|
|
3922
3926
|
min_instances_in_service=123,
|
|
3923
3927
|
min_successful_instances_percent=123,
|
|
3924
3928
|
pause_time="pauseTime",
|
|
@@ -3929,6 +3933,7 @@ class CfnAutoScalingRollingUpdate:
|
|
|
3929
3933
|
if __debug__:
|
|
3930
3934
|
type_hints = typing.get_type_hints(_typecheckingstub__085b6d44b1c6b74e8060adbd78e13b1a188913a88389f19dce989d64cd5d0b7b)
|
|
3931
3935
|
check_type(argname="argument max_batch_size", value=max_batch_size, expected_type=type_hints["max_batch_size"])
|
|
3936
|
+
check_type(argname="argument min_active_instances_percent", value=min_active_instances_percent, expected_type=type_hints["min_active_instances_percent"])
|
|
3932
3937
|
check_type(argname="argument min_instances_in_service", value=min_instances_in_service, expected_type=type_hints["min_instances_in_service"])
|
|
3933
3938
|
check_type(argname="argument min_successful_instances_percent", value=min_successful_instances_percent, expected_type=type_hints["min_successful_instances_percent"])
|
|
3934
3939
|
check_type(argname="argument pause_time", value=pause_time, expected_type=type_hints["pause_time"])
|
|
@@ -3937,6 +3942,8 @@ class CfnAutoScalingRollingUpdate:
|
|
|
3937
3942
|
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
3938
3943
|
if max_batch_size is not None:
|
|
3939
3944
|
self._values["max_batch_size"] = max_batch_size
|
|
3945
|
+
if min_active_instances_percent is not None:
|
|
3946
|
+
self._values["min_active_instances_percent"] = min_active_instances_percent
|
|
3940
3947
|
if min_instances_in_service is not None:
|
|
3941
3948
|
self._values["min_instances_in_service"] = min_instances_in_service
|
|
3942
3949
|
if min_successful_instances_percent is not None:
|
|
@@ -3954,6 +3961,16 @@ class CfnAutoScalingRollingUpdate:
|
|
|
3954
3961
|
result = self._values.get("max_batch_size")
|
|
3955
3962
|
return typing.cast(typing.Optional[jsii.Number], result)
|
|
3956
3963
|
|
|
3964
|
+
@builtins.property
|
|
3965
|
+
def min_active_instances_percent(self) -> typing.Optional[jsii.Number]:
|
|
3966
|
+
'''Specifies the percentage of instances in an Auto Scaling group that must remain in service while AWS CloudFormation updates old instances.
|
|
3967
|
+
|
|
3968
|
+
You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent.
|
|
3969
|
+
For example, if you update five instances with a minimum active percentage of 50, three instances must remain in service.
|
|
3970
|
+
'''
|
|
3971
|
+
result = self._values.get("min_active_instances_percent")
|
|
3972
|
+
return typing.cast(typing.Optional[jsii.Number], result)
|
|
3973
|
+
|
|
3957
3974
|
@builtins.property
|
|
3958
3975
|
def min_instances_in_service(self) -> typing.Optional[jsii.Number]:
|
|
3959
3976
|
'''Specifies the minimum number of instances that must be in service within the Auto Scaling group while AWS CloudFormation updates old instances.'''
|
|
@@ -10194,6 +10211,7 @@ class CfnUpdatePolicy:
|
|
|
10194
10211
|
),
|
|
10195
10212
|
auto_scaling_rolling_update=cdk.CfnAutoScalingRollingUpdate(
|
|
10196
10213
|
max_batch_size=123,
|
|
10214
|
+
min_active_instances_percent=123,
|
|
10197
10215
|
min_instances_in_service=123,
|
|
10198
10216
|
min_successful_instances_percent=123,
|
|
10199
10217
|
pause_time="pauseTime",
|
|
@@ -32659,7 +32677,7 @@ class CfnStack(CfnResource, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.CfnS
|
|
|
32659
32677
|
You must acknowledge IAM capabilities for nested stacks that contain IAM resources. Also, verify that you have cancel update stack permissions, which is required if an update rolls back. For more information about IAM and CloudFormation , see `Controlling access with AWS Identity and Access Management <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html>`_ in the *AWS CloudFormation User Guide* .
|
|
32660
32678
|
.. epigraph::
|
|
32661
32679
|
|
|
32662
|
-
A subset of ``AWS::CloudFormation::Stack`` resource type properties listed below are available to customers using CloudFormation , AWS CDK , and
|
|
32680
|
+
A subset of ``AWS::CloudFormation::Stack`` resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control to configure.
|
|
32663
32681
|
|
|
32664
32682
|
- ``NotificationARNs``
|
|
32665
32683
|
- ``Parameters``
|
|
@@ -32667,7 +32685,7 @@ class CfnStack(CfnResource, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.CfnS
|
|
|
32667
32685
|
- ``TemplateURL``
|
|
32668
32686
|
- ``TimeoutInMinutes``
|
|
32669
32687
|
|
|
32670
|
-
These properties can be configured only when using
|
|
32688
|
+
These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .
|
|
32671
32689
|
|
|
32672
32690
|
- ``Capabilities``
|
|
32673
32691
|
- ``Description``
|
|
@@ -32682,7 +32700,7 @@ class CfnStack(CfnResource, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.CfnS
|
|
|
32682
32700
|
|
|
32683
32701
|
Customers that configure ``AWS::CloudFormation::Stack`` using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.
|
|
32684
32702
|
|
|
32685
|
-
These read-only properties can be accessed only when using
|
|
32703
|
+
These read-only properties can be accessed only when using Cloud Control .
|
|
32686
32704
|
|
|
32687
32705
|
- ``ChangeSetId``
|
|
32688
32706
|
- ``CreationTime``
|
|
@@ -37300,6 +37318,7 @@ __all__ = [
|
|
|
37300
37318
|
"aws_dms",
|
|
37301
37319
|
"aws_docdb",
|
|
37302
37320
|
"aws_docdbelastic",
|
|
37321
|
+
"aws_dsql",
|
|
37303
37322
|
"aws_dynamodb",
|
|
37304
37323
|
"aws_ec2",
|
|
37305
37324
|
"aws_ecr",
|
|
@@ -37596,6 +37615,7 @@ from . import aws_dlm
|
|
|
37596
37615
|
from . import aws_dms
|
|
37597
37616
|
from . import aws_docdb
|
|
37598
37617
|
from . import aws_docdbelastic
|
|
37618
|
+
from . import aws_dsql
|
|
37599
37619
|
from . import aws_dynamodb
|
|
37600
37620
|
from . import aws_ec2
|
|
37601
37621
|
from . import aws_ecr
|
|
@@ -38082,6 +38102,7 @@ def _typecheckingstub__64a4624c19dc262f58fbe1c1e7fe44bc86dfef800d569565b2a5f863d
|
|
|
38082
38102
|
def _typecheckingstub__085b6d44b1c6b74e8060adbd78e13b1a188913a88389f19dce989d64cd5d0b7b(
|
|
38083
38103
|
*,
|
|
38084
38104
|
max_batch_size: typing.Optional[jsii.Number] = None,
|
|
38105
|
+
min_active_instances_percent: typing.Optional[jsii.Number] = None,
|
|
38085
38106
|
min_instances_in_service: typing.Optional[jsii.Number] = None,
|
|
38086
38107
|
min_successful_instances_percent: typing.Optional[jsii.Number] = None,
|
|
38087
38108
|
pause_time: typing.Optional[builtins.str] = None,
|
aws_cdk/_jsii/__init__.py
CHANGED
|
@@ -34,7 +34,7 @@ import aws_cdk.cloud_assembly_schema._jsii
|
|
|
34
34
|
import constructs._jsii
|
|
35
35
|
|
|
36
36
|
__jsii_assembly__ = jsii.JSIIAssembly.load(
|
|
37
|
-
"aws-cdk-lib", "2.
|
|
37
|
+
"aws-cdk-lib", "2.189.0", __name__[0:-6], "aws-cdk-lib@2.189.0.jsii.tgz"
|
|
38
38
|
)
|
|
39
39
|
|
|
40
40
|
__all__ = [
|
|
Binary file
|
aws_cdk/aws_amplify/__init__.py
CHANGED
|
@@ -187,7 +187,7 @@ class CfnApp(
|
|
|
187
187
|
:param basic_auth_config: The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format ``user:password`` .
|
|
188
188
|
:param build_spec: The build specification (build spec) for an Amplify app.
|
|
189
189
|
:param cache_config: The cache configuration for the Amplify app. If you don't specify the cache configuration ``type`` , Amplify uses the default ``AMPLIFY_MANAGED`` setting.
|
|
190
|
-
:param compute_role_arn:
|
|
190
|
+
:param compute_role_arn: The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see `Adding an SSR Compute role <https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html>`_ in the *Amplify User Guide* .
|
|
191
191
|
:param custom_headers: The custom HTTP headers for an Amplify app.
|
|
192
192
|
:param custom_rules: The custom rewrite and redirect rules for an Amplify app.
|
|
193
193
|
:param description: The description of the Amplify app.
|
|
@@ -398,6 +398,7 @@ class CfnApp(
|
|
|
398
398
|
@builtins.property
|
|
399
399
|
@jsii.member(jsii_name="computeRoleArn")
|
|
400
400
|
def compute_role_arn(self) -> typing.Optional[builtins.str]:
|
|
401
|
+
'''The Amazon Resource Name (ARN) of the IAM role for an SSR app.'''
|
|
401
402
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "computeRoleArn"))
|
|
402
403
|
|
|
403
404
|
@compute_role_arn.setter
|
|
@@ -1192,7 +1193,7 @@ class CfnAppProps:
|
|
|
1192
1193
|
:param basic_auth_config: The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format ``user:password`` .
|
|
1193
1194
|
:param build_spec: The build specification (build spec) for an Amplify app.
|
|
1194
1195
|
:param cache_config: The cache configuration for the Amplify app. If you don't specify the cache configuration ``type`` , Amplify uses the default ``AMPLIFY_MANAGED`` setting.
|
|
1195
|
-
:param compute_role_arn:
|
|
1196
|
+
:param compute_role_arn: The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see `Adding an SSR Compute role <https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html>`_ in the *Amplify User Guide* .
|
|
1196
1197
|
:param custom_headers: The custom HTTP headers for an Amplify app.
|
|
1197
1198
|
:param custom_rules: The custom rewrite and redirect rules for an Amplify app.
|
|
1198
1199
|
:param description: The description of the Amplify app.
|
|
@@ -1403,7 +1404,10 @@ class CfnAppProps:
|
|
|
1403
1404
|
|
|
1404
1405
|
@builtins.property
|
|
1405
1406
|
def compute_role_arn(self) -> typing.Optional[builtins.str]:
|
|
1406
|
-
'''
|
|
1407
|
+
'''The Amazon Resource Name (ARN) of the IAM role for an SSR app.
|
|
1408
|
+
|
|
1409
|
+
The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see `Adding an SSR Compute role <https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html>`_ in the *Amplify User Guide* .
|
|
1410
|
+
|
|
1407
1411
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-computerolearn
|
|
1408
1412
|
'''
|
|
1409
1413
|
result = self._values.get("compute_role_arn")
|
|
@@ -1615,12 +1619,12 @@ class CfnBranch(
|
|
|
1615
1619
|
:param backend: The backend for a ``Branch`` of an Amplify app. Use for a backend created from an AWS CloudFormation stack. This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
|
|
1616
1620
|
:param basic_auth_config: The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format ``user:password`` .
|
|
1617
1621
|
:param build_spec: The build specification (build spec) for the branch.
|
|
1618
|
-
:param compute_role_arn:
|
|
1622
|
+
:param compute_role_arn: The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see `Adding an SSR Compute role <https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html>`_ in the *Amplify User Guide* .
|
|
1619
1623
|
:param description: The description for the branch that is part of an Amplify app.
|
|
1620
1624
|
:param enable_auto_build: Enables auto building for the branch.
|
|
1621
1625
|
:param enable_performance_mode: Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
|
|
1622
1626
|
:param enable_pull_request_preview: Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the ``PullRequestEnvironmentName`` property. For more information, see `Web Previews <https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html>`_ in the *AWS Amplify Hosting User Guide* .
|
|
1623
|
-
:param enable_skew_protection:
|
|
1627
|
+
:param enable_skew_protection: Specifies whether the skew protection feature is enabled for the branch. Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see `Skew protection for Amplify deployments <https://docs.aws.amazon.com/amplify/latest/userguide/skew-protection.html>`_ in the *Amplify User Guide* .
|
|
1624
1628
|
:param environment_variables: The environment variables for the branch.
|
|
1625
1629
|
:param framework: The framework for the branch.
|
|
1626
1630
|
:param pull_request_environment_name: If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named ``prod`` , ``test`` , or ``dev`` that you initialized with the Amplify CLI and mapped to this branch. To enable pull request previews, set the ``EnablePullRequestPreview`` property to ``true`` . If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed. For more information about creating backend environments, see `Feature Branch Deployments and Team Workflows <https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html>`_ in the *AWS Amplify Hosting User Guide* .
|
|
@@ -1792,6 +1796,7 @@ class CfnBranch(
|
|
|
1792
1796
|
@builtins.property
|
|
1793
1797
|
@jsii.member(jsii_name="computeRoleArn")
|
|
1794
1798
|
def compute_role_arn(self) -> typing.Optional[builtins.str]:
|
|
1799
|
+
'''The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.'''
|
|
1795
1800
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "computeRoleArn"))
|
|
1796
1801
|
|
|
1797
1802
|
@compute_role_arn.setter
|
|
@@ -1873,6 +1878,7 @@ class CfnBranch(
|
|
|
1873
1878
|
def enable_skew_protection(
|
|
1874
1879
|
self,
|
|
1875
1880
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
1881
|
+
'''Specifies whether the skew protection feature is enabled for the branch.'''
|
|
1876
1882
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "enableSkewProtection"))
|
|
1877
1883
|
|
|
1878
1884
|
@enable_skew_protection.setter
|
|
@@ -2223,12 +2229,12 @@ class CfnBranchProps:
|
|
|
2223
2229
|
:param backend: The backend for a ``Branch`` of an Amplify app. Use for a backend created from an AWS CloudFormation stack. This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
|
|
2224
2230
|
:param basic_auth_config: The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format ``user:password`` .
|
|
2225
2231
|
:param build_spec: The build specification (build spec) for the branch.
|
|
2226
|
-
:param compute_role_arn:
|
|
2232
|
+
:param compute_role_arn: The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see `Adding an SSR Compute role <https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html>`_ in the *Amplify User Guide* .
|
|
2227
2233
|
:param description: The description for the branch that is part of an Amplify app.
|
|
2228
2234
|
:param enable_auto_build: Enables auto building for the branch.
|
|
2229
2235
|
:param enable_performance_mode: Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
|
|
2230
2236
|
:param enable_pull_request_preview: Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the ``PullRequestEnvironmentName`` property. For more information, see `Web Previews <https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html>`_ in the *AWS Amplify Hosting User Guide* .
|
|
2231
|
-
:param enable_skew_protection:
|
|
2237
|
+
:param enable_skew_protection: Specifies whether the skew protection feature is enabled for the branch. Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see `Skew protection for Amplify deployments <https://docs.aws.amazon.com/amplify/latest/userguide/skew-protection.html>`_ in the *Amplify User Guide* .
|
|
2232
2238
|
:param environment_variables: The environment variables for the branch.
|
|
2233
2239
|
:param framework: The framework for the branch.
|
|
2234
2240
|
:param pull_request_environment_name: If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named ``prod`` , ``test`` , or ``dev`` that you initialized with the Amplify CLI and mapped to this branch. To enable pull request previews, set the ``EnablePullRequestPreview`` property to ``true`` . If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed. For more information about creating backend environments, see `Feature Branch Deployments and Team Workflows <https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html>`_ in the *AWS Amplify Hosting User Guide* .
|
|
@@ -2387,7 +2393,10 @@ class CfnBranchProps:
|
|
|
2387
2393
|
|
|
2388
2394
|
@builtins.property
|
|
2389
2395
|
def compute_role_arn(self) -> typing.Optional[builtins.str]:
|
|
2390
|
-
'''
|
|
2396
|
+
'''The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.
|
|
2397
|
+
|
|
2398
|
+
The SSR Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see `Adding an SSR Compute role <https://docs.aws.amazon.com/amplify/latest/userguide/amplify-SSR-compute-role.html>`_ in the *Amplify User Guide* .
|
|
2399
|
+
|
|
2391
2400
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-computerolearn
|
|
2392
2401
|
'''
|
|
2393
2402
|
result = self._values.get("compute_role_arn")
|
|
@@ -2447,7 +2456,10 @@ class CfnBranchProps:
|
|
|
2447
2456
|
def enable_skew_protection(
|
|
2448
2457
|
self,
|
|
2449
2458
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
2450
|
-
'''
|
|
2459
|
+
'''Specifies whether the skew protection feature is enabled for the branch.
|
|
2460
|
+
|
|
2461
|
+
Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see `Skew protection for Amplify deployments <https://docs.aws.amazon.com/amplify/latest/userguide/skew-protection.html>`_ in the *Amplify User Guide* .
|
|
2462
|
+
|
|
2451
2463
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableskewprotection
|
|
2452
2464
|
'''
|
|
2453
2465
|
result = self._values.get("enable_skew_protection")
|
|
@@ -7693,6 +7693,8 @@ class CfnDomainName(
|
|
|
7693
7693
|
):
|
|
7694
7694
|
'''The ``AWS::ApiGateway::DomainName`` resource specifies a public custom domain name for your API in API Gateway.
|
|
7695
7695
|
|
|
7696
|
+
To create a custom domain name for private APIs, use `AWS::ApiGateway::DomainV2 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html>`_ .
|
|
7697
|
+
|
|
7696
7698
|
You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see `Set up Custom Domain Name for an API in API Gateway <https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html>`_ in the *API Gateway Developer Guide* .
|
|
7697
7699
|
|
|
7698
7700
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html
|
|
@@ -7745,7 +7747,7 @@ class CfnDomainName(
|
|
|
7745
7747
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
7746
7748
|
: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.
|
|
7747
7749
|
:param domain_name: The custom domain name as an API host name, for example, ``my-api.example.com`` .
|
|
7748
|
-
:param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
|
7750
|
+
:param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
|
|
7749
7751
|
: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.
|
|
7750
7752
|
: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.
|
|
7751
7753
|
: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.
|
|
@@ -7885,7 +7887,7 @@ class CfnDomainName(
|
|
|
7885
7887
|
def endpoint_configuration(
|
|
7886
7888
|
self,
|
|
7887
7889
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainName.EndpointConfigurationProperty"]]:
|
|
7888
|
-
'''The endpoint configuration of this DomainName showing the endpoint types of the domain name.'''
|
|
7890
|
+
'''The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.'''
|
|
7889
7891
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainName.EndpointConfigurationProperty"]], jsii.get(self, "endpointConfiguration"))
|
|
7890
7892
|
|
|
7891
7893
|
@endpoint_configuration.setter
|
|
@@ -7983,11 +7985,11 @@ class CfnDomainName(
|
|
|
7983
7985
|
ip_address_type: typing.Optional[builtins.str] = None,
|
|
7984
7986
|
types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
7985
7987
|
) -> None:
|
|
7986
|
-
'''The ``EndpointConfiguration`` property type specifies the endpoint types of an Amazon API Gateway domain name.
|
|
7988
|
+
'''The ``EndpointConfiguration`` property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.
|
|
7987
7989
|
|
|
7988
7990
|
``EndpointConfiguration`` is a property of the `AWS::ApiGateway::DomainName <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html>`_ resource.
|
|
7989
7991
|
|
|
7990
|
-
:param ip_address_type:
|
|
7992
|
+
: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.
|
|
7991
7993
|
: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`` .
|
|
7992
7994
|
|
|
7993
7995
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html
|
|
@@ -8016,7 +8018,10 @@ class CfnDomainName(
|
|
|
8016
8018
|
|
|
8017
8019
|
@builtins.property
|
|
8018
8020
|
def ip_address_type(self) -> typing.Optional[builtins.str]:
|
|
8019
|
-
'''
|
|
8021
|
+
'''The IP address types that can invoke this DomainName.
|
|
8022
|
+
|
|
8023
|
+
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.
|
|
8024
|
+
|
|
8020
8025
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-ipaddresstype
|
|
8021
8026
|
'''
|
|
8022
8027
|
result = self._values.get("ip_address_type")
|
|
@@ -8444,7 +8449,7 @@ class CfnDomainNameProps:
|
|
|
8444
8449
|
|
|
8445
8450
|
: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.
|
|
8446
8451
|
:param domain_name: The custom domain name as an API host name, for example, ``my-api.example.com`` .
|
|
8447
|
-
:param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
|
8452
|
+
:param endpoint_configuration: The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
|
|
8448
8453
|
: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.
|
|
8449
8454
|
: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.
|
|
8450
8455
|
: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.
|
|
@@ -8532,7 +8537,7 @@ class CfnDomainNameProps:
|
|
|
8532
8537
|
def endpoint_configuration(
|
|
8533
8538
|
self,
|
|
8534
8539
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDomainName.EndpointConfigurationProperty]]:
|
|
8535
|
-
'''The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
|
8540
|
+
'''The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
|
|
8536
8541
|
|
|
8537
8542
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration
|
|
8538
8543
|
'''
|
|
@@ -8662,7 +8667,7 @@ class CfnDomainNameV2(
|
|
|
8662
8667
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
8663
8668
|
: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.
|
|
8664
8669
|
:param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
|
|
8665
|
-
:param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8670
|
+
: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.
|
|
8666
8671
|
: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>`_ .
|
|
8667
8672
|
:param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
|
|
8668
8673
|
:param tags: The collection of tags. Each tag element is associated with a given resource.
|
|
@@ -8772,7 +8777,7 @@ class CfnDomainNameV2(
|
|
|
8772
8777
|
def endpoint_configuration(
|
|
8773
8778
|
self,
|
|
8774
8779
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainNameV2.EndpointConfigurationProperty"]]:
|
|
8775
|
-
'''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.'''
|
|
8780
|
+
'''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.'''
|
|
8776
8781
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDomainNameV2.EndpointConfigurationProperty"]], jsii.get(self, "endpointConfiguration"))
|
|
8777
8782
|
|
|
8778
8783
|
@endpoint_configuration.setter
|
|
@@ -8835,7 +8840,7 @@ class CfnDomainNameV2(
|
|
|
8835
8840
|
*,
|
|
8836
8841
|
types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
8837
8842
|
) -> None:
|
|
8838
|
-
'''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8843
|
+
'''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.
|
|
8839
8844
|
|
|
8840
8845
|
: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`` .
|
|
8841
8846
|
|
|
@@ -8909,7 +8914,7 @@ class CfnDomainNameV2Props:
|
|
|
8909
8914
|
|
|
8910
8915
|
: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.
|
|
8911
8916
|
:param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
|
|
8912
|
-
:param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8917
|
+
: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.
|
|
8913
8918
|
: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>`_ .
|
|
8914
8919
|
:param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
|
|
8915
8920
|
:param tags: The collection of tags. Each tag element is associated with a given resource.
|
|
@@ -8985,7 +8990,7 @@ class CfnDomainNameV2Props:
|
|
|
8985
8990
|
def endpoint_configuration(
|
|
8986
8991
|
self,
|
|
8987
8992
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDomainNameV2.EndpointConfigurationProperty]]:
|
|
8988
|
-
'''The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
|
|
8993
|
+
'''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.
|
|
8989
8994
|
|
|
8990
8995
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-endpointconfiguration
|
|
8991
8996
|
'''
|
|
@@ -11524,7 +11529,7 @@ class CfnRestApi(
|
|
|
11524
11529
|
:param clone_from: The ID of the RestApi that you want to clone from.
|
|
11525
11530
|
:param description: The description of the RestApi.
|
|
11526
11531
|
: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
|
|
11527
|
-
: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.
|
|
11532
|
+
: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.
|
|
11528
11533
|
: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`` .
|
|
11529
11534
|
: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.
|
|
11530
11535
|
: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.
|
|
@@ -11725,7 +11730,7 @@ class CfnRestApi(
|
|
|
11725
11730
|
def endpoint_configuration(
|
|
11726
11731
|
self,
|
|
11727
11732
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRestApi.EndpointConfigurationProperty"]]:
|
|
11728
|
-
'''A list of the endpoint types of the API.'''
|
|
11733
|
+
'''A list of the endpoint types and IP address types of the API.'''
|
|
11729
11734
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRestApi.EndpointConfigurationProperty"]], jsii.get(self, "endpointConfiguration"))
|
|
11730
11735
|
|
|
11731
11736
|
@endpoint_configuration.setter
|
|
@@ -11856,11 +11861,11 @@ class CfnRestApi(
|
|
|
11856
11861
|
types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
11857
11862
|
vpc_endpoint_ids: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
11858
11863
|
) -> None:
|
|
11859
|
-
'''The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API.
|
|
11864
|
+
'''The ``EndpointConfiguration`` property type specifies the endpoint types and IP address types of a REST API.
|
|
11860
11865
|
|
|
11861
11866
|
``EndpointConfiguration`` is a property of the `AWS::ApiGateway::RestApi <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html>`_ resource.
|
|
11862
11867
|
|
|
11863
|
-
:param ip_address_type:
|
|
11868
|
+
: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.
|
|
11864
11869
|
: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`` .
|
|
11865
11870
|
: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.
|
|
11866
11871
|
|
|
@@ -11894,7 +11899,10 @@ class CfnRestApi(
|
|
|
11894
11899
|
|
|
11895
11900
|
@builtins.property
|
|
11896
11901
|
def ip_address_type(self) -> typing.Optional[builtins.str]:
|
|
11897
|
-
'''
|
|
11902
|
+
'''The IP address types that can invoke an API (RestApi).
|
|
11903
|
+
|
|
11904
|
+
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.
|
|
11905
|
+
|
|
11898
11906
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype
|
|
11899
11907
|
'''
|
|
11900
11908
|
result = self._values.get("ip_address_type")
|
|
@@ -12095,7 +12103,7 @@ class CfnRestApiProps:
|
|
|
12095
12103
|
:param clone_from: The ID of the RestApi that you want to clone from.
|
|
12096
12104
|
:param description: The description of the RestApi.
|
|
12097
12105
|
: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
|
|
12098
|
-
: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.
|
|
12106
|
+
: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.
|
|
12099
12107
|
: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`` .
|
|
12100
12108
|
: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.
|
|
12101
12109
|
: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.
|
|
@@ -12276,7 +12284,7 @@ class CfnRestApiProps:
|
|
|
12276
12284
|
def endpoint_configuration(
|
|
12277
12285
|
self,
|
|
12278
12286
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnRestApi.EndpointConfigurationProperty]]:
|
|
12279
|
-
'''A list of the endpoint types of the API.
|
|
12287
|
+
'''A list of the endpoint types and IP address types of the API.
|
|
12280
12288
|
|
|
12281
12289
|
Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
|
|
12282
12290
|
|