class CfnCanary (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Synthetics.CfnCanary |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnCanary |
![]() | software.amazon.awscdk.services.synthetics.CfnCanary |
![]() | aws_cdk.aws_synthetics.CfnCanary |
![]() | aws-cdk-lib » aws_synthetics » CfnCanary |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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.
To 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 .
Do 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 .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from 'aws-cdk-lib';
const cfnCanary = new synthetics.CfnCanary(this, 'MyCfnCanary', {
artifactS3Location: 'artifactS3Location',
code: {
handler: 'handler',
// the properties below are optional
s3Bucket: 's3Bucket',
s3Key: 's3Key',
s3ObjectVersion: 's3ObjectVersion',
script: 'script',
sourceLocationArn: 'sourceLocationArn',
},
executionRoleArn: 'executionRoleArn',
name: 'name',
runtimeVersion: 'runtimeVersion',
schedule: {
expression: 'expression',
// the properties below are optional
durationInSeconds: 'durationInSeconds',
},
// the properties below are optional
artifactConfig: {
s3Encryption: {
encryptionMode: 'encryptionMode',
kmsKeyArn: 'kmsKeyArn',
},
},
deleteLambdaResourcesOnCanaryDeletion: false,
failureRetentionPeriod: 123,
provisionedResourceCleanup: 'provisionedResourceCleanup',
resourcesToReplicateTags: ['resourcesToReplicateTags'],
runConfig: {
activeTracing: false,
environmentVariables: {
environmentVariablesKey: 'environmentVariables',
},
memoryInMb: 123,
timeoutInSeconds: 123,
},
startCanaryAfterCreation: false,
successRetentionPeriod: 123,
tags: [{
key: 'key',
value: 'value',
}],
visualReference: {
baseCanaryRunId: 'baseCanaryRunId',
// the properties below are optional
baseScreenshots: [{
screenshotName: 'screenshotName',
// the properties below are optional
ignoreCoordinates: ['ignoreCoordinates'],
}],
},
vpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
// the properties below are optional
ipv6AllowedForDualStack: false,
vpcId: 'vpcId',
},
});
Initializer
new CfnCanary(scope: Construct, id: string, props: CfnCanaryProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Canary Props
Construct Props
Name | Type | Description |
---|---|---|
artifact | string | The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. |
code | IResolvable | Code | Use this structure to input your script code for the canary. |
execution | string | The ARN of the IAM role to be used to run the canary. |
name | string | The name for this canary. |
runtime | string | Specifies the runtime version to use for the canary. |
schedule | IResolvable | Schedule | A structure that contains information about how often the canary is to run, and when these runs are to stop. |
artifact | IResolvable | Artifact | A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. |
delete | boolean | IResolvable | Deletes associated lambda resources created by Synthetics if set to True. |
failure | number | The number of days to retain data about failed runs of this canary. |
provisioned | string | Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. |
resources | string[] | To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the value lambda-function . |
run | IResolvable | Run | A structure that contains input information for a canary run. |
start | boolean | IResolvable | Specify TRUE to have the canary start making runs immediately after it is created. |
success | number | The number of days to retain data about successful runs of this canary. |
tags? | Cfn [] | The list of key-value pairs that are associated with the canary. |
visual | IResolvable | Visual | 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. |
vpc | IResolvable | VPCConfig | 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. |
artifactS3Location
Type:
string
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
Artifacts include the log file, screenshots, and HAR files. Specify the full location path, including s3://
at the beginning of the path.
code
Type:
IResolvable
|
Code
Use this structure to input your script code for the canary.
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
.
executionRoleArn
Type:
string
The ARN of the IAM role to be used to run the canary.
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:
s3:PutObject
s3:GetBucketLocation
s3:ListAllMyBuckets
cloudwatch:PutMetricData
logs:CreateLogGroup
logs:CreateLogStream
logs:PutLogEvents
name
Type:
string
The name for this 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 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 .
runtimeVersion
Type:
string
Specifies the runtime version to use for the canary.
For more information about runtime versions, see Canary Runtime Versions .
schedule
Type:
IResolvable
|
Schedule
A structure that contains information about how often the canary is to run, and when these runs are to stop.
artifactConfig?
Type:
IResolvable
|
Artifact
(optional)
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
deleteLambdaResourcesOnCanaryDeletion?
⚠️ Deprecated: this property has been deprecated
Type:
boolean |
IResolvable
(optional)
Deletes associated lambda resources created by Synthetics if set to True.
Default is False
failureRetentionPeriod?
Type:
number
(optional)
The number of days to retain data about failed runs of this canary.
If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns , as well as the range of information displayed in the Synthetics console.
provisionedResourceCleanup?
Type:
string
(optional)
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
If it is AUTOMATIC
, the Lambda functions and layers will be deleted when the canary is deleted.
If the value of this parameter is OFF
, then the value of the DeleteLambda
parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
resourcesToReplicateTags?
Type:
string[]
(optional)
To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the value lambda-function
.
If you do this, CloudWatch Synthetics will keep the tags of the canary and the Lambda function synchronized. Any future changes you make to the canary's tags will also be applied to the function.
runConfig?
Type:
IResolvable
|
Run
(optional)
A structure that contains input information for a canary run.
If you omit this structure, the frequency of the canary is used as canary's timeout value, up to a maximum of 900 seconds.
startCanaryAfterCreation?
Type:
boolean |
IResolvable
(optional)
Specify TRUE to have the canary start making runs immediately after it is created.
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.
successRetentionPeriod?
Type:
number
(optional)
The number of days to retain data about successful runs of this canary.
If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns , as well as the range of information displayed in the Synthetics console.
tags?
Type:
Cfn
[]
(optional)
The list of key-value pairs that are associated with the canary.
visualReference?
Type:
IResolvable
|
Visual
(optional)
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.
vpcConfig?
Type:
IResolvable
|
VPCConfig
(optional)
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.
For more information, see Running a Canary in a VPC .
Properties
Name | Type | Description |
---|---|---|
artifact | string | The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. |
attr | string | Ref returns the ARN of the Lambda layer where Synthetics stores the canary script code. |
attr | string | The ID of the canary. |
attr | string | The state of the canary. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
code | IResolvable | Code | Use this structure to input your script code for the canary. |
creation | string[] | |
execution | string | The ARN of the IAM role to be used to run the canary. |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | The name for this canary. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
runtime | string | Specifies the runtime version to use for the canary. |
schedule | IResolvable | Schedule | A structure that contains information about how often the canary is to run, and when these runs are to stop. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
artifact | IResolvable | Artifact | A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. |
delete | boolean | IResolvable | Deletes associated lambda resources created by Synthetics if set to True. |
failure | number | The number of days to retain data about failed runs of this canary. |
provisioned | string | Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. |
resources | string[] | To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the value lambda-function . |
run | IResolvable | Run | A structure that contains input information for a canary run. |
start | boolean | IResolvable | Specify TRUE to have the canary start making runs immediately after it is created. |
success | number | The number of days to retain data about successful runs of this canary. |
tags | Cfn [] | The list of key-value pairs that are associated with the canary. |
visual | IResolvable | Visual | 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. |
vpc | IResolvable | VPCConfig | 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. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
artifactS3Location
Type:
string
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
attrCodeSourceLocationArn
Type:
string
Ref
returns the ARN of the Lambda layer where Synthetics stores the canary script code.
attrId
Type:
string
The ID of the canary.
attrState
Type:
string
The state of the canary.
For example, RUNNING
.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
code
Type:
IResolvable
|
Code
Use this structure to input your script code for the canary.
creationStack
Type:
string[]
executionRoleArn
Type:
string
The ARN of the IAM role to be used to run the canary.
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
name
Type:
string
The name for this canary.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
runtimeVersion
Type:
string
Specifies the runtime version to use for the canary.
schedule
Type:
IResolvable
|
Schedule
A structure that contains information about how often the canary is to run, and when these runs are to stop.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
artifactConfig?
Type:
IResolvable
|
Artifact
(optional)
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
deleteLambdaResourcesOnCanaryDeletion?
⚠️ Deprecated: this property has been deprecated
Type:
boolean |
IResolvable
(optional)
Deletes associated lambda resources created by Synthetics if set to True.
failureRetentionPeriod?
Type:
number
(optional)
The number of days to retain data about failed runs of this canary.
provisionedResourceCleanup?
Type:
string
(optional)
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
resourcesToReplicateTags?
Type:
string[]
(optional)
To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this property with the value lambda-function
.
runConfig?
Type:
IResolvable
|
Run
(optional)
A structure that contains input information for a canary run.
startCanaryAfterCreation?
Type:
boolean |
IResolvable
(optional)
Specify TRUE to have the canary start making runs immediately after it is created.
successRetentionPeriod?
Type:
number
(optional)
The number of days to retain data about successful runs of this canary.
tagsRaw?
Type:
Cfn
[]
(optional)
The list of key-value pairs that are associated with the canary.
visualReference?
Type:
IResolvable
|
Visual
(optional)
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.
vpcConfig?
Type:
IResolvable
|
VPCConfig
(optional)
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.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }