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.
- aws_cdk/__init__.py +281 -116
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.186.0.jsii.tgz → aws-cdk-lib@2.187.0.jsii.tgz} +0 -0
- aws_cdk/aws_amplify/__init__.py +124 -0
- aws_cdk/aws_apigateway/__init__.py +48 -2
- aws_cdk/aws_appsync/__init__.py +14 -5
- aws_cdk/aws_bedrock/__init__.py +32 -22
- aws_cdk/aws_cassandra/__init__.py +2 -2
- aws_cdk/aws_cloudfront/__init__.py +11 -0
- aws_cdk/aws_cloudtrail/__init__.py +4 -18
- aws_cdk/aws_cloudwatch/__init__.py +50 -50
- aws_cdk/aws_codebuild/__init__.py +9 -0
- aws_cdk/aws_config/__init__.py +2 -5
- aws_cdk/aws_datazone/__init__.py +287 -226
- aws_cdk/aws_detective/__init__.py +3 -3
- aws_cdk/aws_dynamodb/__init__.py +37 -0
- aws_cdk/aws_ec2/__init__.py +154 -12
- aws_cdk/aws_ecr/__init__.py +143 -0
- aws_cdk/aws_ecr_assets/__init__.py +115 -4
- aws_cdk/aws_ecs/__init__.py +51 -0
- aws_cdk/aws_eks/__init__.py +114 -0
- aws_cdk/aws_events/__init__.py +8 -11
- aws_cdk/aws_forecast/__init__.py +1 -1
- aws_cdk/aws_fsx/__init__.py +2 -2
- aws_cdk/aws_gamelift/__init__.py +6 -6
- aws_cdk/aws_identitystore/__init__.py +16 -16
- aws_cdk/aws_iotsitewise/__init__.py +623 -0
- aws_cdk/aws_kms/__init__.py +10 -11
- aws_cdk/aws_lakeformation/__init__.py +3 -3
- aws_cdk/aws_lambda/__init__.py +105 -4
- aws_cdk/aws_lambda_event_sources/__init__.py +65 -3
- aws_cdk/aws_lambda_nodejs/__init__.py +5 -24
- aws_cdk/aws_lex/__init__.py +981 -5
- aws_cdk/aws_mediaconnect/__init__.py +714 -290
- aws_cdk/aws_mwaa/__init__.py +9 -9
- aws_cdk/aws_networkfirewall/__init__.py +44 -0
- aws_cdk/aws_omics/__init__.py +216 -0
- aws_cdk/aws_quicksight/__init__.py +244 -39
- aws_cdk/aws_rds/__init__.py +102 -10
- aws_cdk/aws_route53/__init__.py +2 -2
- aws_cdk/aws_route53recoverycontrol/__init__.py +43 -2
- aws_cdk/aws_s3_assets/__init__.py +70 -1
- aws_cdk/aws_s3_deployment/__init__.py +4 -0
- aws_cdk/aws_sagemaker/__init__.py +6 -4
- aws_cdk/aws_scheduler_targets/__init__.py +4 -16
- aws_cdk/aws_securitylake/__init__.py +2 -2
- aws_cdk/aws_servicecatalog/__init__.py +4 -0
- aws_cdk/aws_sns/__init__.py +1 -1
- aws_cdk/aws_stepfunctions/__init__.py +23 -17
- aws_cdk/aws_stepfunctions_tasks/__init__.py +4 -0
- aws_cdk/aws_synthetics/__init__.py +9 -0
- aws_cdk/aws_systemsmanagersap/__init__.py +150 -0
- aws_cdk/aws_wafv2/__init__.py +464 -1138
- aws_cdk/cloud_assembly_schema/__init__.py +60 -10
- aws_cdk/cx_api/__init__.py +15 -0
- aws_cdk/pipelines/__init__.py +20 -2
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/METADATA +4 -4
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/RECORD +62 -62
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/WHEEL +1 -1
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.186.0.dist-info → aws_cdk_lib-2.187.0.dist-info}/top_level.txt +0 -0
|
@@ -785,7 +785,7 @@ class CfnDataLakeSettings(
|
|
|
785
785
|
:param create_table_default_permissions: Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates that the access is controlled by Lake Formation permissions. ``ALL`` permissions assigned to ``IAM_ALLOWED_PRINCIPALS`` group indicate that the user's IAM permissions determine the access to the table. This is referred to as the setting "Use only IAM access control," and is to support the backward compatibility with the AWS Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ``ALL`` permissions to ``IAM_ALLOWED_PRINCIPALS`` . For more information, see `Changing the default security settings for your data lake <https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html>`_ .
|
|
786
786
|
:param external_data_filtering_allow_list: A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
|
|
787
787
|
:param mutation_type: Specifies whether the data lake settings are updated by adding new values to the current settings ( ``APPEND`` ) or by replacing the current settings with new settings ( ``REPLACE`` ). .. epigraph:: If you choose ``REPLACE`` , your current data lake settings will be replaced with the new values in your template.
|
|
788
|
-
:param parameters: A key-value map that provides an additional configuration on your data lake. ``CrossAccountVersion`` is the key you can configure in the ``Parameters`` field. Accepted values for the ``CrossAccountVersion`` key are 1, 2, and
|
|
788
|
+
:param parameters: A key-value map that provides an additional configuration on your data lake. ``CrossAccountVersion`` is the key you can configure in the ``Parameters`` field. Accepted values for the ``CrossAccountVersion`` key are 1, 2, 3, and 4.
|
|
789
789
|
:param trusted_resource_owners: An array of UTF-8 strings. A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company.
|
|
790
790
|
'''
|
|
791
791
|
if __debug__:
|
|
@@ -1187,7 +1187,7 @@ class CfnDataLakeSettingsProps:
|
|
|
1187
1187
|
:param create_table_default_permissions: Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates that the access is controlled by Lake Formation permissions. ``ALL`` permissions assigned to ``IAM_ALLOWED_PRINCIPALS`` group indicate that the user's IAM permissions determine the access to the table. This is referred to as the setting "Use only IAM access control," and is to support the backward compatibility with the AWS Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ``ALL`` permissions to ``IAM_ALLOWED_PRINCIPALS`` . For more information, see `Changing the default security settings for your data lake <https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html>`_ .
|
|
1188
1188
|
:param external_data_filtering_allow_list: A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
|
|
1189
1189
|
:param mutation_type: Specifies whether the data lake settings are updated by adding new values to the current settings ( ``APPEND`` ) or by replacing the current settings with new settings ( ``REPLACE`` ). .. epigraph:: If you choose ``REPLACE`` , your current data lake settings will be replaced with the new values in your template.
|
|
1190
|
-
:param parameters: A key-value map that provides an additional configuration on your data lake. ``CrossAccountVersion`` is the key you can configure in the ``Parameters`` field. Accepted values for the ``CrossAccountVersion`` key are 1, 2, and
|
|
1190
|
+
:param parameters: A key-value map that provides an additional configuration on your data lake. ``CrossAccountVersion`` is the key you can configure in the ``Parameters`` field. Accepted values for the ``CrossAccountVersion`` key are 1, 2, 3, and 4.
|
|
1191
1191
|
:param trusted_resource_owners: An array of UTF-8 strings. A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company.
|
|
1192
1192
|
|
|
1193
1193
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html
|
|
@@ -1417,7 +1417,7 @@ class CfnDataLakeSettingsProps:
|
|
|
1417
1417
|
def parameters(self) -> typing.Any:
|
|
1418
1418
|
'''A key-value map that provides an additional configuration on your data lake.
|
|
1419
1419
|
|
|
1420
|
-
``CrossAccountVersion`` is the key you can configure in the ``Parameters`` field. Accepted values for the ``CrossAccountVersion`` key are 1, 2, and
|
|
1420
|
+
``CrossAccountVersion`` is the key you can configure in the ``Parameters`` field. Accepted values for the ``CrossAccountVersion`` key are 1, 2, 3, and 4.
|
|
1421
1421
|
|
|
1422
1422
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-parameters
|
|
1423
1423
|
'''
|
aws_cdk/aws_lambda/__init__.py
CHANGED
|
@@ -2550,6 +2550,7 @@ class Architecture(
|
|
|
2550
2550
|
"cache_disabled": "cacheDisabled",
|
|
2551
2551
|
"cache_from": "cacheFrom",
|
|
2552
2552
|
"cache_to": "cacheTo",
|
|
2553
|
+
"display_name": "displayName",
|
|
2553
2554
|
"file": "file",
|
|
2554
2555
|
"invalidation": "invalidation",
|
|
2555
2556
|
"network_mode": "networkMode",
|
|
@@ -2576,6 +2577,7 @@ class AssetImageCodeProps(_DockerImageAssetOptions_9580cd76):
|
|
|
2576
2577
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
2577
2578
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2578
2579
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
2580
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
2579
2581
|
file: typing.Optional[builtins.str] = None,
|
|
2580
2582
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
2581
2583
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|
|
@@ -2599,6 +2601,7 @@ class AssetImageCodeProps(_DockerImageAssetOptions_9580cd76):
|
|
|
2599
2601
|
:param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
|
|
2600
2602
|
:param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
|
|
2601
2603
|
:param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
|
|
2604
|
+
: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
|
|
2602
2605
|
:param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
|
|
2603
2606
|
:param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
|
|
2604
2607
|
: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)
|
|
@@ -2649,6 +2652,7 @@ class AssetImageCodeProps(_DockerImageAssetOptions_9580cd76):
|
|
|
2649
2652
|
}
|
|
2650
2653
|
),
|
|
2651
2654
|
cmd=["cmd"],
|
|
2655
|
+
display_name="displayName",
|
|
2652
2656
|
entrypoint=["entrypoint"],
|
|
2653
2657
|
exclude=["exclude"],
|
|
2654
2658
|
extra_hash="extraHash",
|
|
@@ -2691,6 +2695,7 @@ class AssetImageCodeProps(_DockerImageAssetOptions_9580cd76):
|
|
|
2691
2695
|
check_type(argname="argument cache_disabled", value=cache_disabled, expected_type=type_hints["cache_disabled"])
|
|
2692
2696
|
check_type(argname="argument cache_from", value=cache_from, expected_type=type_hints["cache_from"])
|
|
2693
2697
|
check_type(argname="argument cache_to", value=cache_to, expected_type=type_hints["cache_to"])
|
|
2698
|
+
check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
|
|
2694
2699
|
check_type(argname="argument file", value=file, expected_type=type_hints["file"])
|
|
2695
2700
|
check_type(argname="argument invalidation", value=invalidation, expected_type=type_hints["invalidation"])
|
|
2696
2701
|
check_type(argname="argument network_mode", value=network_mode, expected_type=type_hints["network_mode"])
|
|
@@ -2723,6 +2728,8 @@ class AssetImageCodeProps(_DockerImageAssetOptions_9580cd76):
|
|
|
2723
2728
|
self._values["cache_from"] = cache_from
|
|
2724
2729
|
if cache_to is not None:
|
|
2725
2730
|
self._values["cache_to"] = cache_to
|
|
2731
|
+
if display_name is not None:
|
|
2732
|
+
self._values["display_name"] = display_name
|
|
2726
2733
|
if file is not None:
|
|
2727
2734
|
self._values["file"] = file
|
|
2728
2735
|
if invalidation is not None:
|
|
@@ -2873,6 +2880,31 @@ class AssetImageCodeProps(_DockerImageAssetOptions_9580cd76):
|
|
|
2873
2880
|
result = self._values.get("cache_to")
|
|
2874
2881
|
return typing.cast(typing.Optional[_DockerCacheOption_58ef18ca], result)
|
|
2875
2882
|
|
|
2883
|
+
@builtins.property
|
|
2884
|
+
def display_name(self) -> typing.Optional[builtins.str]:
|
|
2885
|
+
'''A display name for this asset.
|
|
2886
|
+
|
|
2887
|
+
If supplied, the display name will be used in locations where the asset
|
|
2888
|
+
identifier is printed, like in the CLI progress information. If the same
|
|
2889
|
+
asset is added multiple times, the display name of the first occurrence is
|
|
2890
|
+
used.
|
|
2891
|
+
|
|
2892
|
+
If ``assetName`` is given, it will also be used as the default ``displayName``.
|
|
2893
|
+
Otherwise, the default is the construct path of the ImageAsset construct,
|
|
2894
|
+
with respect to the enclosing stack. If the asset is produced by a
|
|
2895
|
+
construct helper function (such as ``lambda.Code.fromAssetImage()``), this
|
|
2896
|
+
will look like ``MyFunction/AssetImage``.
|
|
2897
|
+
|
|
2898
|
+
We use the stack-relative construct path so that in the common case where
|
|
2899
|
+
you have multiple stacks with the same asset, we won't show something like
|
|
2900
|
+
``/MyBetaStack/MyFunction/Code`` when you are actually deploying to
|
|
2901
|
+
production.
|
|
2902
|
+
|
|
2903
|
+
:default: - Stack-relative construct path
|
|
2904
|
+
'''
|
|
2905
|
+
result = self._values.get("display_name")
|
|
2906
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2907
|
+
|
|
2876
2908
|
@builtins.property
|
|
2877
2909
|
def file(self) -> typing.Optional[builtins.str]:
|
|
2878
2910
|
'''Path to the Dockerfile (relative to the directory).
|
|
@@ -4317,8 +4349,8 @@ class CfnEventInvokeConfig(
|
|
|
4317
4349
|
) -> None:
|
|
4318
4350
|
'''A configuration object that specifies the destination of an event after Lambda processes it.
|
|
4319
4351
|
|
|
4320
|
-
:param on_failure: The destination configuration for failed invocations.
|
|
4321
|
-
:param on_success: The destination configuration for successful invocations.
|
|
4352
|
+
:param on_failure: The destination configuration for failed invocations. .. epigraph:: When using an Amazon SQS queue as a destination, FIFO queues cannot be used.
|
|
4353
|
+
:param on_success: The destination configuration for successful invocations. .. epigraph:: When using an Amazon SQS queue as a destination, FIFO queues cannot be used.
|
|
4322
4354
|
|
|
4323
4355
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html
|
|
4324
4356
|
:exampleMetadata: fixture=_generated
|
|
@@ -4354,6 +4386,10 @@ class CfnEventInvokeConfig(
|
|
|
4354
4386
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventInvokeConfig.OnFailureProperty"]]:
|
|
4355
4387
|
'''The destination configuration for failed invocations.
|
|
4356
4388
|
|
|
4389
|
+
.. epigraph::
|
|
4390
|
+
|
|
4391
|
+
When using an Amazon SQS queue as a destination, FIFO queues cannot be used.
|
|
4392
|
+
|
|
4357
4393
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure
|
|
4358
4394
|
'''
|
|
4359
4395
|
result = self._values.get("on_failure")
|
|
@@ -4365,6 +4401,10 @@ class CfnEventInvokeConfig(
|
|
|
4365
4401
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventInvokeConfig.OnSuccessProperty"]]:
|
|
4366
4402
|
'''The destination configuration for successful invocations.
|
|
4367
4403
|
|
|
4404
|
+
.. epigraph::
|
|
4405
|
+
|
|
4406
|
+
When using an Amazon SQS queue as a destination, FIFO queues cannot be used.
|
|
4407
|
+
|
|
4368
4408
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess
|
|
4369
4409
|
'''
|
|
4370
4410
|
result = self._values.get("on_success")
|
|
@@ -4782,7 +4822,7 @@ class CfnEventSourceMapping(
|
|
|
4782
4822
|
:param function_name: The name or ARN of the Lambda function. **Name formats** - *Function name* – ``MyFunction`` . - *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction`` . - *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`` . - *Partial ARN* – ``123456789012:function:MyFunction`` . The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
|
|
4783
4823
|
:param amazon_managed_kafka_event_source_config: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
|
4784
4824
|
:param batch_size: The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). - *Amazon Kinesis* – Default 100. Max 10,000. - *Amazon DynamoDB Streams* – Default 100. Max 10,000. - *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. - *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000. - *Self-managed Apache Kafka* – Default 100. Max 10,000. - *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. - *DocumentDB* – Default 100. Max 10,000.
|
|
4785
|
-
:param bisect_batch_on_function_error: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
|
|
4825
|
+
:param bisect_batch_on_function_error: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. .. epigraph:: When using ``BisectBatchOnFunctionError`` , check the ``BatchSize`` parameter in the ``OnFailure`` destination message's metadata. The ``BatchSize`` could be greater than 1 since Lambda consolidates failed messages metadata when writing to the ``OnFailure`` destination.
|
|
4786
4826
|
:param destination_config: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
|
|
4787
4827
|
:param document_db_event_source_config: Specific configuration settings for a DocumentDB event source.
|
|
4788
4828
|
:param enabled: When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
|
|
@@ -6221,7 +6261,7 @@ class CfnEventSourceMappingProps:
|
|
|
6221
6261
|
:param function_name: The name or ARN of the Lambda function. **Name formats** - *Function name* – ``MyFunction`` . - *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction`` . - *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`` . - *Partial ARN* – ``123456789012:function:MyFunction`` . The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
|
|
6222
6262
|
:param amazon_managed_kafka_event_source_config: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
|
6223
6263
|
:param batch_size: The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). - *Amazon Kinesis* – Default 100. Max 10,000. - *Amazon DynamoDB Streams* – Default 100. Max 10,000. - *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. - *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000. - *Self-managed Apache Kafka* – Default 100. Max 10,000. - *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. - *DocumentDB* – Default 100. Max 10,000.
|
|
6224
|
-
:param bisect_batch_on_function_error: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
|
|
6264
|
+
:param bisect_batch_on_function_error: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. .. epigraph:: When using ``BisectBatchOnFunctionError`` , check the ``BatchSize`` parameter in the ``OnFailure`` destination message's metadata. The ``BatchSize`` could be greater than 1 since Lambda consolidates failed messages metadata when writing to the ``OnFailure`` destination.
|
|
6225
6265
|
:param destination_config: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
|
|
6226
6266
|
:param document_db_event_source_config: Specific configuration settings for a DocumentDB event source.
|
|
6227
6267
|
:param enabled: When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
|
|
@@ -6460,6 +6500,9 @@ class CfnEventSourceMappingProps:
|
|
|
6460
6500
|
'''(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
|
|
6461
6501
|
|
|
6462
6502
|
The default value is false.
|
|
6503
|
+
.. epigraph::
|
|
6504
|
+
|
|
6505
|
+
When using ``BisectBatchOnFunctionError`` , check the ``BatchSize`` parameter in the ``OnFailure`` destination message's metadata. The ``BatchSize`` could be greater than 1 since Lambda consolidates failed messages metadata when writing to the ``OnFailure`` destination.
|
|
6463
6506
|
|
|
6464
6507
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror
|
|
6465
6508
|
'''
|
|
@@ -11271,6 +11314,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11271
11314
|
path: builtins.str,
|
|
11272
11315
|
*,
|
|
11273
11316
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
11317
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
11274
11318
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
11275
11319
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
11276
11320
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -11284,6 +11328,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11284
11328
|
|
|
11285
11329
|
:param path: Either a directory with the Lambda code bundle or a .zip file.
|
|
11286
11330
|
: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
|
|
11331
|
+
: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
|
|
11287
11332
|
: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.
|
|
11288
11333
|
: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.
|
|
11289
11334
|
: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``
|
|
@@ -11298,6 +11343,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11298
11343
|
check_type(argname="argument path", value=path, expected_type=type_hints["path"])
|
|
11299
11344
|
options = _AssetOptions_2aa69621(
|
|
11300
11345
|
deploy_time=deploy_time,
|
|
11346
|
+
display_name=display_name,
|
|
11301
11347
|
readers=readers,
|
|
11302
11348
|
source_kms_key=source_kms_key,
|
|
11303
11349
|
asset_hash=asset_hash,
|
|
@@ -11326,6 +11372,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11326
11372
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
11327
11373
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11328
11374
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
11375
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
11329
11376
|
file: typing.Optional[builtins.str] = None,
|
|
11330
11377
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
11331
11378
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|
|
@@ -11350,6 +11397,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11350
11397
|
:param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
|
|
11351
11398
|
:param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
|
|
11352
11399
|
:param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
|
|
11400
|
+
: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
|
|
11353
11401
|
:param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
|
|
11354
11402
|
:param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
|
|
11355
11403
|
: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)
|
|
@@ -11375,6 +11423,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11375
11423
|
cache_disabled=cache_disabled,
|
|
11376
11424
|
cache_from=cache_from,
|
|
11377
11425
|
cache_to=cache_to,
|
|
11426
|
+
display_name=display_name,
|
|
11378
11427
|
file=file,
|
|
11379
11428
|
invalidation=invalidation,
|
|
11380
11429
|
network_mode=network_mode,
|
|
@@ -11471,6 +11520,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11471
11520
|
*,
|
|
11472
11521
|
command_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
|
11473
11522
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
11523
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
11474
11524
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
11475
11525
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
11476
11526
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -11486,6 +11536,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11486
11536
|
:param command: The command which will be executed to generate the output, for example, [ 'node', 'bundle_code.js' ].
|
|
11487
11537
|
:param command_options: options that are passed to the spawned process, which determine the characteristics of the spawned process. Default: : see ``child_process.SpawnSyncOptions`` (https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options).
|
|
11488
11538
|
: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
|
|
11539
|
+
: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
|
|
11489
11540
|
: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.
|
|
11490
11541
|
: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.
|
|
11491
11542
|
: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``
|
|
@@ -11502,6 +11553,7 @@ class Code(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.aws_lambda.C
|
|
|
11502
11553
|
options = CustomCommandOptions(
|
|
11503
11554
|
command_options=command_options,
|
|
11504
11555
|
deploy_time=deploy_time,
|
|
11556
|
+
display_name=display_name,
|
|
11505
11557
|
readers=readers,
|
|
11506
11558
|
source_kms_key=source_kms_key,
|
|
11507
11559
|
asset_hash=asset_hash,
|
|
@@ -12012,6 +12064,7 @@ class CodeSigningConfigProps:
|
|
|
12012
12064
|
"follow_symlinks": "followSymlinks",
|
|
12013
12065
|
"ignore_mode": "ignoreMode",
|
|
12014
12066
|
"deploy_time": "deployTime",
|
|
12067
|
+
"display_name": "displayName",
|
|
12015
12068
|
"readers": "readers",
|
|
12016
12069
|
"source_kms_key": "sourceKMSKey",
|
|
12017
12070
|
"command_options": "commandOptions",
|
|
@@ -12028,6 +12081,7 @@ class CustomCommandOptions(_AssetOptions_2aa69621):
|
|
|
12028
12081
|
follow_symlinks: typing.Optional[_SymlinkFollowMode_047ec1f6] = None,
|
|
12029
12082
|
ignore_mode: typing.Optional[_IgnoreMode_655a98e8] = None,
|
|
12030
12083
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
12084
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
12031
12085
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
12032
12086
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
12033
12087
|
command_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
|
@@ -12041,6 +12095,7 @@ class CustomCommandOptions(_AssetOptions_2aa69621):
|
|
|
12041
12095
|
:param follow_symlinks: A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
|
|
12042
12096
|
:param ignore_mode: The ignore behavior to use for ``exclude`` patterns. Default: IgnoreMode.GLOB
|
|
12043
12097
|
: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
|
|
12098
|
+
: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
|
|
12044
12099
|
: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.
|
|
12045
12100
|
: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.
|
|
12046
12101
|
:param command_options: options that are passed to the spawned process, which determine the characteristics of the spawned process. Default: : see ``child_process.SpawnSyncOptions`` (https://nodejs.org/api/child_process.html#child_processspawnsynccommand-args-options).
|
|
@@ -12095,6 +12150,7 @@ class CustomCommandOptions(_AssetOptions_2aa69621):
|
|
|
12095
12150
|
"command_options_key": command_options
|
|
12096
12151
|
},
|
|
12097
12152
|
deploy_time=False,
|
|
12153
|
+
display_name="displayName",
|
|
12098
12154
|
exclude=["exclude"],
|
|
12099
12155
|
follow_symlinks=cdk.SymlinkFollowMode.NEVER,
|
|
12100
12156
|
ignore_mode=cdk.IgnoreMode.GLOB,
|
|
@@ -12113,6 +12169,7 @@ class CustomCommandOptions(_AssetOptions_2aa69621):
|
|
|
12113
12169
|
check_type(argname="argument follow_symlinks", value=follow_symlinks, expected_type=type_hints["follow_symlinks"])
|
|
12114
12170
|
check_type(argname="argument ignore_mode", value=ignore_mode, expected_type=type_hints["ignore_mode"])
|
|
12115
12171
|
check_type(argname="argument deploy_time", value=deploy_time, expected_type=type_hints["deploy_time"])
|
|
12172
|
+
check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
|
|
12116
12173
|
check_type(argname="argument readers", value=readers, expected_type=type_hints["readers"])
|
|
12117
12174
|
check_type(argname="argument source_kms_key", value=source_kms_key, expected_type=type_hints["source_kms_key"])
|
|
12118
12175
|
check_type(argname="argument command_options", value=command_options, expected_type=type_hints["command_options"])
|
|
@@ -12131,6 +12188,8 @@ class CustomCommandOptions(_AssetOptions_2aa69621):
|
|
|
12131
12188
|
self._values["ignore_mode"] = ignore_mode
|
|
12132
12189
|
if deploy_time is not None:
|
|
12133
12190
|
self._values["deploy_time"] = deploy_time
|
|
12191
|
+
if display_name is not None:
|
|
12192
|
+
self._values["display_name"] = display_name
|
|
12134
12193
|
if readers is not None:
|
|
12135
12194
|
self._values["readers"] = readers
|
|
12136
12195
|
if source_kms_key is not None:
|
|
@@ -12239,6 +12298,30 @@ class CustomCommandOptions(_AssetOptions_2aa69621):
|
|
|
12239
12298
|
result = self._values.get("deploy_time")
|
|
12240
12299
|
return typing.cast(typing.Optional[builtins.bool], result)
|
|
12241
12300
|
|
|
12301
|
+
@builtins.property
|
|
12302
|
+
def display_name(self) -> typing.Optional[builtins.str]:
|
|
12303
|
+
'''A display name for this asset.
|
|
12304
|
+
|
|
12305
|
+
If supplied, the display name will be used in locations where the asset
|
|
12306
|
+
identifier is printed, like in the CLI progress information. If the same
|
|
12307
|
+
asset is added multiple times, the display name of the first occurrence is
|
|
12308
|
+
used.
|
|
12309
|
+
|
|
12310
|
+
The default is the construct path of the Asset construct, with respect to
|
|
12311
|
+
the enclosing stack. If the asset is produced by a construct helper
|
|
12312
|
+
function (such as ``lambda.Code.fromAsset()``), this will look like
|
|
12313
|
+
``MyFunction/Code``.
|
|
12314
|
+
|
|
12315
|
+
We use the stack-relative construct path so that in the common case where
|
|
12316
|
+
you have multiple stacks with the same asset, we won't show something like
|
|
12317
|
+
``/MyBetaStack/MyFunction/Code`` when you are actually deploying to
|
|
12318
|
+
production.
|
|
12319
|
+
|
|
12320
|
+
:default: - Stack-relative construct path
|
|
12321
|
+
'''
|
|
12322
|
+
result = self._values.get("display_name")
|
|
12323
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
12324
|
+
|
|
12242
12325
|
@builtins.property
|
|
12243
12326
|
def readers(self) -> typing.Optional[typing.List[_IGrantable_71c4f5de]]:
|
|
12244
12327
|
'''A list of principals that should be able to read this asset from S3.
|
|
@@ -12714,6 +12797,7 @@ class DockerImageCode(
|
|
|
12714
12797
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
12715
12798
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
12716
12799
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
12800
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
12717
12801
|
file: typing.Optional[builtins.str] = None,
|
|
12718
12802
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
12719
12803
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|
|
@@ -12738,6 +12822,7 @@ class DockerImageCode(
|
|
|
12738
12822
|
:param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
|
|
12739
12823
|
:param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
|
|
12740
12824
|
:param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
|
|
12825
|
+
: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
|
|
12741
12826
|
:param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
|
|
12742
12827
|
:param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
|
|
12743
12828
|
: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)
|
|
@@ -12763,6 +12848,7 @@ class DockerImageCode(
|
|
|
12763
12848
|
cache_disabled=cache_disabled,
|
|
12764
12849
|
cache_from=cache_from,
|
|
12765
12850
|
cache_to=cache_to,
|
|
12851
|
+
display_name=display_name,
|
|
12766
12852
|
file=file,
|
|
12767
12853
|
invalidation=invalidation,
|
|
12768
12854
|
network_mode=network_mode,
|
|
@@ -24221,6 +24307,7 @@ class AssetCode(
|
|
|
24221
24307
|
path: builtins.str,
|
|
24222
24308
|
*,
|
|
24223
24309
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
24310
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
24224
24311
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
24225
24312
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
24226
24313
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -24233,6 +24320,7 @@ class AssetCode(
|
|
|
24233
24320
|
'''
|
|
24234
24321
|
:param path: The path to the asset file or directory.
|
|
24235
24322
|
: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
|
|
24323
|
+
: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
|
|
24236
24324
|
: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.
|
|
24237
24325
|
: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.
|
|
24238
24326
|
: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``
|
|
@@ -24247,6 +24335,7 @@ class AssetCode(
|
|
|
24247
24335
|
check_type(argname="argument path", value=path, expected_type=type_hints["path"])
|
|
24248
24336
|
options = _AssetOptions_2aa69621(
|
|
24249
24337
|
deploy_time=deploy_time,
|
|
24338
|
+
display_name=display_name,
|
|
24250
24339
|
readers=readers,
|
|
24251
24340
|
source_kms_key=source_kms_key,
|
|
24252
24341
|
asset_hash=asset_hash,
|
|
@@ -24352,6 +24441,7 @@ class AssetImageCode(
|
|
|
24352
24441
|
}
|
|
24353
24442
|
),
|
|
24354
24443
|
cmd=["cmd"],
|
|
24444
|
+
display_name="displayName",
|
|
24355
24445
|
entrypoint=["entrypoint"],
|
|
24356
24446
|
exclude=["exclude"],
|
|
24357
24447
|
extra_hash="extraHash",
|
|
@@ -24392,6 +24482,7 @@ class AssetImageCode(
|
|
|
24392
24482
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
24393
24483
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
24394
24484
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24485
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
24395
24486
|
file: typing.Optional[builtins.str] = None,
|
|
24396
24487
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
24397
24488
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|
|
@@ -24415,6 +24506,7 @@ class AssetImageCode(
|
|
|
24415
24506
|
:param cache_disabled: Disable the cache and pass ``--no-cache`` to the ``docker build`` command. Default: - cache is used
|
|
24416
24507
|
:param cache_from: Cache from options to pass to the ``docker build`` command. Default: - no cache from options are passed to the build command
|
|
24417
24508
|
:param cache_to: Cache to options to pass to the ``docker build`` command. Default: - no cache to options are passed to the build command
|
|
24509
|
+
: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
|
|
24418
24510
|
:param file: Path to the Dockerfile (relative to the directory). Default: 'Dockerfile'
|
|
24419
24511
|
:param invalidation: Options to control which parameters are used to invalidate the asset hash. Default: - hash all parameters
|
|
24420
24512
|
: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)
|
|
@@ -24440,6 +24532,7 @@ class AssetImageCode(
|
|
|
24440
24532
|
cache_disabled=cache_disabled,
|
|
24441
24533
|
cache_from=cache_from,
|
|
24442
24534
|
cache_to=cache_to,
|
|
24535
|
+
display_name=display_name,
|
|
24443
24536
|
file=file,
|
|
24444
24537
|
invalidation=invalidation,
|
|
24445
24538
|
network_mode=network_mode,
|
|
@@ -29256,6 +29349,7 @@ def _typecheckingstub__ec4c3fb249340fe6042f51bdb6d1686308ab9ec697f2f453cba22fd22
|
|
|
29256
29349
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
29257
29350
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
29258
29351
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
29352
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
29259
29353
|
file: typing.Optional[builtins.str] = None,
|
|
29260
29354
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
29261
29355
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|
|
@@ -30622,6 +30716,7 @@ def _typecheckingstub__f040a1ba6e87fe9c9a6496be4b8fbf73f2646b80291bfc4d04979d6ef
|
|
|
30622
30716
|
path: builtins.str,
|
|
30623
30717
|
*,
|
|
30624
30718
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
30719
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
30625
30720
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
30626
30721
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
30627
30722
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -30647,6 +30742,7 @@ def _typecheckingstub__29667a5c639f33aff38b1cbeda0e1db7f1f0c3d3bdb2b53ad01390675
|
|
|
30647
30742
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
30648
30743
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
30649
30744
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
30745
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
30650
30746
|
file: typing.Optional[builtins.str] = None,
|
|
30651
30747
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
30652
30748
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|
|
@@ -30685,6 +30781,7 @@ def _typecheckingstub__f107aedaa96b9385600e34088d5cda9d8035f15776c846b0f0b4fbbe3
|
|
|
30685
30781
|
*,
|
|
30686
30782
|
command_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
|
30687
30783
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
30784
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
30688
30785
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
30689
30786
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
30690
30787
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -30783,6 +30880,7 @@ def _typecheckingstub__69255a578358e8a47662200dda7ce2e0b1f2ee573c1469268f14060b0
|
|
|
30783
30880
|
follow_symlinks: typing.Optional[_SymlinkFollowMode_047ec1f6] = None,
|
|
30784
30881
|
ignore_mode: typing.Optional[_IgnoreMode_655a98e8] = None,
|
|
30785
30882
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
30883
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
30786
30884
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
30787
30885
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
30788
30886
|
command_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
|
@@ -30851,6 +30949,7 @@ def _typecheckingstub__5da1bfa983f51013181a622617f984d1361ab84bd63c101a85256915a
|
|
|
30851
30949
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
30852
30950
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
30853
30951
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
30952
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
30854
30953
|
file: typing.Optional[builtins.str] = None,
|
|
30855
30954
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
30856
30955
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|
|
@@ -31814,6 +31913,7 @@ def _typecheckingstub__2f05314dba16cc49614c6f64783d2cd85683aeb754a1d8b045caf7c7f
|
|
|
31814
31913
|
path: builtins.str,
|
|
31815
31914
|
*,
|
|
31816
31915
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
31916
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
31817
31917
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
31818
31918
|
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
31819
31919
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
@@ -31853,6 +31953,7 @@ def _typecheckingstub__f392d9975bf498bea251d43db219ae1f5fe780a3bf9fff81576e4b6f9
|
|
|
31853
31953
|
cache_disabled: typing.Optional[builtins.bool] = None,
|
|
31854
31954
|
cache_from: typing.Optional[typing.Sequence[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
31855
31955
|
cache_to: typing.Optional[typing.Union[_DockerCacheOption_58ef18ca, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
31956
|
+
display_name: typing.Optional[builtins.str] = None,
|
|
31856
31957
|
file: typing.Optional[builtins.str] = None,
|
|
31857
31958
|
invalidation: typing.Optional[typing.Union[_DockerImageAssetInvalidationOptions_4deb8d45, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
31858
31959
|
network_mode: typing.Optional[_NetworkMode_897e5081] = None,
|