aws_synthetics: The timeout from the RunConfig was missed so there is no way to change it #28152
Labels
@aws-cdk/aws-synthetics
Related to Amazon CloudWatch Synthetics
effort/medium
Medium work item – several days of effort
feature-request
A feature should be added or improved.
p3
Comments
ignaciolarranaga
added
feature-request
github-actions
bot
added
the
@aws-cdk/aws-synthetics
|
Yes we can expose that in the construct prop and before that we can always use escape hatches to addPropertyOverride on it. |
pahud
added
p2
effort/medium
1 task
mergify bot
pushed a commit
that referenced
this issue
Jul 31, 2024
…anary class (#30556) ### Issue # (if applicable) Closes #9300, #14086, #28152 ### Reason for this change In order to make the properties in the [runConfig](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_synthetics.CfnCanary.RunConfigProperty.html) of the L1 Construct configurable in the L2 Construct. * [activeTracing](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_synthetics.CfnCanary.RunConfigProperty.html#activetracing) * [memoryInMb](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_synthetics.CfnCanary.RunConfigProperty.html#memoryinmb) * [timeoutInSeconds](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_synthetics.CfnCanary.RunConfigProperty.html#timeoutinseconds) At the moment, the L2 [Canary](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_synthetics.Canary.html) Class only supports [environmentVariables](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_synthetics.CfnCanary.RunConfigProperty.html#environmentvariables) in the `runConfig`. ### Description of changes Add missing properties. * `activeTracing` * `memory` * `timeout` Note: The following is stated in #9300, but when tested, it was possible to set only `memoryInMb` (`memory`). > The difficulty is that timeoutInSeconds is required if runConfig is set, so one cannot only specify memoryInMb. Test code is here. ```ts class TestStack extends Stack { constructor(scope: Construct, id: string, props?: StackProps) { super(scope, id, props); new synthetics.Canary(this, 'Canary', { canaryName: 'next', runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_7_0, test: synthetics.Test.custom({ handler: 'index.handler', code: synthetics.Code.fromInline(` exports.handler = async () => { console.log(\'hello world\'); };`), }), cleanup: synthetics.Cleanup.LAMBDA, memory: Size.mebibytes(2048), }); } } ``` ### Description of how you validated changes Add unit tests and integ tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This was referenced Sep 5, 2024
This was referenced Sep 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the feature
Add the timeout, here is the reference:
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html
As you can see here https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_synthetics.Canary.html it is not there.
Use Case
Set the timeout because the canary requires more time to execute
Proposed Solution
No response
Other Information
No response
Acknowledgements
CDK version used
2.110.0
Environment details (OS name and version, etc.)
NA
The text was updated successfully, but these errors were encountered: