CanaryProps

class aws_cdk.aws_synthetics.CanaryProps(*, runtime, test, artifacts_bucket_location=None, canary_name=None, environment_variables=None, failure_retention_period=None, role=None, schedule=None, security_groups=None, start_after_creation=None, success_retention_period=None, time_to_live=None, vpc=None, vpc_subnets=None)

Bases: object

(experimental) Properties for a canary.

Parameters:

runtime (Runtime) – (experimental) Specify the runtime version to use for the canary.
test (Test) – (experimental) The type of test that you want your canary to run. Use Test.custom() to specify the test to run.
artifacts_bucket_location (Union[ArtifactsBucketLocation, Dict[str, Any], None]) – (experimental) The s3 location that stores the data of the canary runs. Default: - A new s3 bucket will be created without a prefix.
canary_name (Optional[str]) – (experimental) The name of the canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet. Default: - A unique name will be generated from the construct ID
environment_variables (Optional[Mapping[str, str]]) – (experimental) Key-value pairs that the Synthetics caches and makes available for your canary scripts. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Canary script source code. Default: - No environment variables.
failure_retention_period (Optional[Duration]) – (experimental) How many days should failed runs be retained. Default: Duration.days(31)
role (Optional[IRole]) – (experimental) Canary execution role. This is the role that will be assumed by the canary upon execution. It controls the permissions that the canary will have. The role must be assumable by the AWS Lambda service principal. If not supplied, a role will be created with all the required permissions. If you provide a Role, you must add the required permissions. Default: - A unique role will be generated for this canary. You can add permissions to roles by calling ‘addToRolePolicy’.
schedule (Optional[Schedule]) – (experimental) Specify the schedule for how often the canary runs. For example, if you set schedule to rate(10 minutes), then the canary will run every 10 minutes. You can set the schedule with Schedule.rate(Duration) (recommended) or you can specify an expression using Schedule.expression(). Default: ‘rate(5 minutes)’
security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) The list of security groups to associate with the canary’s network interfaces. You must provide vpc when using this prop. Default: - If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.
start_after_creation (Optional[bool]) – (experimental) Whether or not the canary should start after creation. Default: true
success_retention_period (Optional[Duration]) – (experimental) How many days should successful runs be retained. Default: Duration.days(31)
time_to_live (Optional[Duration]) – (experimental) How long the canary will be in a ‘RUNNING’ state. For example, if you set timeToLive to be 1 hour and schedule to be rate(10 minutes), your canary will run at 10 minute intervals for an hour, for a total of 6 times. Default: - no limit
vpc (Optional[IVpc]) – (experimental) The VPC where this canary is run. Specify this if the canary needs to access resources in a VPC. Default: - Not in VPC
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – (experimental) Where to place the network interfaces within the VPC. You must provide vpc when using this prop. Default: - the Vpc default strategy if not specified

Stability:

experimental

ExampleMetadata:

infused

Example:

canary = synthetics.Canary(self, "MyCanary",
    schedule=synthetics.Schedule.rate(Duration.minutes(5)),
    test=synthetics.Test.custom(
        code=synthetics.Code.from_asset(path.join(__dirname, "canary")),
        handler="index.handler"
    ),
    runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1,
    environment_variables={
        "stage": "prod"
    }
)

Attributes

artifacts_bucket_location

(experimental) The s3 location that stores the data of the canary runs.

Default:

A new s3 bucket will be created without a prefix.

Stability:

experimental

canary_name

(experimental) The name of the canary.

Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet.

Default:

A unique name will be generated from the construct ID

See:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html

Stability:

experimental

environment_variables

(experimental) Key-value pairs that the Synthetics caches and makes available for your canary scripts.

Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Canary script source code.

Default:

No environment variables.

Stability:

experimental

failure_retention_period

(experimental) How many days should failed runs be retained.

Default:: Duration.days(31)
Stability:: experimental

role

(experimental) Canary execution role.

This is the role that will be assumed by the canary upon execution. It controls the permissions that the canary will have. The role must be assumable by the AWS Lambda service principal.

If not supplied, a role will be created with all the required permissions. If you provide a Role, you must add the required permissions.

Default:

A unique role will be generated for this canary.

You can add permissions to roles by calling ‘addToRolePolicy’.

See:: required permissions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn
Stability:: experimental

runtime

(experimental) Specify the runtime version to use for the canary.

See:: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
Stability:: experimental

schedule

(experimental) Specify the schedule for how often the canary runs.

For example, if you set schedule to rate(10 minutes), then the canary will run every 10 minutes. You can set the schedule with Schedule.rate(Duration) (recommended) or you can specify an expression using Schedule.expression().

Default:: ‘rate(5 minutes)’
Stability:: experimental

security_groups

(experimental) The list of security groups to associate with the canary’s network interfaces.

You must provide vpc when using this prop.

Default:

If the canary is placed within a VPC and a security group is

not specified a dedicated security group will be created for this canary.

Stability:: experimental

start_after_creation

(experimental) Whether or not the canary should start after creation.

Default:: true
Stability:: experimental

success_retention_period

(experimental) How many days should successful runs be retained.

Default:: Duration.days(31)
Stability:: experimental

test

(experimental) The type of test that you want your canary to run.

Use Test.custom() to specify the test to run.

Stability:: experimental

time_to_live

(experimental) How long the canary will be in a ‘RUNNING’ state.

For example, if you set timeToLive to be 1 hour and schedule to be rate(10 minutes), your canary will run at 10 minute intervals for an hour, for a total of 6 times.

Default:

no limit

Stability:

experimental

vpc

(experimental) The VPC where this canary is run.

Specify this if the canary needs to access resources in a VPC.

Default:

Not in VPC

Stability:

experimental

vpc_subnets

(experimental) Where to place the network interfaces within the VPC.

You must provide vpc when using this prop.

Default:

the Vpc default strategy if not specified

Stability:

experimental