{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-cloudwatch": "1.204.0", "@aws-cdk/aws-ec2": "1.204.0", "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-s3": "1.204.0", "@aws-cdk/aws-s3-assets": "1.204.0", "@aws-cdk/core": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets" }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch" }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-ec2": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EC2", "packageId": "Amazon.CDK.AWS.EC2" }, "java": { "maven": { "artifactId": "ec2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ec2" }, "js": { "npm": "@aws-cdk/aws-ec2" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ec2", "module": "aws_cdk.aws_ec2" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events" }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM" }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS" }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-logs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs" }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3" }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3.Assets", "packageId": "Amazon.CDK.AWS.S3.Assets" }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/aws-ssm": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM" }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::Synthetics", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "experimental" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "AWS::Synthetics", "aws-synthetics" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-synthetics", "readme": { "markdown": "# Amazon CloudWatch Synthetics Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nAmazon CloudWatch Synthetics allow you to monitor your application by generating **synthetic** traffic. The traffic is produced by a **canary**: a configurable script that runs on a schedule. You configure the canary script to follow the same routes and perform the same actions as a user, which allows you to continually verify your user experience even when you don't have any traffic on your applications.\n\n## Canary\n\nTo illustrate how to use a canary, assume your application defines the following endpoint:\n\n```console\n% curl \"https://api.example.com/user/books/topbook/\"\nThe Hitchhikers Guide to the Galaxy\n\n```\n\nThe below code defines a canary that will hit the `books/topbook` endpoint every 5 minutes:\n\n```ts\nconst canary = new synthetics.Canary(this, 'MyCanary', {\n schedule: synthetics.Schedule.rate(Duration.minutes(5)),\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,\n environmentVariables: {\n stage: 'prod',\n },\n});\n```\n\nThe following is an example of an `index.js` file which exports the `handler` function:\n\n```js\nconst synthetics = require('Synthetics');\nconst log = require('SyntheticsLogger');\n\nconst pageLoadBlueprint = async function () {\n // Configure the stage of the API using environment variables\n const url = `https://api.example.com/${process.env.stage}/user/books/topbook/`;\n\n const page = await synthetics.getPage();\n const response = await page.goto(url, { waitUntil: 'domcontentloaded', timeout: 30000 });\n // Wait for page to render. Increase or decrease wait time based on endpoint being monitored.\n await page.waitFor(15000);\n // This will take a screenshot that will be included in test output artifacts.\n await synthetics.takeScreenshot('loaded', 'loaded');\n const pageTitle = await page.title();\n log.info('Page title: ' + pageTitle);\n if (response.status() !== 200) {\n throw 'Failed to load page!';\n }\n};\n\nexports.handler = async () => {\n return await pageLoadBlueprint();\n};\n```\n\n> **Note:** The function **must** be called `handler`.\n\nThe canary will automatically produce a CloudWatch Dashboard:\n\n![UI Screenshot](images/ui-screenshot.png)\n\nThe Canary code will be executed in a lambda function created by Synthetics on your behalf. The Lambda function includes a custom [runtime](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) provided by Synthetics. The provided runtime includes a variety of handy tools such as [Puppeteer](https://www.npmjs.com/package/puppeteer-core) (for nodejs based one) and Chromium.\n\nTo learn more about Synthetics capabilities, check out the [docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html).\n\n\n### Canary Schedule\n\nYou can specify the schedule on which a canary runs by providing a\n[`Schedule`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.Schedule.html)\nobject to the `schedule` property.\n\nConfigure a run rate of up to 60 minutes with `Schedule.rate`:\n\n```ts\nconst schedule = synthetics.Schedule.rate(Duration.minutes(5)); // Runs every 5 minutes.\n```\n\nYou can also specify a [cron expression](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) with `Schedule.cron`:\n\n```ts\nconst schedule = synthetics.Schedule.cron({\n hour: '0,8,16', // Run at 12am, 8am, 4pm UTC every day\n});\n```\n\nIf you want the canary to run just once upon deployment, you can use `Schedule.once()`.\n\n### Configuring the Canary Script\n\nTo configure the script the canary executes, use the `test` property. The `test` property accepts a `Test` instance that can be initialized by the `Test` class static methods. Currently, the only implemented method is `Test.custom()`, which allows you to bring your own code. In the future, other methods will be added. `Test.custom()` accepts `code` and `handler` properties -- both are required by Synthetics to create a lambda function on your behalf.\n\nThe `synthetics.Code` class exposes static methods to bundle your code artifacts:\n\n - `code.fromInline(code)` - specify an inline script.\n - `code.fromAsset(path)` - specify a .zip file or a directory in the local filesystem which will be zipped and uploaded to S3 on deployment. See the above Note for directory structure.\n - `code.fromBucket(bucket, key[, objectVersion])` - specify an S3 object that contains the .zip file of your runtime code. See the above Note for directory structure.\n\nUsing the `Code` class static initializers:\n\n```ts\n// To supply the code inline:\nnew synthetics.Canary(this, 'Inline Canary', {\n test: synthetics.Test.custom({\n code: synthetics.Code.fromInline('/* Synthetics handler code */'),\n handler: 'index.handler', // must be 'index.handler'\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_4,\n});\n\n// To supply the code from your local filesystem:\nnew synthetics.Canary(this, 'Asset Canary', {\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler', // must end with '.handler'\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_4,\n});\n\n// To supply the code from a S3 bucket:\nimport * as s3 from '@aws-cdk/aws-s3';\nconst bucket = new s3.Bucket(this, 'Code Bucket');\nnew synthetics.Canary(this, 'Bucket Canary', {\n test: synthetics.Test.custom({\n code: synthetics.Code.fromBucket(bucket, 'canary.zip'),\n handler: 'index.handler', // must end with '.handler'\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_4,\n});\n```\n\n> **Note:** Synthetics have a specified folder structure for canaries. For Node scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:\n>\n> ```plaintext\n> canary/\n> ├── nodejs/\n> ├── node_modules/\n> ├── .js\n> ```\n>\n>\n> For Python scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:\n>\n> ```plaintext\n> canary/\n> ├── python/\n> ├── .py\n> ```\n>\n> See Synthetics [docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html).\n\n### Running a canary on a VPC\n\nYou can specify what [VPC a canary executes in](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).\nThis can allow for monitoring services that may be internal to a specific VPC. To place a canary within a VPC, you can specify the `vpc` property with the desired `VPC` to place then canary in.\nThis will automatically attach the appropriate IAM permissions to attach to the VPC. This will also create a Security Group and attach to the default subnets for the VPC unless specified via `vpcSubnets` and `securityGroups`.\n\n```ts\nimport * as ec2 from '@aws-cdk/aws-ec2';\n\ndeclare const vpc: ec2.IVpc;\nnew synthetics.Canary(this, 'Vpc Canary', {\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_4,\n vpc,\n});\n```\n\n> **Note:** By default, the Synthetics runtime needs access to the S3 and CloudWatch APIs, which will fail in a private subnet without internet access enabled (e.g. an isolated subnnet).\n>\n> Ensure that the Canary is placed in a VPC either with internet connectivity or with VPC Endpoints for S3 and CloudWatch enabled and configured.\n>\n> See [Synthetics VPC docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html).\n\n### Alarms\n\nYou can configure a CloudWatch Alarm on a canary metric. Metrics are emitted by CloudWatch automatically and can be accessed by the following APIs:\n\n- `canary.metricSuccessPercent()` - percentage of successful canary runs over a given time\n- `canary.metricDuration()` - how much time each canary run takes, in seconds.\n- `canary.metricFailed()` - number of failed canary runs over a given time\n\nCreate an alarm that tracks the canary metric:\n\n```ts\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\ndeclare const canary: synthetics.Canary;\nnew cloudwatch.Alarm(this, 'CanaryAlarm', {\n metric: canary.metricSuccessPercent(),\n evaluationPeriods: 2,\n threshold: 90,\n comparisonOperator: cloudwatch.ComparisonOperator.LESS_THAN_THRESHOLD,\n});\n```\n" }, "repository": { "directory": "packages/@aws-cdk/aws-synthetics", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Synthetics", "packageId": "Amazon.CDK.AWS.Synthetics" }, "java": { "maven": { "artifactId": "synthetics", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.synthetics" }, "js": { "npm": "@aws-cdk/aws-synthetics" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-synthetics", "module": "aws_cdk.aws_synthetics" } }, "types": { "@aws-cdk/aws-synthetics.ArtifactsBucketLocation": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "remarks": "The artifacts bucket location **cannot**\nbe updated once the canary is created.", "stability": "experimental", "summary": "Options for specifying the s3 location that stores the data of each canary run.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as s3 from '@aws-cdk/aws-s3';\nimport * as synthetics from '@aws-cdk/aws-synthetics';\n\ndeclare const bucket: s3.Bucket;\nconst artifactsBucketLocation: synthetics.ArtifactsBucketLocation = {\n bucket: bucket,\n\n // the properties below are optional\n prefix: 'prefix',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-synthetics.ArtifactsBucketLocation", "kind": "interface", "locationInModule": { "filename": "lib/canary.ts", "line": 73 }, "name": "ArtifactsBucketLocation", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The s3 location that stores the data of each run." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 77 }, "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "abstract": true, "docs": { "default": "- no prefix", "remarks": "Specify this if you want a more specific path within the artifacts bucket.", "stability": "experimental", "summary": "The S3 bucket prefix." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 84 }, "name": "prefix", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/canary:ArtifactsBucketLocation" }, "@aws-cdk/aws-synthetics.AssetCode": { "assembly": "@aws-cdk/aws-synthetics", "base": "@aws-cdk/aws-synthetics.Code", "docs": { "stability": "experimental", "summary": "Canary code from an Asset.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as assets from '@aws-cdk/assets';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const dockerImage: cdk.DockerImage;\ndeclare const grantable: iam.IGrantable;\ndeclare const localBundling: cdk.ILocalBundling;\nconst assetCode = new synthetics.AssetCode('assetPath', /* all optional props */ {\n assetHash: 'assetHash',\n assetHashType: cdk.AssetHashType.SOURCE,\n bundling: {\n image: dockerImage,\n\n // the properties below are optional\n command: ['command'],\n entrypoint: ['entrypoint'],\n environment: {\n environmentKey: 'environment',\n },\n local: localBundling,\n outputType: cdk.BundlingOutput.ARCHIVED,\n securityOpt: 'securityOpt',\n user: 'user',\n volumes: [{\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n\n // the properties below are optional\n consistency: cdk.DockerVolumeConsistency.CONSISTENT,\n }],\n workingDirectory: 'workingDirectory',\n },\n exclude: ['exclude'],\n follow: assets.FollowMode.NEVER,\n followSymlinks: cdk.SymlinkFollowMode.NEVER,\n ignoreMode: cdk.IgnoreMode.GLOB,\n readers: [grantable],\n sourceHash: 'sourceHash',\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-synthetics.AssetCode", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/code.ts", "line": 91 }, "parameters": [ { "docs": { "summary": "The path to the asset file or directory." }, "name": "assetPath", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3-assets.AssetOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 85 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 99 }, "name": "bind", "overrides": "@aws-cdk/aws-synthetics.Code", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "handler", "type": { "primitive": "string" } }, { "name": "family", "type": { "fqn": "@aws-cdk/aws-synthetics.RuntimeFamily" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.CodeConfig" } } } ], "name": "AssetCode", "symbolId": "lib/code:AssetCode" }, "@aws-cdk/aws-synthetics.Canary": { "assembly": "@aws-cdk/aws-synthetics", "base": "@aws-cdk/core.Resource", "docs": { "stability": "experimental", "summary": "Define a new Canary.", "example": "const canary = new synthetics.Canary(this, 'MyCanary', {\n schedule: synthetics.Schedule.rate(Duration.minutes(5)),\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,\n environmentVariables: {\n stage: 'prod',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.Canary", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/canary.ts", "line": 249 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-synthetics.CanaryProps" } } ] }, "interfaces": [ "@aws-cdk/aws-ec2.IConnectable" ], "kind": "class", "locationInModule": { "filename": "lib/canary.ts", "line": 212 }, "methods": [ { "docs": { "default": "avg over 5 minutes", "stability": "experimental", "summary": "Measure the Duration of a single canary run, in seconds." }, "locationInModule": { "filename": "lib/canary.ts", "line": 311 }, "name": "metricDuration", "parameters": [ { "docs": { "summary": "- configuration options for the metric." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Default: sum over 5 minutes", "stability": "experimental", "summary": "Measure the number of failed canary runs over a given time period." }, "locationInModule": { "filename": "lib/canary.ts", "line": 337 }, "name": "metricFailed", "parameters": [ { "docs": { "summary": "- configuration options for the metric." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "default": "avg over 5 minutes", "stability": "experimental", "summary": "Measure the percentage of successful canary runs." }, "locationInModule": { "filename": "lib/canary.ts", "line": 326 }, "name": "metricSuccessPercent", "parameters": [ { "docs": { "summary": "- configuration options for the metric." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "Canary", "properties": [ { "docs": { "stability": "experimental", "summary": "Bucket where data from each canary run is stored." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 239 }, "name": "artifactsBucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The canary ID." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 222 }, "name": "canaryId", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The canary Name." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 234 }, "name": "canaryName", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "remarks": "For example, 'RUNNING', 'STOPPED', 'NOT STARTED', or 'ERROR'.", "stability": "experimental", "summary": "The state of the canary." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 228 }, "name": "canaryState", "type": { "primitive": "string" } }, { "docs": { "remarks": "Will fail if not a VPC-enabled Canary", "stability": "experimental", "summary": "Access the Connections object." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 296 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "experimental", "summary": "Execution role associated with this Canary." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 216 }, "name": "role", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ], "symbolId": "lib/canary:Canary" }, "@aws-cdk/aws-synthetics.CanaryProps": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for a canary.", "example": "const canary = new synthetics.Canary(this, 'MyCanary', {\n schedule: synthetics.Schedule.rate(Duration.minutes(5)),\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,\n environmentVariables: {\n stage: 'prod',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.CanaryProps", "kind": "interface", "locationInModule": { "filename": "lib/canary.ts", "line": 90 }, "name": "CanaryProps", "properties": [ { "abstract": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html", "stability": "experimental", "summary": "Specify the runtime version to use for the canary." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 168 }, "name": "runtime", "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "abstract": true, "docs": { "remarks": "Use `Test.custom()` to specify the test to run.", "stability": "experimental", "summary": "The type of test that you want your canary to run." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 173 }, "name": "test", "type": { "fqn": "@aws-cdk/aws-synthetics.Test" } }, { "abstract": true, "docs": { "default": "- A new s3 bucket will be created without a prefix.", "stability": "experimental", "summary": "The s3 location that stores the data of the canary runs." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 96 }, "name": "artifactsBucketLocation", "optional": true, "type": { "fqn": "@aws-cdk/aws-synthetics.ArtifactsBucketLocation" } }, { "abstract": true, "docs": { "default": "- A unique name will be generated from the construct ID", "remarks": "Be sure to give it a descriptive name that distinguishes it from\nother canaries in your account.\n\nDo not include secrets or proprietary information in your canary name. The canary name\nmakes up part of the canary ARN, which is included in outbound calls over the internet.", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html", "stability": "experimental", "summary": "The name of the canary." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 161 }, "name": "canaryName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No environment variables.", "remarks": "Use environment variables\nto apply configuration changes, such as test and production environment configurations, without changing your\nCanary script source code.", "stability": "experimental", "summary": "Key-value pairs that the Synthetics caches and makes available for your canary scripts." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 182 }, "name": "environmentVariables", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "Duration.days(31)", "stability": "experimental", "summary": "How many days should failed runs be retained." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 149 }, "name": "failureRetentionPeriod", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- A unique role will be generated for this canary.\nYou can add permissions to roles by calling 'addToRolePolicy'.", "remarks": "This is the role that will be assumed by the canary upon execution.\nIt controls the permissions that the canary will have. The role must\nbe assumable by the AWS Lambda service principal.\n\nIf not supplied, a role will be created with all the required permissions.\nIf you provide a Role, you must add the required permissions.", "see": "required permissions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn", "stability": "experimental", "summary": "Canary execution role." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 113 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "'rate(5 minutes)'", "remarks": "For example, if you set `schedule` to `rate(10 minutes)`, then the canary will run every 10 minutes.\nYou can set the schedule with `Schedule.rate(Duration)` (recommended) or you can specify an expression using `Schedule.expression()`.", "stability": "experimental", "summary": "Specify the schedule for how often the canary runs." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 128 }, "name": "schedule", "optional": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Schedule" } }, { "abstract": true, "docs": { "default": "- If the canary is placed within a VPC and a security group is\nnot specified a dedicated security group will be created for this canary.", "remarks": "You must provide `vpc` when using this prop.", "stability": "experimental", "summary": "The list of security groups to associate with the canary's network interfaces." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 206 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "stability": "experimental", "summary": "Whether or not the canary should start after creation." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 135 }, "name": "startAfterCreation", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "Duration.days(31)", "stability": "experimental", "summary": "How many days should successful runs be retained." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 142 }, "name": "successRetentionPeriod", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- no limit", "remarks": "For example, if you set `timeToLive` to be 1 hour and `schedule` to be `rate(10 minutes)`,\nyour canary will run at 10 minute intervals for an hour, for a total of 6 times.", "stability": "experimental", "summary": "How long the canary will be in a 'RUNNING' state." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 121 }, "name": "timeToLive", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- Not in VPC", "remarks": "Specify this if the canary needs to access resources in a VPC.", "stability": "experimental", "summary": "The VPC where this canary is run." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 191 }, "name": "vpc", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "- the Vpc default strategy if not specified", "remarks": "You must provide `vpc` when using this prop.", "stability": "experimental", "summary": "Where to place the network interfaces within the VPC." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 198 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/canary:CanaryProps" }, "@aws-cdk/aws-synthetics.CfnCanary": { "assembly": "@aws-cdk/aws-synthetics", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Synthetics::Canary", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates or updates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.\n\nTo create canaries, you must have the `CloudWatchSyntheticsFullAccess` policy. If you are creating a new IAM role for the canary, you also need the the `iam:CreateRole` , `iam:CreatePolicy` and `iam:AttachRolePolicy` permissions. For more information, see [Necessary Roles and Permissions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles) .\n\nDo not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see [Security Considerations for Synthetics Canaries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html) .", "stability": "external", "summary": "A CloudFormation `AWS::Synthetics::Canary`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst cfnCanary = new synthetics.CfnCanary(this, 'MyCfnCanary', {\n artifactS3Location: 'artifactS3Location',\n code: {\n handler: 'handler',\n\n // the properties below are optional\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n s3ObjectVersion: 's3ObjectVersion',\n script: 'script',\n sourceLocationArn: 'sourceLocationArn',\n },\n executionRoleArn: 'executionRoleArn',\n name: 'name',\n runtimeVersion: 'runtimeVersion',\n schedule: {\n expression: 'expression',\n\n // the properties below are optional\n durationInSeconds: 'durationInSeconds',\n },\n\n // the properties below are optional\n artifactConfig: {\n s3Encryption: {\n encryptionMode: 'encryptionMode',\n kmsKeyArn: 'kmsKeyArn',\n },\n },\n deleteLambdaResourcesOnCanaryDeletion: false,\n failureRetentionPeriod: 123,\n runConfig: {\n activeTracing: false,\n environmentVariables: {\n environmentVariablesKey: 'environmentVariables',\n },\n memoryInMb: 123,\n timeoutInSeconds: 123,\n },\n startCanaryAfterCreation: false,\n successRetentionPeriod: 123,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n visualReference: {\n baseCanaryRunId: 'baseCanaryRunId',\n\n // the properties below are optional\n baseScreenshots: [{\n screenshotName: 'screenshotName',\n\n // the properties below are optional\n ignoreCoordinates: ['ignoreCoordinates'],\n }],\n },\n vpcConfig: {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n\n // the properties below are optional\n vpcId: 'vpcId',\n },\n});" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Synthetics::Canary`." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 413 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-synthetics.CfnCanaryProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 246 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 448 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 473 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnCanary", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 250 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Code.SourceLocationArn" }, "stability": "external", "summary": "`Ref` returns the ARN of the Lambda layer where Synthetics stores the canary script code." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 275 }, "name": "attrCodeSourceLocationArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The ID of the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 281 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "State" }, "remarks": "For example, `RUNNING` .", "stability": "external", "summary": "The state of the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 287 }, "name": "attrState", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 453 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-tags" }, "stability": "external", "summary": "The list of key-value pairs that are associated with the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 390 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifacts3location" }, "remarks": "Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including `s3://` at the beginning of the path.", "stability": "external", "summary": "The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 294 }, "name": "artifactS3Location", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-code" }, "remarks": "This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of `Script` .", "stability": "external", "summary": "Use this structure to input your script code for the canary." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 301 }, "name": "code", "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.CodeProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn" }, "remarks": "This role must already exist, and must include `lambda.amazonaws.com` as a principal in the trust policy. The role must also have the following permissions:\n\n- `s3:PutObject`\n- `s3:GetBucketLocation`\n- `s3:ListAllMyBuckets`\n- `cloudwatch:PutMetricData`\n- `logs:CreateLogGroup`\n- `logs:CreateLogStream`\n- `logs:PutLogEvents`", "stability": "external", "summary": "The ARN of the IAM role to be used to run the canary." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 316 }, "name": "executionRoleArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-name" }, "remarks": "Be sure to give it a descriptive name that distinguishes it from other canaries in your account.\n\nDo not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see [Security Considerations for Synthetics Canaries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html) .", "stability": "external", "summary": "The name for this canary." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 325 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runtimeversion" }, "remarks": "For more information about runtime versions, see [Canary Runtime Versions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) .", "stability": "external", "summary": "Specifies the runtime version to use for the canary." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 332 }, "name": "runtimeVersion", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-schedule" }, "stability": "external", "summary": "A structure that contains information about how often the canary is to run, and when these runs are to stop." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 339 }, "name": "schedule", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.ScheduleProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifactconfig" }, "stability": "external", "summary": "A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 346 }, "name": "artifactConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.ArtifactConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-deletelambdaresourcesoncanarydeletion" }, "stability": "external", "summary": "`AWS::Synthetics::Canary.DeleteLambdaResourcesOnCanaryDeletion`." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 353 }, "name": "deleteLambdaResourcesOnCanaryDeletion", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-failureretentionperiod" }, "remarks": "If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.", "stability": "external", "summary": "The number of days to retain data about failed runs of this canary." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 360 }, "name": "failureRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runconfig" }, "remarks": "If you omit this structure, the frequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.", "stability": "external", "summary": "A structure that contains input information for a canary run." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 367 }, "name": "runConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.RunConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-startcanaryaftercreation" }, "remarks": "A canary that you create using CloudFormation can't be used to monitor the CloudFormation stack that creates the canary or to roll back that stack if there is a failure.", "stability": "external", "summary": "Specify TRUE to have the canary start making runs immediately after it is created." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 376 }, "name": "startCanaryAfterCreation", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-successretentionperiod" }, "remarks": "If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.", "stability": "external", "summary": "The number of days to retain data about successful runs of this canary." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 383 }, "name": "successRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreference" }, "stability": "external", "summary": "If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 397 }, "name": "visualReference", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.VisualReferenceProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-vpcconfig" }, "remarks": "For more information, see [Running a Canary in a VPC](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) .", "stability": "external", "summary": "If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 404 }, "name": "vpcConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.VPCConfigProperty" } ] } } } ], "symbolId": "lib/synthetics.generated:CfnCanary" }, "@aws-cdk/aws-synthetics.CfnCanary.ArtifactConfigProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-artifactconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst artifactConfigProperty: synthetics.CfnCanary.ArtifactConfigProperty = {\n s3Encryption: {\n encryptionMode: 'encryptionMode',\n kmsKeyArn: 'kmsKeyArn',\n },\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.ArtifactConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 487 }, "name": "ArtifactConfigProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-artifactconfig.html#cfn-synthetics-canary-artifactconfig-s3encryption" }, "remarks": "Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see [Encrypting canary artifacts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html) .", "stability": "external", "summary": "A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 ." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 493 }, "name": "s3Encryption", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.S3EncryptionProperty" } ] } } } ], "symbolId": "lib/synthetics.generated:CfnCanary.ArtifactConfigProperty" }, "@aws-cdk/aws-synthetics.CfnCanary.BaseScreenshotProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst baseScreenshotProperty: synthetics.CfnCanary.BaseScreenshotProperty = {\n screenshotName: 'screenshotName',\n\n // the properties below are optional\n ignoreCoordinates: ['ignoreCoordinates'],\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.BaseScreenshotProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 554 }, "name": "BaseScreenshotProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-screenshotname" }, "remarks": "This is generated the first time the canary is run after the `UpdateCanary` operation that specified for this canary to perform visual monitoring.", "stability": "external", "summary": "The name of the screenshot." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 566 }, "name": "screenshotName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html#cfn-synthetics-canary-basescreenshot-ignorecoordinates" }, "remarks": "To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see [Edit or delete a canary](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html) .", "stability": "external", "summary": "Coordinates that define the part of a screen to ignore during screenshot comparisons." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 560 }, "name": "ignoreCoordinates", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/synthetics.generated:CfnCanary.BaseScreenshotProperty" }, "@aws-cdk/aws-synthetics.CfnCanary.CodeProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of `Script` .", "stability": "external", "summary": "Use this structure to input your script code for the canary.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst codeProperty: synthetics.CfnCanary.CodeProperty = {\n handler: 'handler',\n\n // the properties below are optional\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n s3ObjectVersion: 's3ObjectVersion',\n script: 'script',\n sourceLocationArn: 'sourceLocationArn',\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.CodeProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 631 }, "name": "CodeProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-handler" }, "remarks": "For canaries that use the `syn-python-selenium-1.0` runtime or a `syn-nodejs.puppeteer` runtime earlier than `syn-nodejs.puppeteer-3.4` , the handler must be specified as `*fileName* .handler` . For `syn-python-selenium-1.1` , `syn-nodejs.puppeteer-3.4` , and later runtimes, the handler can be specified as `*fileName* . *functionName*` , or you can specify a folder where canary scripts reside as `*folder* / *fileName* . *functionName*` .", "stability": "external", "summary": "The entry point to use for the source code when running the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 637 }, "name": "handler", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3bucket" }, "remarks": "The bucket must already exist.", "stability": "external", "summary": "If your canary script is located in S3, specify the bucket name here." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 643 }, "name": "s3Bucket", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3key" }, "remarks": "For more information, see [Working with Amazon S3 Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html) .", "stability": "external", "summary": "The S3 key of your script." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 649 }, "name": "s3Key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-s3objectversion" }, "stability": "external", "summary": "The S3 version ID of your script." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 655 }, "name": "s3ObjectVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-script" }, "remarks": "It can be up to 5 MB.", "stability": "external", "summary": "If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the script in plain text." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 661 }, "name": "script", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html#cfn-synthetics-canary-code-sourcelocationarn" }, "stability": "external", "summary": "The ARN of the Lambda layer where Synthetics stores the canary script code." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 667 }, "name": "sourceLocationArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/synthetics.generated:CfnCanary.CodeProperty" }, "@aws-cdk/aws-synthetics.CfnCanary.RunConfigProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This structure is required.", "stability": "external", "summary": "A structure that contains input information for a canary run.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst runConfigProperty: synthetics.CfnCanary.RunConfigProperty = {\n activeTracing: false,\n environmentVariables: {\n environmentVariablesKey: 'environmentVariables',\n },\n memoryInMb: 123,\n timeoutInSeconds: 123,\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.RunConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 744 }, "name": "RunConfigProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-activetracing" }, "remarks": "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. For more information, see [Canaries and X-Ray tracing](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html) .\n\nYou can enable active tracing only for canaries that use version `syn-nodejs-2.0` or later for their canary runtime.", "stability": "external", "summary": "Specifies whether this canary is to use active AWS X-Ray tracing when it runs." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 752 }, "name": "activeTracing", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-environmentvariables" }, "remarks": "Use the following format:\n\n{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}\n\nKeys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see [Runtime environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) .", "stability": "external", "summary": "Specifies the keys and values to use for any environment variables used in the canary script." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 762 }, "name": "environmentVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-memoryinmb" }, "remarks": "This value must be a multiple of 64. The range is 960 to 3008.", "stability": "external", "summary": "The maximum amount of memory that the canary can use while running." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 768 }, "name": "memoryInMb", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html#cfn-synthetics-canary-runconfig-timeoutinseconds" }, "remarks": "You can't set this time to be longer than the frequency of the runs of this canary.\n\nIf you omit this field, the frequency of the canary is used as this value, up to a maximum of 900 seconds.", "stability": "external", "summary": "How long the canary is allowed to run before it must stop." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 776 }, "name": "timeoutInSeconds", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/synthetics.generated:CfnCanary.RunConfigProperty" }, "@aws-cdk/aws-synthetics.CfnCanary.S3EncryptionProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see [Encrypting canary artifacts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html) .", "stability": "external", "summary": "A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst s3EncryptionProperty: synthetics.CfnCanary.S3EncryptionProperty = {\n encryptionMode: 'encryptionMode',\n kmsKeyArn: 'kmsKeyArn',\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.S3EncryptionProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 846 }, "name": "S3EncryptionProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html#cfn-synthetics-canary-s3encryption-encryptionmode" }, "remarks": "Specify `SSE_S3` to use server-side encryption (SSE) with an Amazon S3-managed key. Specify `SSE-KMS` to use server-side encryption with a customer-managed AWS KMS key.\n\nIf you omit this parameter, an AWS -managed AWS KMS key is used.", "stability": "external", "summary": "The encryption method to use for artifacts created by this canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 854 }, "name": "encryptionMode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html#cfn-synthetics-canary-s3encryption-kmskeyarn" }, "stability": "external", "summary": "The ARN of the customer-managed AWS KMS key to use, if you specify `SSE-KMS` for `EncryptionMode`." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 860 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/synthetics.generated:CfnCanary.S3EncryptionProperty" }, "@aws-cdk/aws-synthetics.CfnCanary.ScheduleProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst scheduleProperty: synthetics.CfnCanary.ScheduleProperty = {\n expression: 'expression',\n\n // the properties below are optional\n durationInSeconds: 'durationInSeconds',\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.ScheduleProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 924 }, "name": "ScheduleProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-expression" }, "remarks": "For a rate expression, The syntax is `rate( *number unit* )` . *unit* can be `minute` , `minutes` , or `hour` .\n\nFor example, `rate(1 minute)` runs the canary once a minute, `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)` runs it once every hour. You can specify a frequency between `rate(1 minute)` and `rate(1 hour)` .\n\nSpecifying `rate(0 minute)` or `rate(0 hour)` is a special value that causes the canary to run only once when it is started.\n\nUse `cron( *expression* )` to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .", "stability": "external", "summary": "A `rate` expression or a `cron` expression that defines how often the canary is to run." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 944 }, "name": "expression", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-durationinseconds" }, "remarks": "If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.", "stability": "external", "summary": "How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 930 }, "name": "durationInSeconds", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/synthetics.generated:CfnCanary.ScheduleProperty" }, "@aws-cdk/aws-synthetics.CfnCanary.VPCConfigProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Running a Canary in a VPC](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) .", "stability": "external", "summary": "If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst vPCConfigProperty: synthetics.CfnCanary.VPCConfigProperty = {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n\n // the properties below are optional\n vpcId: 'vpcId',\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.VPCConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1009 }, "name": "VPCConfigProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-securitygroupids" }, "stability": "external", "summary": "The IDs of the security groups for this canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1015 }, "name": "securityGroupIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-subnetids" }, "stability": "external", "summary": "The IDs of the subnets where this canary is to run." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1021 }, "name": "subnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-vpcid" }, "stability": "external", "summary": "The ID of the VPC where this canary is to run." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1027 }, "name": "vpcId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/synthetics.generated:CfnCanary.VPCConfigProperty" }, "@aws-cdk/aws-synthetics.CfnCanary.VisualReferenceProperty": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-visualreference.html", "exampleMetadata": "fixture=_generated" }, "remarks": "If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.\n\nVisual monitoring is supported only on canaries running the *syn-puppeteer-node-3.2* runtime or later. For more information, see [Visual monitoring](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) and [Visual monitoring blueprint](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html)", "stability": "external", "summary": "Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst visualReferenceProperty: synthetics.CfnCanary.VisualReferenceProperty = {\n baseCanaryRunId: 'baseCanaryRunId',\n\n // the properties below are optional\n baseScreenshots: [{\n screenshotName: 'screenshotName',\n\n // the properties below are optional\n ignoreCoordinates: ['ignoreCoordinates'],\n }],\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanary.VisualReferenceProperty", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1098 }, "name": "VisualReferenceProperty", "namespace": "CfnCanary", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-visualreference.html#cfn-synthetics-canary-visualreference-basecanaryrunid" }, "remarks": "Valid values are `nextrun` to use the screenshots from the next run after this update is made, `lastrun` to use the screenshots from the most recent run before this update was made, or the value of `Id` in the [CanaryRun](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html) from any past run of this canary.", "stability": "external", "summary": "Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1104 }, "name": "baseCanaryRunId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-visualreference.html#cfn-synthetics-canary-visualreference-basescreenshots" }, "stability": "external", "summary": "An array of screenshots that are used as the baseline for comparisons during visual monitoring." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1110 }, "name": "baseScreenshots", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.BaseScreenshotProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/synthetics.generated:CfnCanary.VisualReferenceProperty" }, "@aws-cdk/aws-synthetics.CfnCanaryProps": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnCanary`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst cfnCanaryProps: synthetics.CfnCanaryProps = {\n artifactS3Location: 'artifactS3Location',\n code: {\n handler: 'handler',\n\n // the properties below are optional\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n s3ObjectVersion: 's3ObjectVersion',\n script: 'script',\n sourceLocationArn: 'sourceLocationArn',\n },\n executionRoleArn: 'executionRoleArn',\n name: 'name',\n runtimeVersion: 'runtimeVersion',\n schedule: {\n expression: 'expression',\n\n // the properties below are optional\n durationInSeconds: 'durationInSeconds',\n },\n\n // the properties below are optional\n artifactConfig: {\n s3Encryption: {\n encryptionMode: 'encryptionMode',\n kmsKeyArn: 'kmsKeyArn',\n },\n },\n deleteLambdaResourcesOnCanaryDeletion: false,\n failureRetentionPeriod: 123,\n runConfig: {\n activeTracing: false,\n environmentVariables: {\n environmentVariablesKey: 'environmentVariables',\n },\n memoryInMb: 123,\n timeoutInSeconds: 123,\n },\n startCanaryAfterCreation: false,\n successRetentionPeriod: 123,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n visualReference: {\n baseCanaryRunId: 'baseCanaryRunId',\n\n // the properties below are optional\n baseScreenshots: [{\n screenshotName: 'screenshotName',\n\n // the properties below are optional\n ignoreCoordinates: ['ignoreCoordinates'],\n }],\n },\n vpcConfig: {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n\n // the properties below are optional\n vpcId: 'vpcId',\n },\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnCanaryProps", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 19 }, "name": "CfnCanaryProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifacts3location" }, "remarks": "Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including `s3://` at the beginning of the path.", "stability": "external", "summary": "The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 26 }, "name": "artifactS3Location", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-code" }, "remarks": "This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script is passed into the canary directly, the script code is contained in the value of `Script` .", "stability": "external", "summary": "Use this structure to input your script code for the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 33 }, "name": "code", "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.CodeProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn" }, "remarks": "This role must already exist, and must include `lambda.amazonaws.com` as a principal in the trust policy. The role must also have the following permissions:\n\n- `s3:PutObject`\n- `s3:GetBucketLocation`\n- `s3:ListAllMyBuckets`\n- `cloudwatch:PutMetricData`\n- `logs:CreateLogGroup`\n- `logs:CreateLogStream`\n- `logs:PutLogEvents`", "stability": "external", "summary": "The ARN of the IAM role to be used to run the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 48 }, "name": "executionRoleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-name" }, "remarks": "Be sure to give it a descriptive name that distinguishes it from other canaries in your account.\n\nDo not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see [Security Considerations for Synthetics Canaries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html) .", "stability": "external", "summary": "The name for this canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 57 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runtimeversion" }, "remarks": "For more information about runtime versions, see [Canary Runtime Versions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) .", "stability": "external", "summary": "Specifies the runtime version to use for the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 64 }, "name": "runtimeVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-schedule" }, "stability": "external", "summary": "A structure that contains information about how often the canary is to run, and when these runs are to stop." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 71 }, "name": "schedule", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.ScheduleProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifactconfig" }, "stability": "external", "summary": "A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 78 }, "name": "artifactConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.ArtifactConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-deletelambdaresourcesoncanarydeletion" }, "stability": "external", "summary": "`AWS::Synthetics::Canary.DeleteLambdaResourcesOnCanaryDeletion`." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 85 }, "name": "deleteLambdaResourcesOnCanaryDeletion", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-failureretentionperiod" }, "remarks": "If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.", "stability": "external", "summary": "The number of days to retain data about failed runs of this canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 92 }, "name": "failureRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runconfig" }, "remarks": "If you omit this structure, the frequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.", "stability": "external", "summary": "A structure that contains input information for a canary run." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 99 }, "name": "runConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.RunConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-startcanaryaftercreation" }, "remarks": "A canary that you create using CloudFormation can't be used to monitor the CloudFormation stack that creates the canary or to roll back that stack if there is a failure.", "stability": "external", "summary": "Specify TRUE to have the canary start making runs immediately after it is created." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 108 }, "name": "startCanaryAfterCreation", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-successretentionperiod" }, "remarks": "If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.", "stability": "external", "summary": "The number of days to retain data about successful runs of this canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 115 }, "name": "successRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-tags" }, "stability": "external", "summary": "The list of key-value pairs that are associated with the canary." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 122 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreference" }, "stability": "external", "summary": "If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 129 }, "name": "visualReference", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.VisualReferenceProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-vpcconfig" }, "remarks": "For more information, see [Running a Canary in a VPC](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html) .", "stability": "external", "summary": "If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 136 }, "name": "vpcConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-synthetics.CfnCanary.VPCConfigProperty" } ] } } } ], "symbolId": "lib/synthetics.generated:CfnCanaryProps" }, "@aws-cdk/aws-synthetics.CfnGroup": { "assembly": "@aws-cdk/aws-synthetics", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Synthetics::Group", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates or updates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group.\n\nGroups are global resources. When you create a group, it is replicated across all AWS Regions, and you can add canaries from any Region to it, and view it in any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view.\n\nEach group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups.", "stability": "external", "summary": "A CloudFormation `AWS::Synthetics::Group`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst cfnGroup = new synthetics.CfnGroup(this, 'MyCfnGroup', {\n name: 'name',\n\n // the properties below are optional\n resourceArns: ['resourceArns'],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-synthetics.CfnGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Synthetics::Group`." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1327 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-synthetics.CfnGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1266 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1343 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1356 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1270 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "stability": "external", "summary": "The Id of the group." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1295 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1348 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-tags" }, "stability": "external", "summary": "The list of key-value pairs that are associated with the group." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1318 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-name" }, "remarks": "The names for all groups in your account, across all Regions, must be unique.", "stability": "external", "summary": "A name for the group. It can include any Unicode characters." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1304 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-resourcearns" }, "stability": "external", "summary": "The ARNs of the canaries that you want to associate with this group." }, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1311 }, "name": "resourceArns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/synthetics.generated:CfnGroup" }, "@aws-cdk/aws-synthetics.CfnGroupProps": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst cfnGroupProps: synthetics.CfnGroupProps = {\n name: 'name',\n\n // the properties below are optional\n resourceArns: ['resourceArns'],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-synthetics.CfnGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1174 }, "name": "CfnGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-name" }, "remarks": "The names for all groups in your account, across all Regions, must be unique.", "stability": "external", "summary": "A name for the group. It can include any Unicode characters." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1183 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-resourcearns" }, "stability": "external", "summary": "The ARNs of the canaries that you want to associate with this group." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1190 }, "name": "resourceArns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-group.html#cfn-synthetics-group-tags" }, "stability": "external", "summary": "The list of key-value pairs that are associated with the group." }, "immutable": true, "locationInModule": { "filename": "lib/synthetics.generated.ts", "line": 1197 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/synthetics.generated:CfnGroupProps" }, "@aws-cdk/aws-synthetics.Code": { "abstract": true, "assembly": "@aws-cdk/aws-synthetics", "docs": { "stability": "experimental", "summary": "The code the canary should execute.", "example": "const canary = new synthetics.Canary(this, 'MyCanary', {\n schedule: synthetics.Schedule.rate(Duration.minutes(5)),\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,\n environmentVariables: {\n stage: 'prod',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.Code", "initializer": { "docs": { "stability": "experimental" } }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 11 }, "methods": [ { "docs": { "remarks": "Path must include the folder structure `nodejs/node_modules/myCanaryFilename.js`.", "returns": "`AssetCode` associated with the specified path.", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch", "stability": "experimental", "summary": "Specify code from a local path." }, "locationInModule": { "filename": "lib/code.ts", "line": 32 }, "name": "fromAsset", "parameters": [ { "docs": { "summary": "Either a directory or a .zip file." }, "name": "assetPath", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3-assets.AssetOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.AssetCode" } }, "static": true }, { "docs": { "remarks": "The object in the s3 bucket must be a .zip file that contains\nthe structure `nodejs/node_modules/myCanaryFilename.js`.", "returns": "`S3Code` associated with the specified S3 object.", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary.html#CloudWatch_Synthetics_Canaries_write_from_scratch", "stability": "experimental", "summary": "Specify code from an s3 bucket." }, "locationInModule": { "filename": "lib/code.ts", "line": 47 }, "name": "fromBucket", "parameters": [ { "docs": { "summary": "The S3 bucket." }, "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "docs": { "summary": "The object key." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "Optional S3 object version." }, "name": "objectVersion", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.S3Code" } }, "static": true }, { "docs": { "returns": "`InlineCode` with inline code.", "stability": "experimental", "summary": "Specify code inline." }, "locationInModule": { "filename": "lib/code.ts", "line": 20 }, "name": "fromInline", "parameters": [ { "docs": { "summary": "The actual handler code (limited to 4KiB)." }, "name": "code", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.InlineCode" } }, "static": true }, { "abstract": true, "docs": { "returns": "a bound `CodeConfig`.", "stability": "experimental", "summary": "Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 60 }, "name": "bind", "parameters": [ { "docs": { "remarks": "Don't be smart about trying to down-cast or\nassume it's initialized. You may just use it as a construct scope.", "summary": "The binding scope." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "handler", "type": { "primitive": "string" } }, { "name": "family", "type": { "fqn": "@aws-cdk/aws-synthetics.RuntimeFamily" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.CodeConfig" } } } ], "name": "Code", "symbolId": "lib/code:Code" }, "@aws-cdk/aws-synthetics.CodeConfig": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "stability": "experimental", "summary": "Configuration of the code class.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst codeConfig: synthetics.CodeConfig = {\n inlineCode: 'inlineCode',\n s3Location: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n objectVersion: 'objectVersion',\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-synthetics.CodeConfig", "kind": "interface", "locationInModule": { "filename": "lib/code.ts", "line": 66 }, "name": "CodeConfig", "properties": [ { "abstract": true, "docs": { "default": "- none", "stability": "experimental", "summary": "Inline code (mutually exclusive with `s3Location`)." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 79 }, "name": "inlineCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- none", "stability": "experimental", "summary": "The location of the code in S3 (mutually exclusive with `inlineCode`)." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 72 }, "name": "s3Location", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3.Location" } } ], "symbolId": "lib/code:CodeConfig" }, "@aws-cdk/aws-synthetics.CronOptions": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "remarks": "All fields are strings so you can use complex expressions. Absence of\na field implies '*' or '?', whichever one is appropriate.", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html", "stability": "experimental", "summary": "Options to configure a cron expression.", "example": "const schedule = synthetics.Schedule.cron({\n hour: '0,8,16', // Run at 12am, 8am, 4pm UTC every day\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.CronOptions", "kind": "interface", "locationInModule": { "filename": "lib/schedule.ts", "line": 83 }, "name": "CronOptions", "properties": [ { "abstract": true, "docs": { "default": "- Every day of the month", "stability": "experimental", "summary": "The day of the month to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 103 }, "name": "day", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Every hour", "stability": "experimental", "summary": "The hour to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 96 }, "name": "hour", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Every minute", "stability": "experimental", "summary": "The minute to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 89 }, "name": "minute", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Every month", "stability": "experimental", "summary": "The month to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 110 }, "name": "month", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Any day of the week", "stability": "experimental", "summary": "The day of the week to run this rule at." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 117 }, "name": "weekDay", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/schedule:CronOptions" }, "@aws-cdk/aws-synthetics.CustomTestOptions": { "assembly": "@aws-cdk/aws-synthetics", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for specifying a test.", "example": "const canary = new synthetics.Canary(this, 'MyCanary', {\n schedule: synthetics.Schedule.rate(Duration.minutes(5)),\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,\n environmentVariables: {\n stage: 'prod',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.CustomTestOptions", "kind": "interface", "locationInModule": { "filename": "lib/canary.ts", "line": 57 }, "name": "CustomTestOptions", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The code of the canary script." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 61 }, "name": "code", "type": { "fqn": "@aws-cdk/aws-synthetics.Code" } }, { "abstract": true, "docs": { "remarks": "Must end with `.handler`.", "stability": "experimental", "summary": "The handler for the code." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 66 }, "name": "handler", "type": { "primitive": "string" } } ], "symbolId": "lib/canary:CustomTestOptions" }, "@aws-cdk/aws-synthetics.InlineCode": { "assembly": "@aws-cdk/aws-synthetics", "base": "@aws-cdk/aws-synthetics.Code", "docs": { "stability": "experimental", "summary": "Canary code from an inline string.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as synthetics from '@aws-cdk/aws-synthetics';\nconst inlineCode = new synthetics.InlineCode('code');", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-synthetics.InlineCode", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/code.ts", "line": 152 }, "parameters": [ { "name": "code", "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 151 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 160 }, "name": "bind", "overrides": "@aws-cdk/aws-synthetics.Code", "parameters": [ { "name": "_scope", "type": { "fqn": "constructs.Construct" } }, { "name": "handler", "type": { "primitive": "string" } }, { "name": "_family", "type": { "fqn": "@aws-cdk/aws-synthetics.RuntimeFamily" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.CodeConfig" } } } ], "name": "InlineCode", "symbolId": "lib/code:InlineCode" }, "@aws-cdk/aws-synthetics.Runtime": { "assembly": "@aws-cdk/aws-synthetics", "docs": { "stability": "experimental", "summary": "Runtime options for a canary.", "example": "const canary = new synthetics.Canary(this, 'MyCanary', {\n schedule: synthetics.Schedule.rate(Duration.minutes(5)),\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,\n environmentVariables: {\n stage: 'prod',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.Runtime", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/runtime.ts", "line": 151 }, "parameters": [ { "docs": { "summary": "The name of the runtime version." }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "summary": "The Lambda runtime family." }, "name": "family", "type": { "fqn": "@aws-cdk/aws-synthetics.RuntimeFamily" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/runtime.ts", "line": 24 }, "name": "Runtime", "properties": [ { "const": true, "docs": { "remarks": "`syn-1.0` includes the following:\n\n- Synthetics library 1.0\n- Synthetics handler code 1.0\n- Lambda runtime Node.js 10.x\n- Puppeteer-core version 1.14.0\n- The Chromium version that matches Puppeteer-core 1.14.0", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-1.0", "stability": "experimental", "summary": "**Deprecated by AWS Synthetics. You can't create canaries with deprecated runtimes.**." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 38 }, "name": "SYNTHETICS_1_0", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "remarks": "`syn-nodejs-2.0` includes the following:\n- Lambda runtime Node.js 10.x\n- Puppeteer-core version 3.3.0\n- Chromium version 83.0.4103.0", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-2.0", "stability": "experimental", "summary": "**Deprecated by AWS Synthetics. You can't create canaries with deprecated runtimes.**." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 50 }, "name": "SYNTHETICS_NODEJS_2_0", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "remarks": "`syn-nodejs-2.1` includes the following:\n- Lambda runtime Node.js 10.x\n- Puppeteer-core version 3.3.0\n- Chromium version 83.0.4103.0", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-2.1", "stability": "experimental", "summary": "**Deprecated by AWS Synthetics. You can't create canaries with deprecated runtimes.**." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 63 }, "name": "SYNTHETICS_NODEJS_2_1", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "remarks": "`syn-nodejs-2.2` includes the following:\n- Lambda runtime Node.js 10.x\n- Puppeteer-core version 3.3.0\n- Chromium version 83.0.4103.0", "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-2.2", "stability": "experimental", "summary": "**Deprecated by AWS Synthetics. You can't create canaries with deprecated runtimes.**." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 75 }, "name": "SYNTHETICS_NODEJS_2_2", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-nodejs-puppeteer-3.0", "stability": "experimental", "summary": "`syn-nodejs-puppeteer-3.0` includes the following: - Lambda runtime Node.js 12.x - Puppeteer-core version 5.5.0 - Chromium version 88.0.4298.0." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 85 }, "name": "SYNTHETICS_NODEJS_PUPPETEER_3_0", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-nodejs-puppeteer-3.1", "stability": "experimental", "summary": "`syn-nodejs-puppeteer-3.1` includes the following: - Lambda runtime Node.js 12.x - Puppeteer-core version 5.5.0 - Chromium version 88.0.4298.0." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 95 }, "name": "SYNTHETICS_NODEJS_PUPPETEER_3_1", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-nodejs-puppeteer-3.2", "stability": "experimental", "summary": "`syn-nodejs-puppeteer-3.2` includes the following: - Lambda runtime Node.js 12.x - Puppeteer-core version 5.5.0 - Chromium version 88.0.4298.0." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 105 }, "name": "SYNTHETICS_NODEJS_PUPPETEER_3_2", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-nodejs-puppeteer-3.3", "stability": "experimental", "summary": "`syn-nodejs-puppeteer-3.3` includes the following: - Lambda runtime Node.js 12.x - Puppeteer-core version 5.5.0 - Chromium version 88.0.4298.0." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 115 }, "name": "SYNTHETICS_NODEJS_PUPPETEER_3_3", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-nodejs-puppeteer-3.4", "stability": "experimental", "summary": "`syn-nodejs-puppeteer-3.4` includes the following: - Lambda runtime Node.js 12.x - Puppeteer-core version 5.5.0 - Chromium version 88.0.4298.0." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 125 }, "name": "SYNTHETICS_NODEJS_PUPPETEER_3_4", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_puppeteer.html#CloudWatch_Synthetics_runtimeversion-nodejs-puppeteer-3.5", "stability": "experimental", "summary": "`syn-nodejs-puppeteer-3.5` includes the following: - Lambda runtime Node.js 14.x - Puppeteer-core version 10.1.0 - Chromium version 92.0.4512." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 135 }, "name": "SYNTHETICS_NODEJS_PUPPETEER_3_5", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "const": true, "docs": { "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_python_selenium.html", "stability": "experimental", "summary": "`syn-python-selenium-1.0` includes the following: - Lambda runtime Python 3.8 - Selenium version 3.141.0 - Chromium version 83.0.4103.0." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 145 }, "name": "SYNTHETICS_PYTHON_SELENIUM_1_0", "static": true, "type": { "fqn": "@aws-cdk/aws-synthetics.Runtime" } }, { "docs": { "stability": "experimental", "summary": "The Lambda runtime family." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 151 }, "name": "family", "type": { "fqn": "@aws-cdk/aws-synthetics.RuntimeFamily" } }, { "docs": { "stability": "experimental", "summary": "The name of the runtime version." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 151 }, "name": "name", "type": { "primitive": "string" } } ], "symbolId": "lib/runtime:Runtime" }, "@aws-cdk/aws-synthetics.RuntimeFamily": { "assembly": "@aws-cdk/aws-synthetics", "docs": { "stability": "experimental", "summary": "All known Lambda runtime families." }, "fqn": "@aws-cdk/aws-synthetics.RuntimeFamily", "kind": "enum", "locationInModule": { "filename": "lib/runtime.ts", "line": 4 }, "members": [ { "docs": { "stability": "experimental", "summary": "All Lambda runtimes that depend on Node.js." }, "name": "NODEJS" }, { "docs": { "stability": "experimental", "summary": "All lambda runtimes that depend on Python." }, "name": "PYTHON" }, { "docs": { "stability": "experimental", "summary": "Any future runtime family." }, "name": "OTHER" } ], "name": "RuntimeFamily", "symbolId": "lib/runtime:RuntimeFamily" }, "@aws-cdk/aws-synthetics.S3Code": { "assembly": "@aws-cdk/aws-synthetics", "base": "@aws-cdk/aws-synthetics.Code", "docs": { "stability": "experimental", "summary": "S3 bucket path to the code zip file.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as s3 from '@aws-cdk/aws-s3';\nimport * as synthetics from '@aws-cdk/aws-synthetics';\n\ndeclare const bucket: s3.Bucket;\nconst s3Code = new synthetics.S3Code(bucket, 'key', /* all optional props */ 'objectVersion');", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-synthetics.S3Code", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/code.ts", "line": 176 }, "parameters": [ { "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "name": "key", "type": { "primitive": "string" } }, { "name": "objectVersion", "optional": true, "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 175 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 180 }, "name": "bind", "overrides": "@aws-cdk/aws-synthetics.Code", "parameters": [ { "name": "_scope", "type": { "fqn": "constructs.Construct" } }, { "name": "_handler", "type": { "primitive": "string" } }, { "name": "_family", "type": { "fqn": "@aws-cdk/aws-synthetics.RuntimeFamily" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.CodeConfig" } } } ], "name": "S3Code", "symbolId": "lib/code:S3Code" }, "@aws-cdk/aws-synthetics.Schedule": { "assembly": "@aws-cdk/aws-synthetics", "docs": { "stability": "experimental", "summary": "Schedule for canary runs.", "example": "const schedule = synthetics.Schedule.rate(Duration.minutes(5)); // Runs every 5 minutes.", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.Schedule", "kind": "class", "locationInModule": { "filename": "lib/schedule.ts", "line": 6 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Create a schedule from a set of cron fields." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 48 }, "name": "cron", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-synthetics.CronOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.Schedule" } }, "static": true }, { "docs": { "remarks": "The expression must be in a `rate(number units)` format.\nFor example, `Schedule.expression('rate(10 minutes)')`", "stability": "experimental", "summary": "Construct a schedule from a literal schedule expression." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 21 }, "name": "expression", "parameters": [ { "docs": { "summary": "The expression to use." }, "name": "expression", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.Schedule" } }, "static": true }, { "docs": { "stability": "experimental", "summary": "The canary will be executed once." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 11 }, "name": "once", "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.Schedule" } }, "static": true }, { "docs": { "remarks": "Allowed values: 0 (for a single run) or between 1 and 60 minutes.\nTo specify a single run, you can use `Schedule.once()`.", "stability": "experimental", "summary": "Construct a schedule from an interval." }, "locationInModule": { "filename": "lib/schedule.ts", "line": 31 }, "name": "rate", "parameters": [ { "docs": { "summary": "The interval at which to run the canary." }, "name": "interval", "type": { "fqn": "@aws-cdk/core.Duration" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.Schedule" } }, "static": true } ], "name": "Schedule", "properties": [ { "docs": { "stability": "experimental", "summary": "The Schedule expression." }, "immutable": true, "locationInModule": { "filename": "lib/schedule.ts", "line": 71 }, "name": "expressionString", "type": { "primitive": "string" } } ], "symbolId": "lib/schedule:Schedule" }, "@aws-cdk/aws-synthetics.Test": { "assembly": "@aws-cdk/aws-synthetics", "docs": { "stability": "experimental", "summary": "Specify a test that the canary should run.", "example": "const canary = new synthetics.Canary(this, 'MyCanary', {\n schedule: synthetics.Schedule.rate(Duration.minutes(5)),\n test: synthetics.Test.custom({\n code: synthetics.Code.fromAsset(path.join(__dirname, 'canary')),\n handler: 'index.handler',\n }),\n runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,\n environmentVariables: {\n stage: 'prod',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-synthetics.Test", "kind": "class", "locationInModule": { "filename": "lib/canary.ts", "line": 17 }, "methods": [ { "docs": { "returns": "`Test` associated with the specified Code object", "stability": "experimental", "summary": "Specify a custom test with your own code." }, "locationInModule": { "filename": "lib/canary.ts", "line": 24 }, "name": "custom", "parameters": [ { "docs": { "summary": "The configuration options." }, "name": "options", "type": { "fqn": "@aws-cdk/aws-synthetics.CustomTestOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-synthetics.Test" } }, "static": true } ], "name": "Test", "properties": [ { "docs": { "stability": "experimental", "summary": "The code that the canary should run." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 50 }, "name": "code", "type": { "fqn": "@aws-cdk/aws-synthetics.Code" } }, { "docs": { "stability": "experimental", "summary": "The handler of the canary." }, "immutable": true, "locationInModule": { "filename": "lib/canary.ts", "line": 50 }, "name": "handler", "type": { "primitive": "string" } } ], "symbolId": "lib/canary:Test" } }, "version": "1.204.0", "fingerprint": "**********" }