aws-cdk-lib 2.150.0__py3-none-any.whl → 2.151.0__py3-none-any.whl

aws_cdk/aws_s3/__init__.py

@@ -4014,7 +4014,7 @@ class CfnBucket(
         :param public_access_block_configuration: Configuration that defines how Amazon S3 handles public access.
         :param replication_configuration: Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
         :param tags: An arbitrary set of tags (key-value pairs) for this S3 bucket.
-        :param versioning_configuration: Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
+        :param versioning_configuration: Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. .. epigraph:: When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations ( ``PUT`` or ``DELETE`` ) on objects in the bucket.
         :param website_configuration: Information used to configure the bucket as a static website. For more information, see `Hosting Websites on Amazon S3 <https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html>`_ .
         '''
         if __debug__:
@@ -10049,6 +10049,9 @@ class CfnBucket(
             '''Describes the versioning state of an Amazon S3 bucket.
 
             For more information, see `PUT Bucket versioning <https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html>`_ in the *Amazon S3 API Reference* .
+            .. epigraph::
+
+               When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations ( ``PUT`` or ``DELETE`` ) on objects in the bucket.
 
             :param status: The versioning state of the bucket. Default: - "Suspended"
 
@@ -10494,7 +10497,7 @@ class CfnBucketProps:
         :param public_access_block_configuration: Configuration that defines how Amazon S3 handles public access.
         :param replication_configuration: Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.
         :param tags: An arbitrary set of tags (key-value pairs) for this S3 bucket.
-        :param versioning_configuration: Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
+        :param versioning_configuration: Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. .. epigraph:: When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations ( ``PUT`` or ``DELETE`` ) on objects in the bucket.
         :param website_configuration: Information used to configure the bucket as a static website. For more information, see `Hosting Websites on Amazon S3 <https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html>`_ .
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html
@@ -10817,6 +10820,9 @@ class CfnBucketProps:
         '''Enables multiple versions of all objects in this bucket.
 
         You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
+        .. epigraph::
+
+           When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations ( ``PUT`` or ``DELETE`` ) on objects in the bucket.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html#cfn-s3-bucket-versioningconfiguration
         '''

aws_cdk/aws_ses/__init__.py

@@ -6759,7 +6759,7 @@ class ConfigurationSetProps:
         :param configuration_set_name: A name for the configuration set. Default: - a CloudFormation generated name
         :param custom_tracking_redirect_domain: The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. Default: - use the default awstrack.me domain
         :param dedicated_ip_pool: The dedicated IP pool to associate with the configuration set. Default: - do not use a dedicated IP pool
-        :param reputation_metrics: Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: false
+        :param reputation_metrics: Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: true
         :param sending_enabled: Whether email sending is enabled. Default: true
         :param suppression_reasons: The reasons for which recipient email addresses should be automatically added to your account's suppression list. Default: - use account level settings
         :param tls_policy: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Default: ConfigurationSetTlsPolicy.OPTIONAL
@@ -6840,7 +6840,7 @@ class ConfigurationSetProps:
     def reputation_metrics(self) -> typing.Optional[builtins.bool]:
         '''Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
 
-        :default: false
+        :default: true
         '''
         result = self._values.get("reputation_metrics")
         return typing.cast(typing.Optional[builtins.bool], result)
@@ -9912,7 +9912,7 @@ class ConfigurationSet(
         :param configuration_set_name: A name for the configuration set. Default: - a CloudFormation generated name
         :param custom_tracking_redirect_domain: The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. Default: - use the default awstrack.me domain
         :param dedicated_ip_pool: The dedicated IP pool to associate with the configuration set. Default: - do not use a dedicated IP pool
-        :param reputation_metrics: Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: false
+        :param reputation_metrics: Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: true
         :param sending_enabled: Whether email sending is enabled. Default: true
         :param suppression_reasons: The reasons for which recipient email addresses should be automatically added to your account's suppression list. Default: - use account level settings
         :param tls_policy: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Default: ConfigurationSetTlsPolicy.OPTIONAL

aws_cdk/aws_sns/__init__.py

@@ -5248,7 +5248,7 @@ class TopicProps:
         '''Properties for a new SNS topic.
 
         :param content_based_deduplication: Enables content-based deduplication for FIFO topics. Default: None
-        :param display_name: A developer-defined string that can be used to identify this SNS topic. Default: None
+        :param display_name: A developer-defined string that can be used to identify this SNS topic. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. Default: None
         :param enforce_ssl: Adds a statement to enforce encryption of data in transit when publishing to the topic. Default: false
         :param fifo: Set to true to create a FIFO topic. Default: None
         :param logging_configs: The list of delivery status logging configurations for the topic. Default: None
@@ -5313,6 +5313,9 @@ class TopicProps:
     def display_name(self) -> typing.Optional[builtins.str]:
         '''A developer-defined string that can be used to identify this SNS topic.
 
+        The display name must be maximum 100 characters long, including hyphens (-),
+        underscores (_), spaces, and tabs.
+
         :default: None
         '''
         result = self._values.get("display_name")
@@ -5780,7 +5783,7 @@ class Topic(TopicBase, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_sns.T
         :param scope: -
         :param id: -
         :param content_based_deduplication: Enables content-based deduplication for FIFO topics. Default: None
-        :param display_name: A developer-defined string that can be used to identify this SNS topic. Default: None
+        :param display_name: A developer-defined string that can be used to identify this SNS topic. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. Default: None
         :param enforce_ssl: Adds a statement to enforce encryption of data in transit when publishing to the topic. Default: false
         :param fifo: Set to true to create a FIFO topic. Default: None
         :param logging_configs: The list of delivery status logging configurations for the topic. Default: None

aws_cdk/aws_stepfunctions/__init__.py

@@ -2649,7 +2649,7 @@ class CfnStateMachineAlias(
 
             :param state_machine_version_arn: The Amazon Resource Name (ARN) of the ```AWS::StepFunctions::StateMachineVersion`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachineversion.html>`_ resource that will be the final version to which the alias points to when the traffic shifting is complete. While performing gradual deployments, you can only provide a single state machine version ARN. To explicitly set version weights in a CloudFormation template, use ``RoutingConfiguration`` instead.
             :param type: The type of deployment you want to perform. You can specify one of the following types:. - ``LINEAR`` - Shifts traffic to the new version in equal increments with an equal number of minutes between each increment. For example, if you specify the increment percent as ``20`` with an interval of ``600`` minutes, this deployment increases traffic by 20 percent every 600 minutes until the new version receives 100 percent of the traffic. This deployment immediately rolls back the new version if any CloudWatch alarms are triggered. - ``ALL_AT_ONCE`` - Shifts 100 percent of traffic to the new version immediately. CloudFormation monitors the new version and rolls it back automatically to the previous version if any CloudWatch alarms are triggered. - ``CANARY`` - Shifts traffic in two increments. In the first increment, a small percentage of traffic, for example, 10 percent is shifted to the new version. In the second increment, before a specified time interval in seconds gets over, the remaining traffic is shifted to the new version. The shift to the new version for the remaining traffic takes place only if no CloudWatch alarms are triggered during the specified time interval.
-            :param alarms: A list of Amazon CloudWatch alarms to be monitored during the deployment. The deployment fails and rolls back if any of these alarms go into the ``ALARM`` state.
+            :param alarms: A list of Amazon CloudWatch alarm names to be monitored during the deployment. The deployment fails and rolls back if any of these alarms go into the ``ALARM`` state. .. epigraph:: Amazon CloudWatch considers nonexistent alarms to have an ``OK`` state. If you provide an invalid alarm name or provide the ARN of an alarm instead of its name, your deployment may not roll back correctly.
             :param interval: The time in minutes between each traffic shifting increment.
             :param percentage: The percentage of traffic to shift to the new version in each increment.
 
@@ -2723,9 +2723,12 @@ class CfnStateMachineAlias(
 
         @builtins.property
         def alarms(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''A list of Amazon CloudWatch alarms to be monitored during the deployment.
+            '''A list of Amazon CloudWatch alarm names to be monitored during the deployment.
 
             The deployment fails and rolls back if any of these alarms go into the ``ALARM`` state.
+            .. epigraph::
+
+               Amazon CloudWatch considers nonexistent alarms to have an ``OK`` state. If you provide an invalid alarm name or provide the ARN of an alarm instead of its name, your deployment may not roll back correctly.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-alarms
             '''

aws_cdk/aws_stepfunctions_tasks/__init__.py

@@ -420,6 +420,23 @@ task = tasks.BedrockInvokeModel(self, "Prompt Model",
 )
 ```
 
+### Using Input Path
+
+Provide S3 URI as an input or output path to invoke a model
+
+```python
+import aws_cdk.aws_bedrock as bedrock
+
+
+model = bedrock.FoundationModel.from_foundation_model_id(self, "Model", bedrock.FoundationModelIdentifier.AMAZON_TITAN_TEXT_G1_EXPRESS_V1)
+
+task = tasks.BedrockInvokeModel(self, "Prompt Model",
+    model=model,
+    input_path=sfn.JsonPath.string_at("$.prompt"),
+    output_path=sfn.JsonPath.string_at("$.prompt")
+)
+```
+
 You can apply a guardrail to the invocation by setting `guardrail`.
 
 ```python

aws_cdk/aws_synthetics/__init__.py

@@ -88,6 +88,64 @@ schedule = synthetics.Schedule.cron(
 
 If you want the canary to run just once upon deployment, you can use `Schedule.once()`.
 
+### Active Tracing
+
+You can choose to enable active AWS X-Ray tracing on canaries that use the `syn-nodejs-2.0` or later runtime by setting `activeTracing` to `true`.
+
+With tracing enabled, traces are sent for all calls made by the canary that use the browser, the AWS SDK, or HTTP or HTTPS modules.
+
+For more information, see [Canaries and X-Ray tracing](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html).
+
+```python
+canary = synthetics.Canary(self, "MyCanary",
+    schedule=synthetics.Schedule.rate(Duration.minutes(5)),
+    test=synthetics.Test.custom(
+        code=synthetics.Code.from_asset(path.join(__dirname, "canary")),
+        handler="index.handler"
+    ),
+    runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
+    active_tracing=True
+)
+```
+
+### Memory
+
+You can set the maximum amount of memory the canary can use while running with the `memory` property.
+
+```python
+import aws_cdk as cdk
+
+
+canary = synthetics.Canary(self, "MyCanary",
+    schedule=synthetics.Schedule.rate(Duration.minutes(5)),
+    test=synthetics.Test.custom(
+        code=synthetics.Code.from_asset(path.join(__dirname, "canary")),
+        handler="index.handler"
+    ),
+    runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
+    memory=cdk.Size.mebibytes(1024)
+)
+```
+
+### Timeout
+
+You can set how long the canary is allowed to run before it must stop with the `timeout` property.
+
+```python
+import aws_cdk as cdk
+
+
+canary = synthetics.Canary(self, "MyCanary",
+    schedule=synthetics.Schedule.rate(Duration.minutes(5)),
+    test=synthetics.Test.custom(
+        code=synthetics.Code.from_asset(path.join(__dirname, "canary")),
+        handler="index.handler"
+    ),
+    runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
+    timeout=cdk.Duration.seconds(60)
+)
+```
+
 ### Deleting underlying resources on canary deletion
 
 When you delete a lambda, the following underlying resources are isolated in your AWS account:
@@ -279,6 +337,7 @@ from .. import (
     ITaggable as _ITaggable_36806126,
     IgnoreMode as _IgnoreMode_655a98e8,
     Resource as _Resource_45bc6135,
+    Size as _Size_7b441c34,
     SymlinkFollowMode as _SymlinkFollowMode_047ec1f6,
     TagManager as _TagManager_0a598cb3,
     TreeInspector as _TreeInspector_488e0dd5,
@@ -394,6 +453,9 @@ class Canary(
 
     Example::
 
+        import aws_cdk as cdk
+        
+        
         canary = synthetics.Canary(self, "MyCanary",
             schedule=synthetics.Schedule.rate(Duration.minutes(5)),
             test=synthetics.Test.custom(
@@ -401,9 +463,7 @@ class Canary(
                 handler="index.handler"
             ),
             runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
-            environment_variables={
-                "stage": "prod"
-            }
+            memory=cdk.Size.mebibytes(1024)
         )
     '''
 
@@ -414,17 +474,20 @@ class Canary(
         *,
         runtime: "Runtime",
         test: "Test",
+        active_tracing: typing.Optional[builtins.bool] = None,
         artifacts_bucket_lifecycle_rules: typing.Optional[typing.Sequence[typing.Union[_LifecycleRule_bb74e6ff, typing.Dict[builtins.str, typing.Any]]]] = None,
         artifacts_bucket_location: typing.Optional[typing.Union[ArtifactsBucketLocation, typing.Dict[builtins.str, typing.Any]]] = None,
         canary_name: typing.Optional[builtins.str] = None,
         cleanup: typing.Optional["Cleanup"] = None,
         environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+        memory: typing.Optional[_Size_7b441c34] = None,
         role: typing.Optional[_IRole_235f5d8e] = None,
         schedule: typing.Optional["Schedule"] = None,
         security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
         start_after_creation: typing.Optional[builtins.bool] = None,
         success_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+        timeout: typing.Optional[_Duration_4839e8c3] = None,
         time_to_live: typing.Optional[_Duration_4839e8c3] = None,
         vpc: typing.Optional[_IVpc_f30d5663] = None,
         vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,
@@ -434,17 +497,20 @@ class Canary(
         :param id: -
         :param runtime: Specify the runtime version to use for the canary.
         :param test: The type of test that you want your canary to run. Use ``Test.custom()`` to specify the test to run.
+        :param active_tracing: Specifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. You can enable active tracing only for canaries that use version ``syn-nodejs-2.0`` or later for their canary runtime. Default: false
         :param artifacts_bucket_lifecycle_rules: Lifecycle rules for the generated canary artifact bucket. Has no effect if a bucket is passed to ``artifactsBucketLocation``. If you pass a bucket to ``artifactsBucketLocation``, you can add lifecycle rules to the bucket itself. Default: - no rules applied to the generated bucket.
         :param artifacts_bucket_location: The s3 location that stores the data of the canary runs. Default: - A new s3 bucket will be created without a prefix.
         :param canary_name: The name of the canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet. Default: - A unique name will be generated from the construct ID
         :param cleanup: Specify the underlying resources to be cleaned up when the canary is deleted. Using ``Cleanup.LAMBDA`` will create a Custom Resource to achieve this. Default: Cleanup.NOTHING
         :param environment_variables: Key-value pairs that the Synthetics caches and makes available for your canary scripts. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Canary script source code. Default: - No environment variables.
         :param failure_retention_period: How many days should failed runs be retained. Default: Duration.days(31)
+        :param memory: The maximum amount of memory that the canary can use while running. This value must be a multiple of 64 Mib. The range is 960 MiB to 3008 MiB. Default: Size.mebibytes(1024)
         :param role: Canary execution role. This is the role that will be assumed by the canary upon execution. It controls the permissions that the canary will have. The role must be assumable by the AWS Lambda service principal. If not supplied, a role will be created with all the required permissions. If you provide a Role, you must add the required permissions. Default: - A unique role will be generated for this canary. You can add permissions to roles by calling 'addToRolePolicy'.
         :param schedule: Specify the schedule for how often the canary runs. For example, if you set ``schedule`` to ``rate(10 minutes)``, then the canary will run every 10 minutes. You can set the schedule with ``Schedule.rate(Duration)`` (recommended) or you can specify an expression using ``Schedule.expression()``. Default: 'rate(5 minutes)'
         :param security_groups: The list of security groups to associate with the canary's network interfaces. You must provide ``vpc`` when using this prop. Default: - If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.
         :param start_after_creation: Whether or not the canary should start after creation. Default: true
         :param success_retention_period: How many days should successful runs be retained. Default: Duration.days(31)
+        :param timeout: How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary. The minimum allowed value is 3 seconds. The maximum allowed value is 840 seconds (14 minutes). Default: - the frequency of the canary is used as this value, up to a maximum of 900 seconds.
         :param time_to_live: How long the canary will be in a 'RUNNING' state. For example, if you set ``timeToLive`` to be 1 hour and ``schedule`` to be ``rate(10 minutes)``, your canary will run at 10 minute intervals for an hour, for a total of 6 times. Default: - no limit
         :param vpc: The VPC where this canary is run. Specify this if the canary needs to access resources in a VPC. Default: - Not in VPC
         :param vpc_subnets: Where to place the network interfaces within the VPC. You must provide ``vpc`` when using this prop. Default: - the Vpc default strategy if not specified
@@ -456,17 +522,20 @@ class Canary(
         props = CanaryProps(
             runtime=runtime,
             test=test,
+            active_tracing=active_tracing,
             artifacts_bucket_lifecycle_rules=artifacts_bucket_lifecycle_rules,
             artifacts_bucket_location=artifacts_bucket_location,
             canary_name=canary_name,
             cleanup=cleanup,
             environment_variables=environment_variables,
             failure_retention_period=failure_retention_period,
+            memory=memory,
             role=role,
             schedule=schedule,
             security_groups=security_groups,
             start_after_creation=start_after_creation,
             success_retention_period=success_retention_period,
+            timeout=timeout,
             time_to_live=time_to_live,
             vpc=vpc,
             vpc_subnets=vpc_subnets,
@@ -648,17 +717,20 @@ class Canary(
     name_mapping={
         "runtime": "runtime",
         "test": "test",
+        "active_tracing": "activeTracing",
         "artifacts_bucket_lifecycle_rules": "artifactsBucketLifecycleRules",
         "artifacts_bucket_location": "artifactsBucketLocation",
         "canary_name": "canaryName",
         "cleanup": "cleanup",
         "environment_variables": "environmentVariables",
         "failure_retention_period": "failureRetentionPeriod",
+        "memory": "memory",
         "role": "role",
         "schedule": "schedule",
         "security_groups": "securityGroups",
         "start_after_creation": "startAfterCreation",
         "success_retention_period": "successRetentionPeriod",
+        "timeout": "timeout",
         "time_to_live": "timeToLive",
         "vpc": "vpc",
         "vpc_subnets": "vpcSubnets",
@@ -670,17 +742,20 @@ class CanaryProps:
         *,
         runtime: "Runtime",
         test: "Test",
+        active_tracing: typing.Optional[builtins.bool] = None,
         artifacts_bucket_lifecycle_rules: typing.Optional[typing.Sequence[typing.Union[_LifecycleRule_bb74e6ff, typing.Dict[builtins.str, typing.Any]]]] = None,
         artifacts_bucket_location: typing.Optional[typing.Union[ArtifactsBucketLocation, typing.Dict[builtins.str, typing.Any]]] = None,
         canary_name: typing.Optional[builtins.str] = None,
         cleanup: typing.Optional["Cleanup"] = None,
         environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+        memory: typing.Optional[_Size_7b441c34] = None,
         role: typing.Optional[_IRole_235f5d8e] = None,
         schedule: typing.Optional["Schedule"] = None,
         security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
         start_after_creation: typing.Optional[builtins.bool] = None,
         success_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+        timeout: typing.Optional[_Duration_4839e8c3] = None,
         time_to_live: typing.Optional[_Duration_4839e8c3] = None,
         vpc: typing.Optional[_IVpc_f30d5663] = None,
         vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,
@@ -689,17 +764,20 @@ class CanaryProps:
 
         :param runtime: Specify the runtime version to use for the canary.
         :param test: The type of test that you want your canary to run. Use ``Test.custom()`` to specify the test to run.
+        :param active_tracing: Specifies whether this canary is to use active AWS X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. You can enable active tracing only for canaries that use version ``syn-nodejs-2.0`` or later for their canary runtime. Default: false
         :param artifacts_bucket_lifecycle_rules: Lifecycle rules for the generated canary artifact bucket. Has no effect if a bucket is passed to ``artifactsBucketLocation``. If you pass a bucket to ``artifactsBucketLocation``, you can add lifecycle rules to the bucket itself. Default: - no rules applied to the generated bucket.
         :param artifacts_bucket_location: The s3 location that stores the data of the canary runs. Default: - A new s3 bucket will be created without a prefix.
         :param canary_name: The name of the canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet. Default: - A unique name will be generated from the construct ID
         :param cleanup: Specify the underlying resources to be cleaned up when the canary is deleted. Using ``Cleanup.LAMBDA`` will create a Custom Resource to achieve this. Default: Cleanup.NOTHING
         :param environment_variables: Key-value pairs that the Synthetics caches and makes available for your canary scripts. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Canary script source code. Default: - No environment variables.
         :param failure_retention_period: How many days should failed runs be retained. Default: Duration.days(31)
+        :param memory: The maximum amount of memory that the canary can use while running. This value must be a multiple of 64 Mib. The range is 960 MiB to 3008 MiB. Default: Size.mebibytes(1024)
         :param role: Canary execution role. This is the role that will be assumed by the canary upon execution. It controls the permissions that the canary will have. The role must be assumable by the AWS Lambda service principal. If not supplied, a role will be created with all the required permissions. If you provide a Role, you must add the required permissions. Default: - A unique role will be generated for this canary. You can add permissions to roles by calling 'addToRolePolicy'.
         :param schedule: Specify the schedule for how often the canary runs. For example, if you set ``schedule`` to ``rate(10 minutes)``, then the canary will run every 10 minutes. You can set the schedule with ``Schedule.rate(Duration)`` (recommended) or you can specify an expression using ``Schedule.expression()``. Default: 'rate(5 minutes)'
         :param security_groups: The list of security groups to associate with the canary's network interfaces. You must provide ``vpc`` when using this prop. Default: - If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.
         :param start_after_creation: Whether or not the canary should start after creation. Default: true
         :param success_retention_period: How many days should successful runs be retained. Default: Duration.days(31)
+        :param timeout: How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary. The minimum allowed value is 3 seconds. The maximum allowed value is 840 seconds (14 minutes). Default: - the frequency of the canary is used as this value, up to a maximum of 900 seconds.
         :param time_to_live: How long the canary will be in a 'RUNNING' state. For example, if you set ``timeToLive`` to be 1 hour and ``schedule`` to be ``rate(10 minutes)``, your canary will run at 10 minute intervals for an hour, for a total of 6 times. Default: - no limit
         :param vpc: The VPC where this canary is run. Specify this if the canary needs to access resources in a VPC. Default: - Not in VPC
         :param vpc_subnets: Where to place the network interfaces within the VPC. You must provide ``vpc`` when using this prop. Default: - the Vpc default strategy if not specified
@@ -708,6 +786,9 @@ class CanaryProps:
 
         Example::
 
+            import aws_cdk as cdk
+            
+            
             canary = synthetics.Canary(self, "MyCanary",
                 schedule=synthetics.Schedule.rate(Duration.minutes(5)),
                 test=synthetics.Test.custom(
@@ -715,9 +796,7 @@ class CanaryProps:
                     handler="index.handler"
                 ),
                 runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
-                environment_variables={
-                    "stage": "prod"
-                }
+                memory=cdk.Size.mebibytes(1024)
             )
         '''
         if isinstance(artifacts_bucket_location, dict):
@@ -728,17 +807,20 @@ class CanaryProps:
             type_hints = typing.get_type_hints(_typecheckingstub__44ec0b14d52b66927d4daebe6f97bb070f3629bb0eb86e21668ca7862bb5f5bd)
             check_type(argname="argument runtime", value=runtime, expected_type=type_hints["runtime"])
             check_type(argname="argument test", value=test, expected_type=type_hints["test"])
+            check_type(argname="argument active_tracing", value=active_tracing, expected_type=type_hints["active_tracing"])
             check_type(argname="argument artifacts_bucket_lifecycle_rules", value=artifacts_bucket_lifecycle_rules, expected_type=type_hints["artifacts_bucket_lifecycle_rules"])
             check_type(argname="argument artifacts_bucket_location", value=artifacts_bucket_location, expected_type=type_hints["artifacts_bucket_location"])
             check_type(argname="argument canary_name", value=canary_name, expected_type=type_hints["canary_name"])
             check_type(argname="argument cleanup", value=cleanup, expected_type=type_hints["cleanup"])
             check_type(argname="argument environment_variables", value=environment_variables, expected_type=type_hints["environment_variables"])
             check_type(argname="argument failure_retention_period", value=failure_retention_period, expected_type=type_hints["failure_retention_period"])
+            check_type(argname="argument memory", value=memory, expected_type=type_hints["memory"])
             check_type(argname="argument role", value=role, expected_type=type_hints["role"])
             check_type(argname="argument schedule", value=schedule, expected_type=type_hints["schedule"])
             check_type(argname="argument security_groups", value=security_groups, expected_type=type_hints["security_groups"])
             check_type(argname="argument start_after_creation", value=start_after_creation, expected_type=type_hints["start_after_creation"])
             check_type(argname="argument success_retention_period", value=success_retention_period, expected_type=type_hints["success_retention_period"])
+            check_type(argname="argument timeout", value=timeout, expected_type=type_hints["timeout"])
             check_type(argname="argument time_to_live", value=time_to_live, expected_type=type_hints["time_to_live"])
             check_type(argname="argument vpc", value=vpc, expected_type=type_hints["vpc"])
             check_type(argname="argument vpc_subnets", value=vpc_subnets, expected_type=type_hints["vpc_subnets"])
@@ -746,6 +828,8 @@ class CanaryProps:
             "runtime": runtime,
             "test": test,
         }
+        if active_tracing is not None:
+            self._values["active_tracing"] = active_tracing
         if artifacts_bucket_lifecycle_rules is not None:
             self._values["artifacts_bucket_lifecycle_rules"] = artifacts_bucket_lifecycle_rules
         if artifacts_bucket_location is not None:
@@ -758,6 +842,8 @@ class CanaryProps:
             self._values["environment_variables"] = environment_variables
         if failure_retention_period is not None:
             self._values["failure_retention_period"] = failure_retention_period
+        if memory is not None:
+            self._values["memory"] = memory
         if role is not None:
             self._values["role"] = role
         if schedule is not None:
@@ -768,6 +854,8 @@ class CanaryProps:
             self._values["start_after_creation"] = start_after_creation
         if success_retention_period is not None:
             self._values["success_retention_period"] = success_retention_period
+        if timeout is not None:
+            self._values["timeout"] = timeout
         if time_to_live is not None:
             self._values["time_to_live"] = time_to_live
         if vpc is not None:
@@ -795,6 +883,22 @@ class CanaryProps:
         assert result is not None, "Required property 'test' is missing"
         return typing.cast("Test", result)
 
+    @builtins.property
+    def active_tracing(self) -> typing.Optional[builtins.bool]:
+        '''Specifies whether this canary is to use active AWS X-Ray tracing when it runs.
+
+        Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the
+        canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges.
+
+        You can enable active tracing only for canaries that use version ``syn-nodejs-2.0`` or later for their canary runtime.
+
+        :default: false
+
+        :see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html
+        '''
+        result = self._values.get("active_tracing")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     @builtins.property
     def artifacts_bucket_lifecycle_rules(
         self,
@@ -872,6 +976,18 @@ class CanaryProps:
         result = self._values.get("failure_retention_period")
         return typing.cast(typing.Optional[_Duration_4839e8c3], result)
 
+    @builtins.property
+    def memory(self) -> typing.Optional[_Size_7b441c34]:
+        '''The maximum amount of memory that the canary can use while running.
+
+        This value must be a multiple of 64 Mib.
+        The range is 960 MiB to 3008 MiB.
+
+        :default: Size.mebibytes(1024)
+        '''
+        result = self._values.get("memory")
+        return typing.cast(typing.Optional[_Size_7b441c34], result)
+
     @builtins.property
     def role(self) -> typing.Optional[_IRole_235f5d8e]:
         '''Canary execution role.
@@ -937,6 +1053,20 @@ class CanaryProps:
         result = self._values.get("success_retention_period")
         return typing.cast(typing.Optional[_Duration_4839e8c3], result)
 
+    @builtins.property
+    def timeout(self) -> typing.Optional[_Duration_4839e8c3]:
+        '''How long the canary is allowed to run before it must stop.
+
+        You can't set this time to be longer than the frequency of the runs of this canary.
+
+        The minimum allowed value is 3 seconds.
+        The maximum allowed value is 840 seconds (14 minutes).
+
+        :default: - the frequency of the canary is used as this value, up to a maximum of 900 seconds.
+        '''
+        result = self._values.get("timeout")
+        return typing.cast(typing.Optional[_Duration_4839e8c3], result)
+
     @builtins.property
     def time_to_live(self) -> typing.Optional[_Duration_4839e8c3]:
         '''How long the canary will be in a 'RUNNING' state.
@@ -2881,6 +3011,9 @@ class Code(
 
     Example::
 
+        import aws_cdk as cdk
+        
+        
         canary = synthetics.Canary(self, "MyCanary",
             schedule=synthetics.Schedule.rate(Duration.minutes(5)),
             test=synthetics.Test.custom(
@@ -2888,9 +3021,7 @@ class Code(
                 handler="index.handler"
             ),
             runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
-            environment_variables={
-                "stage": "prod"
-            }
+            memory=cdk.Size.mebibytes(1024)
         )
     '''
 
@@ -3245,6 +3376,9 @@ class CustomTestOptions:
 
         Example::
 
+            import aws_cdk as cdk
+            
+            
             canary = synthetics.Canary(self, "MyCanary",
                 schedule=synthetics.Schedule.rate(Duration.minutes(5)),
                 test=synthetics.Test.custom(
@@ -3252,9 +3386,7 @@ class CustomTestOptions:
                     handler="index.handler"
                 ),
                 runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
-                environment_variables={
-                    "stage": "prod"
-                }
+                memory=cdk.Size.mebibytes(1024)
             )
         '''
         if __debug__:
@@ -3350,6 +3482,9 @@ class Runtime(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_synthetics.Run
 
     Example::
 
+        import aws_cdk as cdk
+        
+        
         canary = synthetics.Canary(self, "MyCanary",
             schedule=synthetics.Schedule.rate(Duration.minutes(5)),
             test=synthetics.Test.custom(
@@ -3357,9 +3492,7 @@ class Runtime(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_synthetics.Run
                 handler="index.handler"
             ),
             runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
-            environment_variables={
-                "stage": "prod"
-            }
+            memory=cdk.Size.mebibytes(1024)
         )
     '''
 
@@ -3808,9 +3941,7 @@ class Schedule(
                 handler="index.handler"
             ),
             runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
-            environment_variables={
-                "stage": "prod"
-            }
+            active_tracing=True
         )
     '''
 
@@ -3889,6 +4020,9 @@ class Test(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_synthetics.Test")
 
     Example::
 
+        import aws_cdk as cdk
+        
+        
         canary = synthetics.Canary(self, "MyCanary",
             schedule=synthetics.Schedule.rate(Duration.minutes(5)),
             test=synthetics.Test.custom(
@@ -3896,9 +4030,7 @@ class Test(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_synthetics.Test")
                 handler="index.handler"
             ),
             runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2,
-            environment_variables={
-                "stage": "prod"
-            }
+            memory=cdk.Size.mebibytes(1024)
         )
     '''
 
@@ -4086,17 +4218,20 @@ def _typecheckingstub__b3b6d76e5f93e31884e16cc00a9b4fc93e6782ff7db09c74aa1ef9346
     *,
     runtime: Runtime,
     test: Test,
+    active_tracing: typing.Optional[builtins.bool] = None,
     artifacts_bucket_lifecycle_rules: typing.Optional[typing.Sequence[typing.Union[_LifecycleRule_bb74e6ff, typing.Dict[builtins.str, typing.Any]]]] = None,
     artifacts_bucket_location: typing.Optional[typing.Union[ArtifactsBucketLocation, typing.Dict[builtins.str, typing.Any]]] = None,
     canary_name: typing.Optional[builtins.str] = None,
     cleanup: typing.Optional[Cleanup] = None,
     environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+    memory: typing.Optional[_Size_7b441c34] = None,
     role: typing.Optional[_IRole_235f5d8e] = None,
     schedule: typing.Optional[Schedule] = None,
     security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
     start_after_creation: typing.Optional[builtins.bool] = None,
     success_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+    timeout: typing.Optional[_Duration_4839e8c3] = None,
     time_to_live: typing.Optional[_Duration_4839e8c3] = None,
     vpc: typing.Optional[_IVpc_f30d5663] = None,
     vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,
@@ -4108,17 +4243,20 @@ def _typecheckingstub__44ec0b14d52b66927d4daebe6f97bb070f3629bb0eb86e21668ca7862
     *,
     runtime: Runtime,
     test: Test,
+    active_tracing: typing.Optional[builtins.bool] = None,
     artifacts_bucket_lifecycle_rules: typing.Optional[typing.Sequence[typing.Union[_LifecycleRule_bb74e6ff, typing.Dict[builtins.str, typing.Any]]]] = None,
     artifacts_bucket_location: typing.Optional[typing.Union[ArtifactsBucketLocation, typing.Dict[builtins.str, typing.Any]]] = None,
     canary_name: typing.Optional[builtins.str] = None,
     cleanup: typing.Optional[Cleanup] = None,
     environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+    memory: typing.Optional[_Size_7b441c34] = None,
     role: typing.Optional[_IRole_235f5d8e] = None,
     schedule: typing.Optional[Schedule] = None,
     security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
     start_after_creation: typing.Optional[builtins.bool] = None,
     success_retention_period: typing.Optional[_Duration_4839e8c3] = None,
+    timeout: typing.Optional[_Duration_4839e8c3] = None,
     time_to_live: typing.Optional[_Duration_4839e8c3] = None,
     vpc: typing.Optional[_IVpc_f30d5663] = None,
     vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,

{aws_cdk_lib-2.150.0.dist-info → aws_cdk_lib-2.151.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-lib
-Version: 2.150.0
+Version: 2.151.0
 Summary: Version 2 of the AWS Cloud Development Kit library
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services