Interface CanaryProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CanaryProps.Jsii$Proxy
Example:
Canary canary = Canary.Builder.create(this, "MyCanary") .schedule(Schedule.rate(Duration.minutes(5))) .test(Test.custom(CustomTestOptions.builder() .code(Code.fromAsset(join(__dirname, "canary"))) .handler("index.handler") .build())) .runtime(Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2) .environmentVariables(Map.of( "stage", "prod")) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCanaryProps
static final class
An implementation forCanaryProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CanaryProps.Builder
builder()
default List<LifecycleRule>
Lifecycle rules for the generated canary artifact bucket.default ArtifactsBucketLocation
The s3 location that stores the data of the canary runs.default String
The name of the canary.default Cleanup
Specify the underlying resources to be cleaned up when the canary is deleted.Key-value pairs that the Synthetics caches and makes available for your canary scripts.default Duration
How many days should failed runs be retained.default IRole
getRole()
Canary execution role.Specify the runtime version to use for the canary.default Schedule
Specify the schedule for how often the canary runs.default List<ISecurityGroup>
The list of security groups to associate with the canary's network interfaces.default Boolean
Whether or not the canary should start after creation.default Duration
How many days should successful runs be retained.getTest()
The type of test that you want your canary to run.default Duration
How long the canary will be in a 'RUNNING' state.default IVpc
getVpc()
The VPC where this canary is run.default SubnetSelection
Where to place the network interfaces within the VPC.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getRuntime
Specify the runtime version to use for the canary.- See Also:
-
getTest
The type of test that you want your canary to run.Use
Test.custom()
to specify the test to run. -
getArtifactsBucketLifecycleRules
Lifecycle rules for the generated canary artifact bucket.Has no effect if a bucket is passed to
artifactsBucketLocation
. If you pass a bucket toartifactsBucketLocation
, you can add lifecycle rules to the bucket itself.Default: - no rules applied to the generated bucket.
-
getArtifactsBucketLocation
The s3 location that stores the data of the canary runs.Default: - A new s3 bucket will be created without a prefix.
-
getCanaryName
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 Also:
-
getCleanup
Specify the underlying resources to be cleaned up when the canary is deleted.Using
Cleanup.LAMBDA
will create a Custom Resource to achieve this.Default: Cleanup.NOTHING
-
getEnvironmentVariables
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.
-
getFailureRetentionPeriod
How many days should failed runs be retained.Default: Duration.days(31)
-
getRole
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 Also:
-
getSchedule
Specify the schedule for how often the canary runs.For example, if you set
schedule
torate(10 minutes)
, then the canary will run every 10 minutes. You can set the schedule withSchedule.rate(Duration)
(recommended) or you can specify an expression usingSchedule.expression()
.Default: 'rate(5 minutes)'
-
getSecurityGroups
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.
-
getStartAfterCreation
Whether or not the canary should start after creation.Default: true
-
getSuccessRetentionPeriod
How many days should successful runs be retained.Default: Duration.days(31)
-
getTimeToLive
How long the canary will be in a 'RUNNING' state.For example, if you set
timeToLive
to be 1 hour andschedule
to berate(10 minutes)
, your canary will run at 10 minute intervals for an hour, for a total of 6 times.Default: - no limit
-
getVpc
The VPC where this canary is run.Specify this if the canary needs to access resources in a VPC.
Default: - Not in VPC
-
getVpcSubnets
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
-
builder
- Returns:
- a
CanaryProps.Builder
ofCanaryProps
-