aws-cdk-lib 2.186.0__py3-none-any.whl → 2.187.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.

Files changed (62) hide show
  1. aws_cdk/__init__.py +281 -116
  2. aws_cdk/_jsii/__init__.py +1 -1
  3. aws_cdk/_jsii/{aws-cdk-lib@2.186.0.jsii.tgz → aws-cdk-lib@2.187.0.jsii.tgz} +0 -0
  4. aws_cdk/aws_amplify/__init__.py +124 -0
  5. aws_cdk/aws_apigateway/__init__.py +48 -2
  6. aws_cdk/aws_appsync/__init__.py +14 -5
  7. aws_cdk/aws_bedrock/__init__.py +32 -22
  8. aws_cdk/aws_cassandra/__init__.py +2 -2
  9. aws_cdk/aws_cloudfront/__init__.py +11 -0
  10. aws_cdk/aws_cloudtrail/__init__.py +4 -18
  11. aws_cdk/aws_cloudwatch/__init__.py +50 -50
  12. aws_cdk/aws_codebuild/__init__.py +9 -0
  13. aws_cdk/aws_config/__init__.py +2 -5
  14. aws_cdk/aws_datazone/__init__.py +287 -226
  15. aws_cdk/aws_detective/__init__.py +3 -3
  16. aws_cdk/aws_dynamodb/__init__.py +37 -0
  17. aws_cdk/aws_ec2/__init__.py +154 -12
  18. aws_cdk/aws_ecr/__init__.py +143 -0
  19. aws_cdk/aws_ecr_assets/__init__.py +115 -4
  20. aws_cdk/aws_ecs/__init__.py +51 -0
  21. aws_cdk/aws_eks/__init__.py +114 -0
  22. aws_cdk/aws_events/__init__.py +8 -11
  23. aws_cdk/aws_forecast/__init__.py +1 -1
  24. aws_cdk/aws_fsx/__init__.py +2 -2
  25. aws_cdk/aws_gamelift/__init__.py +6 -6
  26. aws_cdk/aws_identitystore/__init__.py +16 -16
  27. aws_cdk/aws_iotsitewise/__init__.py +623 -0
  28. aws_cdk/aws_kms/__init__.py +10 -11
  29. aws_cdk/aws_lakeformation/__init__.py +3 -3
  30. aws_cdk/aws_lambda/__init__.py +105 -4
  31. aws_cdk/aws_lambda_event_sources/__init__.py +65 -3
  32. aws_cdk/aws_lambda_nodejs/__init__.py +5 -24
  33. aws_cdk/aws_lex/__init__.py +981 -5
  34. aws_cdk/aws_mediaconnect/__init__.py +714 -290
  35. aws_cdk/aws_mwaa/__init__.py +9 -9
  36. aws_cdk/aws_networkfirewall/__init__.py +44 -0
  37. aws_cdk/aws_omics/__init__.py +216 -0
  38. aws_cdk/aws_quicksight/__init__.py +244 -39
  39. aws_cdk/aws_rds/__init__.py +102 -10
  40. aws_cdk/aws_route53/__init__.py +2 -2
  41. aws_cdk/aws_route53recoverycontrol/__init__.py +43 -2
  42. aws_cdk/aws_s3_assets/__init__.py +70 -1
  43. aws_cdk/aws_s3_deployment/__init__.py +4 -0
  44. aws_cdk/aws_sagemaker/__init__.py +6 -4
  45. aws_cdk/aws_scheduler_targets/__init__.py +4 -16
  46. aws_cdk/aws_securitylake/__init__.py +2 -2
  47. aws_cdk/aws_servicecatalog/__init__.py +4 -0
  48. aws_cdk/aws_sns/__init__.py +1 -1
  49. aws_cdk/aws_stepfunctions/__init__.py +23 -17
  50. aws_cdk/aws_stepfunctions_tasks/__init__.py +4 -0
  51. aws_cdk/aws_synthetics/__init__.py +9 -0
  52. aws_cdk/aws_systemsmanagersap/__init__.py +150 -0
  53. aws_cdk/aws_wafv2/__init__.py +464 -1138
  54. aws_cdk/cloud_assembly_schema/__init__.py +60 -10
  55. aws_cdk/cx_api/__init__.py +15 -0
  56. aws_cdk/pipelines/__init__.py +20 -2
  57. {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/METADATA +4 -4
  58. {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/RECORD +62 -62
  59. {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/WHEEL +1 -1
  60. {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/LICENSE +0 -0
  61. {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/NOTICE +0 -0
  62. {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/top_level.txt +0 -0
@@ -24,7 +24,10 @@ to an S3 bucket during deployment.
24
24
 
25
25
  ```python
26
26
  asset = assets.Asset(self, "SampleAsset",
27
- path=path.join(__dirname, "file-asset.txt")
27
+ path=path.join(__dirname, "file-asset.txt"),
28
+
29
+ # Optional: describe the purpose of the asset with a human-readable string
30
+ display_name="My file"
28
31
  )
29
32
  ```
30
33
 
@@ -294,6 +297,7 @@ class Asset(
294
297
  *,
295
298
  path: builtins.str,
296
299
  deploy_time: typing.Optional[builtins.bool] = None,
300
+ display_name: typing.Optional[builtins.str] = None,
297
301
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
298
302
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
299
303
  asset_hash: typing.Optional[builtins.str] = None,
@@ -308,6 +312,7 @@ class Asset(
308
312
  :param id: -
309
313
  :param path: The disk location of the asset. The path should refer to one of the following: - A regular file or a .zip file, in which case the file will be uploaded as-is to S3. - A directory, in which case it will be archived into a .zip file and uploaded to S3.
310
314
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
315
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
311
316
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
312
317
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
313
318
  :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -324,6 +329,7 @@ class Asset(
324
329
  props = AssetProps(
325
330
  path=path,
326
331
  deploy_time=deploy_time,
332
+ display_name=display_name,
327
333
  readers=readers,
328
334
  source_kms_key=source_kms_key,
329
335
  asset_hash=asset_hash,
@@ -462,6 +468,7 @@ class Asset(
462
468
  "follow_symlinks": "followSymlinks",
463
469
  "ignore_mode": "ignoreMode",
464
470
  "deploy_time": "deployTime",
471
+ "display_name": "displayName",
465
472
  "readers": "readers",
466
473
  "source_kms_key": "sourceKMSKey",
467
474
  },
@@ -477,6 +484,7 @@ class AssetOptions(_AssetOptions_9cd3031e, _FileCopyOptions_e03e2a30):
477
484
  follow_symlinks: typing.Optional[_SymlinkFollowMode_047ec1f6] = None,
478
485
  ignore_mode: typing.Optional[_IgnoreMode_655a98e8] = None,
479
486
  deploy_time: typing.Optional[builtins.bool] = None,
487
+ display_name: typing.Optional[builtins.str] = None,
480
488
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
481
489
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
482
490
  ) -> None:
@@ -488,6 +496,7 @@ class AssetOptions(_AssetOptions_9cd3031e, _FileCopyOptions_e03e2a30):
488
496
  :param follow_symlinks: A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
489
497
  :param ignore_mode: The ignore behavior to use for ``exclude`` patterns. Default: IgnoreMode.GLOB
490
498
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
499
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
491
500
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
492
501
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
493
502
 
@@ -518,6 +527,7 @@ class AssetOptions(_AssetOptions_9cd3031e, _FileCopyOptions_e03e2a30):
518
527
  check_type(argname="argument follow_symlinks", value=follow_symlinks, expected_type=type_hints["follow_symlinks"])
519
528
  check_type(argname="argument ignore_mode", value=ignore_mode, expected_type=type_hints["ignore_mode"])
520
529
  check_type(argname="argument deploy_time", value=deploy_time, expected_type=type_hints["deploy_time"])
530
+ check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
521
531
  check_type(argname="argument readers", value=readers, expected_type=type_hints["readers"])
522
532
  check_type(argname="argument source_kms_key", value=source_kms_key, expected_type=type_hints["source_kms_key"])
523
533
  self._values: typing.Dict[builtins.str, typing.Any] = {}
@@ -535,6 +545,8 @@ class AssetOptions(_AssetOptions_9cd3031e, _FileCopyOptions_e03e2a30):
535
545
  self._values["ignore_mode"] = ignore_mode
536
546
  if deploy_time is not None:
537
547
  self._values["deploy_time"] = deploy_time
548
+ if display_name is not None:
549
+ self._values["display_name"] = display_name
538
550
  if readers is not None:
539
551
  self._values["readers"] = readers
540
552
  if source_kms_key is not None:
@@ -641,6 +653,30 @@ class AssetOptions(_AssetOptions_9cd3031e, _FileCopyOptions_e03e2a30):
641
653
  result = self._values.get("deploy_time")
642
654
  return typing.cast(typing.Optional[builtins.bool], result)
643
655
 
656
+ @builtins.property
657
+ def display_name(self) -> typing.Optional[builtins.str]:
658
+ '''A display name for this asset.
659
+
660
+ If supplied, the display name will be used in locations where the asset
661
+ identifier is printed, like in the CLI progress information. If the same
662
+ asset is added multiple times, the display name of the first occurrence is
663
+ used.
664
+
665
+ The default is the construct path of the Asset construct, with respect to
666
+ the enclosing stack. If the asset is produced by a construct helper
667
+ function (such as ``lambda.Code.fromAsset()``), this will look like
668
+ ``MyFunction/Code``.
669
+
670
+ We use the stack-relative construct path so that in the common case where
671
+ you have multiple stacks with the same asset, we won't show something like
672
+ ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to
673
+ production.
674
+
675
+ :default: - Stack-relative construct path
676
+ '''
677
+ result = self._values.get("display_name")
678
+ return typing.cast(typing.Optional[builtins.str], result)
679
+
644
680
  @builtins.property
645
681
  def readers(self) -> typing.Optional[typing.List[_IGrantable_71c4f5de]]:
646
682
  '''A list of principals that should be able to read this asset from S3.
@@ -684,6 +720,7 @@ class AssetOptions(_AssetOptions_9cd3031e, _FileCopyOptions_e03e2a30):
684
720
  "follow_symlinks": "followSymlinks",
685
721
  "ignore_mode": "ignoreMode",
686
722
  "deploy_time": "deployTime",
723
+ "display_name": "displayName",
687
724
  "readers": "readers",
688
725
  "source_kms_key": "sourceKMSKey",
689
726
  "path": "path",
@@ -700,6 +737,7 @@ class AssetProps(AssetOptions):
700
737
  follow_symlinks: typing.Optional[_SymlinkFollowMode_047ec1f6] = None,
701
738
  ignore_mode: typing.Optional[_IgnoreMode_655a98e8] = None,
702
739
  deploy_time: typing.Optional[builtins.bool] = None,
740
+ display_name: typing.Optional[builtins.str] = None,
703
741
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
704
742
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
705
743
  path: builtins.str,
@@ -712,6 +750,7 @@ class AssetProps(AssetOptions):
712
750
  :param follow_symlinks: A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
713
751
  :param ignore_mode: The ignore behavior to use for ``exclude`` patterns. Default: IgnoreMode.GLOB
714
752
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
753
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
715
754
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
716
755
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
717
756
  :param path: The disk location of the asset. The path should refer to one of the following: - A regular file or a .zip file, in which case the file will be uploaded as-is to S3. - A directory, in which case it will be archived into a .zip file and uploaded to S3.
@@ -743,6 +782,7 @@ class AssetProps(AssetOptions):
743
782
  check_type(argname="argument follow_symlinks", value=follow_symlinks, expected_type=type_hints["follow_symlinks"])
744
783
  check_type(argname="argument ignore_mode", value=ignore_mode, expected_type=type_hints["ignore_mode"])
745
784
  check_type(argname="argument deploy_time", value=deploy_time, expected_type=type_hints["deploy_time"])
785
+ check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
746
786
  check_type(argname="argument readers", value=readers, expected_type=type_hints["readers"])
747
787
  check_type(argname="argument source_kms_key", value=source_kms_key, expected_type=type_hints["source_kms_key"])
748
788
  check_type(argname="argument path", value=path, expected_type=type_hints["path"])
@@ -763,6 +803,8 @@ class AssetProps(AssetOptions):
763
803
  self._values["ignore_mode"] = ignore_mode
764
804
  if deploy_time is not None:
765
805
  self._values["deploy_time"] = deploy_time
806
+ if display_name is not None:
807
+ self._values["display_name"] = display_name
766
808
  if readers is not None:
767
809
  self._values["readers"] = readers
768
810
  if source_kms_key is not None:
@@ -869,6 +911,30 @@ class AssetProps(AssetOptions):
869
911
  result = self._values.get("deploy_time")
870
912
  return typing.cast(typing.Optional[builtins.bool], result)
871
913
 
914
+ @builtins.property
915
+ def display_name(self) -> typing.Optional[builtins.str]:
916
+ '''A display name for this asset.
917
+
918
+ If supplied, the display name will be used in locations where the asset
919
+ identifier is printed, like in the CLI progress information. If the same
920
+ asset is added multiple times, the display name of the first occurrence is
921
+ used.
922
+
923
+ The default is the construct path of the Asset construct, with respect to
924
+ the enclosing stack. If the asset is produced by a construct helper
925
+ function (such as ``lambda.Code.fromAsset()``), this will look like
926
+ ``MyFunction/Code``.
927
+
928
+ We use the stack-relative construct path so that in the common case where
929
+ you have multiple stacks with the same asset, we won't show something like
930
+ ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to
931
+ production.
932
+
933
+ :default: - Stack-relative construct path
934
+ '''
935
+ result = self._values.get("display_name")
936
+ return typing.cast(typing.Optional[builtins.str], result)
937
+
872
938
  @builtins.property
873
939
  def readers(self) -> typing.Optional[typing.List[_IGrantable_71c4f5de]]:
874
940
  '''A list of principals that should be able to read this asset from S3.
@@ -928,6 +994,7 @@ def _typecheckingstub__00df81fd3b746cf2ee52c0e7a23b6fdc1b45db97673ca7e25a9651e7e
928
994
  *,
929
995
  path: builtins.str,
930
996
  deploy_time: typing.Optional[builtins.bool] = None,
997
+ display_name: typing.Optional[builtins.str] = None,
931
998
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
932
999
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
933
1000
  asset_hash: typing.Optional[builtins.str] = None,
@@ -962,6 +1029,7 @@ def _typecheckingstub__11950fe0327642dd25ddfeb2c620bb33847718475fe489bf003d096a0
962
1029
  follow_symlinks: typing.Optional[_SymlinkFollowMode_047ec1f6] = None,
963
1030
  ignore_mode: typing.Optional[_IgnoreMode_655a98e8] = None,
964
1031
  deploy_time: typing.Optional[builtins.bool] = None,
1032
+ display_name: typing.Optional[builtins.str] = None,
965
1033
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
966
1034
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
967
1035
  ) -> None:
@@ -977,6 +1045,7 @@ def _typecheckingstub__f879318d3885bc2e9c71c124fac7ad5a955812e438be7c03244c3aad7
977
1045
  follow_symlinks: typing.Optional[_SymlinkFollowMode_047ec1f6] = None,
978
1046
  ignore_mode: typing.Optional[_IgnoreMode_655a98e8] = None,
979
1047
  deploy_time: typing.Optional[builtins.bool] = None,
1048
+ display_name: typing.Optional[builtins.str] = None,
980
1049
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
981
1050
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
982
1051
  path: builtins.str,
@@ -1952,6 +1952,7 @@ class Source(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_s3_deployment.S
1952
1952
  path: builtins.str,
1953
1953
  *,
1954
1954
  deploy_time: typing.Optional[builtins.bool] = None,
1955
+ display_name: typing.Optional[builtins.str] = None,
1955
1956
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
1956
1957
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
1957
1958
  asset_hash: typing.Optional[builtins.str] = None,
@@ -1968,6 +1969,7 @@ class Source(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_s3_deployment.S
1968
1969
 
1969
1970
  :param path: The path to a local .zip file or a directory.
1970
1971
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
1972
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
1971
1973
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
1972
1974
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
1973
1975
  :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -1982,6 +1984,7 @@ class Source(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_s3_deployment.S
1982
1984
  check_type(argname="argument path", value=path, expected_type=type_hints["path"])
1983
1985
  options = _AssetOptions_2aa69621(
1984
1986
  deploy_time=deploy_time,
1987
+ display_name=display_name,
1985
1988
  readers=readers,
1986
1989
  source_kms_key=source_kms_key,
1987
1990
  asset_hash=asset_hash,
@@ -2443,6 +2446,7 @@ def _typecheckingstub__fc877c69568cee7364ec77003356fc6818118602dda64adf3dbf38ff7
2443
2446
  path: builtins.str,
2444
2447
  *,
2445
2448
  deploy_time: typing.Optional[builtins.bool] = None,
2449
+ display_name: typing.Optional[builtins.str] = None,
2446
2450
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
2447
2451
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
2448
2452
  asset_hash: typing.Optional[builtins.str] = None,
@@ -10021,7 +10021,7 @@ class CfnEndpoint(
10021
10021
  :param id: Construct identifier for this resource (unique in its scope).
10022
10022
  :param endpoint_config_name: The name of the `AWS::SageMaker::EndpointConfig <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html>`_ resource that specifies the configuration for the endpoint. For more information, see `CreateEndpointConfig <https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html>`_ .
10023
10023
  :param deployment_config: The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
10024
- :param endpoint_name: The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in ``CreateEndpoint`` , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .
10024
+ :param endpoint_name: The name of the endpoint. The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in ``CreateEndpoint`` , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .
10025
10025
  :param exclude_retained_variant_properties: When you are updating endpoint resources with `RetainAllVariantProperties <https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties>`_ whose value is set to ``true`` , ``ExcludeRetainedVariantProperties`` specifies the list of type `VariantProperty <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html>`_ to override with the values provided by ``EndpointConfig`` . If you don't specify a value for ``ExcludeAllVariantProperties`` , no variant properties are overridden. Don't use this property when creating new endpoint resources or when ``RetainAllVariantProperties`` is set to ``false`` .
10026
10026
  :param retain_all_variant_properties: When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set ``RetainAllVariantProperties`` to ``true`` . To use the variant properties specified in a new ``EndpointConfig`` call when updating an endpoint, set ``RetainAllVariantProperties`` to ``false`` . Use this property only when updating endpoint resources, not when creating new endpoint resources.
10027
10027
  :param retain_deployment_config: Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
@@ -10144,7 +10144,7 @@ class CfnEndpoint(
10144
10144
  @builtins.property
10145
10145
  @jsii.member(jsii_name="endpointName")
10146
10146
  def endpoint_name(self) -> typing.Optional[builtins.str]:
10147
- '''The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in ``CreateEndpoint`` , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .'''
10147
+ '''The name of the endpoint.'''
10148
10148
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "endpointName"))
10149
10149
 
10150
10150
  @endpoint_name.setter
@@ -13864,7 +13864,7 @@ class CfnEndpointProps:
13864
13864
 
13865
13865
  :param endpoint_config_name: The name of the `AWS::SageMaker::EndpointConfig <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html>`_ resource that specifies the configuration for the endpoint. For more information, see `CreateEndpointConfig <https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html>`_ .
13866
13866
  :param deployment_config: The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
13867
- :param endpoint_name: The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in ``CreateEndpoint`` , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .
13867
+ :param endpoint_name: The name of the endpoint. The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in ``CreateEndpoint`` , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .
13868
13868
  :param exclude_retained_variant_properties: When you are updating endpoint resources with `RetainAllVariantProperties <https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties>`_ whose value is set to ``true`` , ``ExcludeRetainedVariantProperties`` specifies the list of type `VariantProperty <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html>`_ to override with the values provided by ``EndpointConfig`` . If you don't specify a value for ``ExcludeAllVariantProperties`` , no variant properties are overridden. Don't use this property when creating new endpoint resources or when ``RetainAllVariantProperties`` is set to ``false`` .
13869
13869
  :param retain_all_variant_properties: When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set ``RetainAllVariantProperties`` to ``true`` . To use the variant properties specified in a new ``EndpointConfig`` call when updating an endpoint, set ``RetainAllVariantProperties`` to ``false`` . Use this property only when updating endpoint resources, not when creating new endpoint resources.
13870
13870
  :param retain_deployment_config: Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
@@ -13984,7 +13984,9 @@ class CfnEndpointProps:
13984
13984
 
13985
13985
  @builtins.property
13986
13986
  def endpoint_name(self) -> typing.Optional[builtins.str]:
13987
- '''The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in ``CreateEndpoint`` , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .
13987
+ '''The name of the endpoint.
13988
+
13989
+ The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in ``CreateEndpoint`` , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .
13988
13990
 
13989
13991
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.html#cfn-sagemaker-endpoint-endpointname
13990
13992
  '''
@@ -3041,31 +3041,19 @@ class LambdaInvoke(
3041
3041
 
3042
3042
  Example::
3043
3043
 
3044
- import aws_cdk.aws_lambda as lambda_
3044
+ # fn: lambda.Function
3045
3045
 
3046
3046
 
3047
- fn = lambda_.Function(self, "MyFunc",
3048
- runtime=lambda_.Runtime.NODEJS_LATEST,
3049
- handler="index.handler",
3050
- code=lambda_.Code.from_inline("exports.handler = handler.toString()")
3051
- )
3052
-
3053
- dlq = sqs.Queue(self, "DLQ",
3054
- queue_name="MyDLQ"
3055
- )
3056
-
3057
3047
  target = targets.LambdaInvoke(fn,
3058
- dead_letter_queue=dlq,
3059
- max_event_age=Duration.minutes(1),
3060
- retry_attempts=3,
3061
3048
  input=ScheduleTargetInput.from_object({
3062
3049
  "payload": "useful"
3063
3050
  })
3064
3051
  )
3065
3052
 
3066
3053
  schedule = Schedule(self, "Schedule",
3067
- schedule=ScheduleExpression.rate(Duration.hours(1)),
3068
- target=target
3054
+ schedule=ScheduleExpression.rate(Duration.minutes(10)),
3055
+ target=target,
3056
+ description="This is a test schedule that invokes a lambda function every 10 minutes."
3069
3057
  )
3070
3058
  '''
3071
3059
 
@@ -854,7 +854,7 @@ class CfnDataLake(
854
854
  For more information about Amazon S3 Lifecycle configurations, see `Managing your storage lifecycle <https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html>`_ in the *Amazon Simple Storage Service User Guide* .
855
855
 
856
856
  :param days: The number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
857
- :param storage_class: The list of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads. The default storage class is S3 Standard.
857
+ :param storage_class: The list of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads. The default storage class is *S3 Standard* . For information about other storage classes, see `Setting the storage class of an object <https://docs.aws.amazon.com/AmazonS3/latest/userguide/sc-howtoset.html>`_ in the *Amazon S3 User Guide* .
858
858
 
859
859
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html
860
860
  :exampleMetadata: fixture=_generated
@@ -893,7 +893,7 @@ class CfnDataLake(
893
893
  def storage_class(self) -> typing.Optional[builtins.str]:
894
894
  '''The list of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
895
895
 
896
- The default storage class is S3 Standard.
896
+ The default storage class is *S3 Standard* . For information about other storage classes, see `Setting the storage class of an object <https://docs.aws.amazon.com/AmazonS3/latest/userguide/sc-howtoset.html>`_ in the *Amazon S3 User Guide* .
897
897
 
898
898
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-datalake-transitions.html#cfn-securitylake-datalake-transitions-storageclass
899
899
  '''
@@ -7038,6 +7038,7 @@ class CloudFormationTemplate(
7038
7038
  path: builtins.str,
7039
7039
  *,
7040
7040
  deploy_time: typing.Optional[builtins.bool] = None,
7041
+ display_name: typing.Optional[builtins.str] = None,
7041
7042
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
7042
7043
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
7043
7044
  asset_hash: typing.Optional[builtins.str] = None,
@@ -7051,6 +7052,7 @@ class CloudFormationTemplate(
7051
7052
 
7052
7053
  :param path: A file containing the provisioning artifacts.
7053
7054
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
7055
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
7054
7056
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
7055
7057
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
7056
7058
  :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -7065,6 +7067,7 @@ class CloudFormationTemplate(
7065
7067
  check_type(argname="argument path", value=path, expected_type=type_hints["path"])
7066
7068
  options = _AssetOptions_2aa69621(
7067
7069
  deploy_time=deploy_time,
7070
+ display_name=display_name,
7068
7071
  readers=readers,
7069
7072
  source_kms_key=source_kms_key,
7070
7073
  asset_hash=asset_hash,
@@ -11128,6 +11131,7 @@ def _typecheckingstub__8e0d542f4ba87cd0da3d994035ba4c030fc0e065bd6d2e49190b0063a
11128
11131
  path: builtins.str,
11129
11132
  *,
11130
11133
  deploy_time: typing.Optional[builtins.bool] = None,
11134
+ display_name: typing.Optional[builtins.str] = None,
11131
11135
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
11132
11136
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
11133
11137
  asset_hash: typing.Optional[builtins.str] = None,
@@ -685,7 +685,7 @@ class CfnSubscription(
685
685
  @builtins.property
686
686
  @jsii.member(jsii_name="attrArn")
687
687
  def attr_arn(self) -> builtins.str:
688
- '''Returns the ARN of the subscription created by the AWS::SNS::Subscription resource.
688
+ '''Returns the ARN of the subscription created by the ``AWS::SNS::Subscription`` resource.
689
689
 
690
690
  :cloudformationAttribute: Arn
691
691
  '''
@@ -5735,6 +5735,7 @@ class DefinitionBody(
5735
5735
  path: builtins.str,
5736
5736
  *,
5737
5737
  deploy_time: typing.Optional[builtins.bool] = None,
5738
+ display_name: typing.Optional[builtins.str] = None,
5738
5739
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
5739
5740
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
5740
5741
  asset_hash: typing.Optional[builtins.str] = None,
@@ -5747,6 +5748,7 @@ class DefinitionBody(
5747
5748
  '''
5748
5749
  :param path: -
5749
5750
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
5751
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
5750
5752
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
5751
5753
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
5752
5754
  :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -5761,6 +5763,7 @@ class DefinitionBody(
5761
5763
  check_type(argname="argument path", value=path, expected_type=type_hints["path"])
5762
5764
  options = _AssetOptions_2aa69621(
5763
5765
  deploy_time=deploy_time,
5766
+ display_name=display_name,
5764
5767
  readers=readers,
5765
5768
  source_kms_key=source_kms_key,
5766
5769
  asset_hash=asset_hash,
@@ -6175,6 +6178,7 @@ class FileDefinitionBody(
6175
6178
  path: builtins.str,
6176
6179
  *,
6177
6180
  deploy_time: typing.Optional[builtins.bool] = None,
6181
+ display_name: typing.Optional[builtins.str] = None,
6178
6182
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
6179
6183
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
6180
6184
  asset_hash: typing.Optional[builtins.str] = None,
@@ -6187,6 +6191,7 @@ class FileDefinitionBody(
6187
6191
  '''
6188
6192
  :param path: -
6189
6193
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
6194
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
6190
6195
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
6191
6196
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
6192
6197
  :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -6201,6 +6206,7 @@ class FileDefinitionBody(
6201
6206
  check_type(argname="argument path", value=path, expected_type=type_hints["path"])
6202
6207
  options = _AssetOptions_2aa69621(
6203
6208
  deploy_time=deploy_time,
6209
+ display_name=display_name,
6204
6210
  readers=readers,
6205
6211
  source_kms_key=source_kms_key,
6206
6212
  asset_hash=asset_hash,
@@ -12105,25 +12111,23 @@ class StateMachineProps:
12105
12111
 
12106
12112
  Example::
12107
12113
 
12108
- # Define a state machine with one Pass state
12109
- child = sfn.StateMachine(self, "ChildStateMachine",
12110
- definition=sfn.Chain.start(sfn.Pass(self, "PassState"))
12111
- )
12114
+ import aws_cdk.aws_stepfunctions as stepfunctions
12112
12115
 
12113
- # Include the state machine in a Task state with callback pattern
12114
- task = tasks.StepFunctionsStartExecution(self, "ChildTask",
12115
- state_machine=child,
12116
- integration_pattern=sfn.IntegrationPattern.WAIT_FOR_TASK_TOKEN,
12117
- input=sfn.TaskInput.from_object({
12118
- "token": sfn.JsonPath.task_token,
12119
- "foo": "bar"
12120
- }),
12121
- name="MyExecutionName"
12122
- )
12123
12116
 
12124
- # Define a second state machine with the Task state above
12125
- sfn.StateMachine(self, "ParentStateMachine",
12126
- definition=task
12117
+ pipeline = codepipeline.Pipeline(self, "MyPipeline")
12118
+ input_artifact = codepipeline.Artifact()
12119
+ start_state = stepfunctions.Pass(self, "StartState")
12120
+ simple_state_machine = stepfunctions.StateMachine(self, "SimpleStateMachine",
12121
+ definition=start_state
12122
+ )
12123
+ step_function_action = codepipeline_actions.StepFunctionInvokeAction(
12124
+ action_name="Invoke",
12125
+ state_machine=simple_state_machine,
12126
+ state_machine_input=codepipeline_actions.StateMachineInput.file_path(input_artifact.at_path("assets/input.json"))
12127
+ )
12128
+ pipeline.add_stage(
12129
+ stage_name="StepFunctions",
12130
+ actions=[step_function_action]
12127
12131
  )
12128
12132
  '''
12129
12133
  if isinstance(logs, dict):
@@ -25632,6 +25636,7 @@ def _typecheckingstub__2e34fabd0367a0519a35d86d419baa37e6fe26ad05457e96b236a55bb
25632
25636
  path: builtins.str,
25633
25637
  *,
25634
25638
  deploy_time: typing.Optional[builtins.bool] = None,
25639
+ display_name: typing.Optional[builtins.str] = None,
25635
25640
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
25636
25641
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
25637
25642
  asset_hash: typing.Optional[builtins.str] = None,
@@ -25702,6 +25707,7 @@ def _typecheckingstub__526ef9213812e76ec99bd530d4fbea7cc137d220b92525fe763d6d315
25702
25707
  path: builtins.str,
25703
25708
  *,
25704
25709
  deploy_time: typing.Optional[builtins.bool] = None,
25710
+ display_name: typing.Optional[builtins.str] = None,
25705
25711
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
25706
25712
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
25707
25713
  asset_hash: typing.Optional[builtins.str] = None,
@@ -22063,6 +22063,7 @@ class DockerImage(
22063
22063
  cache_disabled: typing.Optional[builtins.bool] = None,
22064
22064
  cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
22065
22065
  cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
22066
+ display_name: typing.Optional[builtins.str] = None,
22066
22067
  file: typing.Optional[builtins.str] = None,
22067
22068
  invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
22068
22069
  network_mode: typing.Optional[_NetworkMode_897e5081] = None,
@@ -22086,6 +22087,7 @@ class DockerImage(
22086
22087
  :param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
22087
22088
  :param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
22088
22089
  :param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
22090
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. If ``assetName`` is given, it will also be used as the default ``displayName``. Otherwise, the default is the construct path of the ImageAsset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAssetImage()``), this will look like ``MyFunction/AssetImage``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
22089
22091
  :param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
22090
22092
  :param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
22091
22093
  :param network_mode: Networking mode for the RUN commands during build. Support docker API 1.25+. Default: - no networking mode specified (the default networking mode ``NetworkMode.DEFAULT`` will be used)
@@ -22110,6 +22112,7 @@ class DockerImage(
22110
22112
  cache_disabled=cache_disabled,
22111
22113
  cache_from=cache_from,
22112
22114
  cache_to=cache_to,
22115
+ display_name=display_name,
22113
22116
  file=file,
22114
22117
  invalidation=invalidation,
22115
22118
  network_mode=network_mode,
@@ -88054,6 +88057,7 @@ def _typecheckingstub__5c9f551a01d287eabffcb602e6704dea79fda61e24da62e8d266fa6d1
88054
88057
  cache_disabled: typing.Optional[builtins.bool] = None,
88055
88058
  cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
88056
88059
  cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
88060
+ display_name: typing.Optional[builtins.str] = None,
88057
88061
  file: typing.Optional[builtins.str] = None,
88058
88062
  invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
88059
88063
  network_mode: typing.Optional[_NetworkMode_897e5081] = None,
@@ -3298,6 +3298,7 @@ class Code(
3298
3298
  asset_path: builtins.str,
3299
3299
  *,
3300
3300
  deploy_time: typing.Optional[builtins.bool] = None,
3301
+ display_name: typing.Optional[builtins.str] = None,
3301
3302
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
3302
3303
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
3303
3304
  asset_hash: typing.Optional[builtins.str] = None,
@@ -3313,6 +3314,7 @@ class Code(
3313
3314
 
3314
3315
  :param asset_path: Either a directory or a .zip file.
3315
3316
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
3317
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
3316
3318
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
3317
3319
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
3318
3320
  :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -3331,6 +3333,7 @@ class Code(
3331
3333
  check_type(argname="argument asset_path", value=asset_path, expected_type=type_hints["asset_path"])
3332
3334
  options = _AssetOptions_2aa69621(
3333
3335
  deploy_time=deploy_time,
3336
+ display_name=display_name,
3334
3337
  readers=readers,
3335
3338
  source_kms_key=source_kms_key,
3336
3339
  asset_hash=asset_hash,
@@ -4460,6 +4463,7 @@ class AssetCode(
4460
4463
  working_directory="workingDirectory"
4461
4464
  ),
4462
4465
  deploy_time=False,
4466
+ display_name="displayName",
4463
4467
  exclude=["exclude"],
4464
4468
  follow_symlinks=cdk.SymlinkFollowMode.NEVER,
4465
4469
  ignore_mode=cdk.IgnoreMode.GLOB,
@@ -4473,6 +4477,7 @@ class AssetCode(
4473
4477
  asset_path: builtins.str,
4474
4478
  *,
4475
4479
  deploy_time: typing.Optional[builtins.bool] = None,
4480
+ display_name: typing.Optional[builtins.str] = None,
4476
4481
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
4477
4482
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
4478
4483
  asset_hash: typing.Optional[builtins.str] = None,
@@ -4485,6 +4490,7 @@ class AssetCode(
4485
4490
  '''
4486
4491
  :param asset_path: The path to the asset file or directory.
4487
4492
  :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
4493
+ :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
4488
4494
  :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
4489
4495
  :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
4490
4496
  :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -4499,6 +4505,7 @@ class AssetCode(
4499
4505
  check_type(argname="argument asset_path", value=asset_path, expected_type=type_hints["asset_path"])
4500
4506
  options = _AssetOptions_2aa69621(
4501
4507
  deploy_time=deploy_time,
4508
+ display_name=display_name,
4502
4509
  readers=readers,
4503
4510
  source_kms_key=source_kms_key,
4504
4511
  asset_hash=asset_hash,
@@ -4913,6 +4920,7 @@ def _typecheckingstub__02201c2190b076bbceced8708b435fab8189f7f505650002941cc7a50
4913
4920
  asset_path: builtins.str,
4914
4921
  *,
4915
4922
  deploy_time: typing.Optional[builtins.bool] = None,
4923
+ display_name: typing.Optional[builtins.str] = None,
4916
4924
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
4917
4925
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
4918
4926
  asset_hash: typing.Optional[builtins.str] = None,
@@ -5030,6 +5038,7 @@ def _typecheckingstub__60a29a536d66536254f2ca409a65dc32f30e483b29091222d42f32106
5030
5038
  asset_path: builtins.str,
5031
5039
  *,
5032
5040
  deploy_time: typing.Optional[builtins.bool] = None,
5041
+ display_name: typing.Optional[builtins.str] = None,
5033
5042
  readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
5034
5043
  source_kms_key: typing.Optional[_IKey_5f11635f] = None,
5035
5044
  asset_hash: typing.Optional[builtins.str] = None,