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

aws_cdk/aws_ecs/__init__.py

@@ -3977,6 +3977,7 @@ class AsgCapacityProviderProps(AddAutoScalingGroupCapacityOptions):
         "cache_disabled": "cacheDisabled",
         "cache_from": "cacheFrom",
         "cache_to": "cacheTo",
+        "display_name": "displayName",
         "file": "file",
         "invalidation": "invalidation",
         "network_mode": "networkMode",
@@ -4000,6 +4001,7 @@ class AssetImageProps(_DockerImageAssetOptions_9580cd76):
         cache_disabled: typing.Optional[builtins.bool] = None,
         cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
         cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
+        display_name: typing.Optional[builtins.str] = None,
         file: typing.Optional[builtins.str] = None,
         invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
         network_mode: typing.Optional[_NetworkMode_897e5081] = None,
@@ -4020,6 +4022,7 @@ class AssetImageProps(_DockerImageAssetOptions_9580cd76):
         :param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
         :param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
         :param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
+        :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
         :param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
         :param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
         :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)
@@ -4066,6 +4069,7 @@ class AssetImageProps(_DockerImageAssetOptions_9580cd76):
                         "params_key": "params"
                     }
                 ),
+                display_name="displayName",
                 exclude=["exclude"],
                 extra_hash="extraHash",
                 file="file",
@@ -4106,6 +4110,7 @@ class AssetImageProps(_DockerImageAssetOptions_9580cd76):
             check_type(argname="argument cache_disabled", value=cache_disabled, expected_type=type_hints["cache_disabled"])
             check_type(argname="argument cache_from", value=cache_from, expected_type=type_hints["cache_from"])
             check_type(argname="argument cache_to", value=cache_to, expected_type=type_hints["cache_to"])
+            check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
             check_type(argname="argument file", value=file, expected_type=type_hints["file"])
             check_type(argname="argument invalidation", value=invalidation, expected_type=type_hints["invalidation"])
             check_type(argname="argument network_mode", value=network_mode, expected_type=type_hints["network_mode"])
@@ -4135,6 +4140,8 @@ class AssetImageProps(_DockerImageAssetOptions_9580cd76):
             self._values["cache_from"] = cache_from
         if cache_to is not None:
             self._values["cache_to"] = cache_to
+        if display_name is not None:
+            self._values["display_name"] = display_name
         if file is not None:
             self._values["file"] = file
         if invalidation is not None:
@@ -4279,6 +4286,31 @@ class AssetImageProps(_DockerImageAssetOptions_9580cd76):
         result = self._values.get("cache_to")
         return typing.cast(typing.Optional[_DockerCacheOption_58ef18ca], result)
 
+    @builtins.property
+    def display_name(self) -> typing.Optional[builtins.str]:
+        '''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
+        '''
+        result = self._values.get("display_name")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def file(self) -> typing.Optional[builtins.str]:
         '''Path to the Dockerfile (relative to the directory).
@@ -22687,6 +22719,7 @@ class ContainerImage(
         cache_disabled: typing.Optional[builtins.bool] = None,
         cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
         cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
+        display_name: typing.Optional[builtins.str] = None,
         file: typing.Optional[builtins.str] = None,
         invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
         network_mode: typing.Optional[_NetworkMode_897e5081] = None,
@@ -22711,6 +22744,7 @@ class ContainerImage(
         :param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
         :param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
         :param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
+        :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
         :param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
         :param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
         :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)
@@ -22733,6 +22767,7 @@ class ContainerImage(
             cache_disabled=cache_disabled,
             cache_from=cache_from,
             cache_to=cache_to,
+            display_name=display_name,
             file=file,
             invalidation=invalidation,
             network_mode=network_mode,
@@ -25639,6 +25674,7 @@ class EnvironmentFile(
         path: builtins.str,
         *,
         deploy_time: typing.Optional[builtins.bool] = None,
+        display_name: typing.Optional[builtins.str] = None,
         readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
         source_kms_key: typing.Optional[_IKey_5f11635f] = None,
         asset_hash: typing.Optional[builtins.str] = None,
@@ -25652,6 +25688,7 @@ class EnvironmentFile(
 
         :param path: Local disk path.
         :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
+        :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
         :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
         :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
         :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -25666,6 +25703,7 @@ class EnvironmentFile(
             check_type(argname="argument path", value=path, expected_type=type_hints["path"])
         options = _AssetOptions_2aa69621(
             deploy_time=deploy_time,
+            display_name=display_name,
             readers=readers,
             source_kms_key=source_kms_key,
             asset_hash=asset_hash,
@@ -39231,6 +39269,7 @@ class AssetEnvironmentFile(
                 working_directory="workingDirectory"
             ),
             deploy_time=False,
+            display_name="displayName",
             exclude=["exclude"],
             follow_symlinks=cdk.SymlinkFollowMode.NEVER,
             ignore_mode=cdk.IgnoreMode.GLOB,
@@ -39244,6 +39283,7 @@ class AssetEnvironmentFile(
         path: builtins.str,
         *,
         deploy_time: typing.Optional[builtins.bool] = None,
+        display_name: typing.Optional[builtins.str] = None,
         readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
         source_kms_key: typing.Optional[_IKey_5f11635f] = None,
         asset_hash: typing.Optional[builtins.str] = None,
@@ -39256,6 +39296,7 @@ class AssetEnvironmentFile(
         '''
         :param path: The path to the asset file or directory.
         :param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
+        :param display_name: A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as ``lambda.Code.fromAsset()``), this will look like ``MyFunction/Code``. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like ``/MyBetaStack/MyFunction/Code`` when you are actually deploying to production. Default: - Stack-relative construct path
         :param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
         :param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
         :param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
@@ -39270,6 +39311,7 @@ class AssetEnvironmentFile(
             check_type(argname="argument path", value=path, expected_type=type_hints["path"])
         options = _AssetOptions_2aa69621(
             deploy_time=deploy_time,
+            display_name=display_name,
             readers=readers,
             source_kms_key=source_kms_key,
             asset_hash=asset_hash,
@@ -39346,6 +39388,7 @@ class AssetImage(
                     "params_key": "params"
                 }
             ),
+            display_name="displayName",
             exclude=["exclude"],
             extra_hash="extraHash",
             file="file",
@@ -39381,6 +39424,7 @@ class AssetImage(
         cache_disabled: typing.Optional[builtins.bool] = None,
         cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
         cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
+        display_name: typing.Optional[builtins.str] = None,
         file: typing.Optional[builtins.str] = None,
         invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
         network_mode: typing.Optional[_NetworkMode_897e5081] = None,
@@ -39402,6 +39446,7 @@ class AssetImage(
         :param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
         :param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
         :param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
+        :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
         :param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
         :param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
         :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)
@@ -39424,6 +39469,7 @@ class AssetImage(
             cache_disabled=cache_disabled,
             cache_from=cache_from,
             cache_to=cache_to,
+            display_name=display_name,
             file=file,
             invalidation=invalidation,
             network_mode=network_mode,
@@ -43227,6 +43273,7 @@ def _typecheckingstub__6e2e094929b9952c79f2d2f10cac8da6c1f6dad2f0e50e17e639ed016
     cache_disabled: typing.Optional[builtins.bool] = None,
     cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
     cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
+    display_name: typing.Optional[builtins.str] = None,
     file: typing.Optional[builtins.str] = None,
     invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
     network_mode: typing.Optional[_NetworkMode_897e5081] = None,
@@ -45113,6 +45160,7 @@ def _typecheckingstub__a3b74ad5b0ef573de8f4998ac2c10294ecc205320b367ba59d13b865f
     cache_disabled: typing.Optional[builtins.bool] = None,
     cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
     cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
+    display_name: typing.Optional[builtins.str] = None,
     file: typing.Optional[builtins.str] = None,
     invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
     network_mode: typing.Optional[_NetworkMode_897e5081] = None,
@@ -45454,6 +45502,7 @@ def _typecheckingstub__984c009064fe3ececa2babfa7da070310c1a07aad5d8719d7817aacaf
     path: builtins.str,
     *,
     deploy_time: typing.Optional[builtins.bool] = None,
+    display_name: typing.Optional[builtins.str] = None,
     readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
     source_kms_key: typing.Optional[_IKey_5f11635f] = None,
     asset_hash: typing.Optional[builtins.str] = None,
@@ -46754,6 +46803,7 @@ def _typecheckingstub__0c2450ee3cfe92be6dcc8ab1f8c7f9bc88382905f44289ab29eb782fb
     path: builtins.str,
     *,
     deploy_time: typing.Optional[builtins.bool] = None,
+    display_name: typing.Optional[builtins.str] = None,
     readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
     source_kms_key: typing.Optional[_IKey_5f11635f] = None,
     asset_hash: typing.Optional[builtins.str] = None,
@@ -46782,6 +46832,7 @@ def _typecheckingstub__4d3698baaf6e6b1c9fc983c7a139e8426df4d121c2e7cd948722f7942
     cache_disabled: typing.Optional[builtins.bool] = None,
     cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
     cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
+    display_name: typing.Optional[builtins.str] = None,
     file: typing.Optional[builtins.str] = None,
     invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
     network_mode: typing.Optional[_NetworkMode_897e5081] = None,