Package software.amazon.awscdk.cfnpropertymixins.services.synthetics

Class CfnCanaryPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.synthetics.CfnCanaryPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCanaryPropsMixin>

Enclosing class:

CfnCanaryPropsMixin

@Stability(Stable)
public static final class CfnCanaryPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCanaryPropsMixin>

A fluent builder for CfnCanaryPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnCanaryPropsMixin.Builder	artifactConfig(CfnCanaryPropsMixin.ArtifactConfigProperty artifactConfig)	A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
CfnCanaryPropsMixin.Builder	artifactConfig(IResolvable artifactConfig)	A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
CfnCanaryPropsMixin.Builder	artifactS3Location(String artifactS3Location)	The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary.
CfnCanaryPropsMixin.Builder	browserConfigs(List<? extends Object> browserConfigs)	A structure that specifies the browser type to use for a canary run.
CfnCanaryPropsMixin.Builder	browserConfigs(IResolvable browserConfigs)	A structure that specifies the browser type to use for a canary run.
CfnCanaryPropsMixin	build()
CfnCanaryPropsMixin.Builder	code(CfnCanaryPropsMixin.CodeProperty code)	Use this structure to input your script code for the canary.
CfnCanaryPropsMixin.Builder	code(IResolvable code)	Use this structure to input your script code for the canary.
static CfnCanaryPropsMixin.Builder	create()
static CfnCanaryPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnCanaryPropsMixin.Builder	deleteLambdaResourcesOnCanaryDeletion(Boolean deleteLambdaResourcesOnCanaryDeletion)	Deprecated. this property has been deprecated
CfnCanaryPropsMixin.Builder	deleteLambdaResourcesOnCanaryDeletion(IResolvable deleteLambdaResourcesOnCanaryDeletion)	Deprecated. this property has been deprecated
CfnCanaryPropsMixin.Builder	dryRunAndUpdate(Boolean dryRunAndUpdate)	Specifies whether to perform a dry run before updating the canary.
CfnCanaryPropsMixin.Builder	dryRunAndUpdate(IResolvable dryRunAndUpdate)	Specifies whether to perform a dry run before updating the canary.
CfnCanaryPropsMixin.Builder	executionRoleArn(String executionRoleArn)	The ARN of the IAM role to be used to run the canary.
CfnCanaryPropsMixin.Builder	executionRoleArn(IRoleRef executionRoleArn)	The ARN of the IAM role to be used to run the canary.
CfnCanaryPropsMixin.Builder	failureRetentionPeriod(Number failureRetentionPeriod)	The number of days to retain data about failed runs of this canary.
CfnCanaryPropsMixin.Builder	name(String name)	The name for this canary.
CfnCanaryPropsMixin.Builder	provisionedResourceCleanup(String provisionedResourceCleanup)	Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
CfnCanaryPropsMixin.Builder	resourcesToReplicateTags(List<String> resourcesToReplicateTags)	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 .
CfnCanaryPropsMixin.Builder	runConfig(CfnCanaryPropsMixin.RunConfigProperty runConfig)	A structure that contains input information for a canary run.
CfnCanaryPropsMixin.Builder	runConfig(IResolvable runConfig)	A structure that contains input information for a canary run.
CfnCanaryPropsMixin.Builder	runtimeVersion(String runtimeVersion)	Specifies the runtime version to use for the canary.
CfnCanaryPropsMixin.Builder	schedule(CfnCanaryPropsMixin.ScheduleProperty schedule)	A structure that contains information about how often the canary is to run, and when these runs are to stop.
CfnCanaryPropsMixin.Builder	schedule(IResolvable schedule)	A structure that contains information about how often the canary is to run, and when these runs are to stop.
CfnCanaryPropsMixin.Builder	startCanaryAfterCreation(Boolean startCanaryAfterCreation)	Specify TRUE to have the canary start making runs immediately after it is created.
CfnCanaryPropsMixin.Builder	startCanaryAfterCreation(IResolvable startCanaryAfterCreation)	Specify TRUE to have the canary start making runs immediately after it is created.
CfnCanaryPropsMixin.Builder	successRetentionPeriod(Number successRetentionPeriod)	The number of days to retain data about successful runs of this canary.
CfnCanaryPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The list of key-value pairs that are associated with the canary.
CfnCanaryPropsMixin.Builder	visualReference(CfnCanaryPropsMixin.VisualReferenceProperty visualReference)	Deprecated. this property has been deprecated
CfnCanaryPropsMixin.Builder	visualReference(IResolvable visualReference)	Deprecated. this property has been deprecated
CfnCanaryPropsMixin.Builder	visualReferences(List<? extends Object> visualReferences)	A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.
CfnCanaryPropsMixin.Builder	visualReferences(IResolvable visualReferences)	A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.
CfnCanaryPropsMixin.Builder	vpcConfig(CfnCanaryPropsMixin.VPCConfigProperty 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.
CfnCanaryPropsMixin.Builder	vpcConfig(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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCanaryPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnCanaryPropsMixin.Builder.

create

@Stability(Stable)
public static CfnCanaryPropsMixin.Builder create()

Returns:

a new instance of CfnCanaryPropsMixin.Builder.

artifactConfig

@Stability(Stable)
public CfnCanaryPropsMixin.Builder artifactConfig(IResolvable artifactConfig)

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Parameters:

artifactConfig - A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifactconfig

artifactConfig

@Stability(Stable)
public CfnCanaryPropsMixin.Builder artifactConfig(CfnCanaryPropsMixin.ArtifactConfigProperty artifactConfig)

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

Parameters:

artifactConfig - A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifactconfig

artifactS3Location

@Stability(Stable)
public CfnCanaryPropsMixin.Builder artifactS3Location(String artifactS3Location)

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.

Parameters:

artifactS3Location - The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-artifacts3location

browserConfigs

@Stability(Stable)
public CfnCanaryPropsMixin.Builder browserConfigs(IResolvable browserConfigs)

A structure that specifies the browser type to use for a canary run.

CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

If not specified, browserConfigs defaults to Chrome.

Parameters:

browserConfigs - A structure that specifies the browser type to use for a canary run. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-browserconfigs

browserConfigs

@Stability(Stable)
public CfnCanaryPropsMixin.Builder browserConfigs(List<? extends Object> browserConfigs)

A structure that specifies the browser type to use for a canary run.

CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

If not specified, browserConfigs defaults to Chrome.

Parameters:

browserConfigs - A structure that specifies the browser type to use for a canary run. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-browserconfigs

code

@Stability(Stable)
public CfnCanaryPropsMixin.Builder code(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 .

Parameters:

code - Use this structure to input your script code for the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-code

code

@Stability(Stable)
public CfnCanaryPropsMixin.Builder code(CfnCanaryPropsMixin.CodeProperty 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 .

Parameters:

code - Use this structure to input your script code for the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-code

deleteLambdaResourcesOnCanaryDeletion

@Stability(Deprecated)
@Deprecated
public CfnCanaryPropsMixin.Builder deleteLambdaResourcesOnCanaryDeletion(Boolean deleteLambdaResourcesOnCanaryDeletion)

Deprecated.

this property has been deprecated

(deprecated) Deletes associated lambda resources created by Synthetics if set to True.

Default is False

Parameters:

deleteLambdaResourcesOnCanaryDeletion - Deletes associated lambda resources created by Synthetics if set to True. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-deletelambdaresourcesoncanarydeletion

deleteLambdaResourcesOnCanaryDeletion

@Stability(Deprecated)
@Deprecated
public CfnCanaryPropsMixin.Builder deleteLambdaResourcesOnCanaryDeletion(IResolvable deleteLambdaResourcesOnCanaryDeletion)

Deprecated.

this property has been deprecated

(deprecated) Deletes associated lambda resources created by Synthetics if set to True.

Default is False

Parameters:

deleteLambdaResourcesOnCanaryDeletion - Deletes associated lambda resources created by Synthetics if set to True. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-deletelambdaresourcesoncanarydeletion

dryRunAndUpdate

@Stability(Stable)
public CfnCanaryPropsMixin.Builder dryRunAndUpdate(Boolean dryRunAndUpdate)

Specifies whether to perform a dry run before updating the canary.

If set to true , CloudFormation will execute a dry run to validate the changes before applying them to the canary. If the dry run succeeds, the canary will be updated with the changes. If the dry run fails, the CloudFormation deployment will fail with the dry run’s failure reason.

If set to false or omitted, the canary will be updated directly without first performing a dry run. The default value is false .

For more information, see Performing safe canary updates .

Parameters:

dryRunAndUpdate - Specifies whether to perform a dry run before updating the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-dryrunandupdate

dryRunAndUpdate

@Stability(Stable)
public CfnCanaryPropsMixin.Builder dryRunAndUpdate(IResolvable dryRunAndUpdate)

Specifies whether to perform a dry run before updating the canary.

If set to true , CloudFormation will execute a dry run to validate the changes before applying them to the canary. If the dry run succeeds, the canary will be updated with the changes. If the dry run fails, the CloudFormation deployment will fail with the dry run’s failure reason.

If set to false or omitted, the canary will be updated directly without first performing a dry run. The default value is false .

For more information, see Performing safe canary updates .

Parameters:

dryRunAndUpdate - Specifies whether to perform a dry run before updating the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-dryrunandupdate

executionRoleArn

@Stability(Stable)
public CfnCanaryPropsMixin.Builder executionRoleArn(String executionRoleArn)

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

Parameters:

executionRoleArn - The ARN of the IAM role to be used to run the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn

executionRoleArn

@Stability(Stable)
public CfnCanaryPropsMixin.Builder executionRoleArn(IRoleRef executionRoleArn)

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

Parameters:

executionRoleArn - The ARN of the IAM role to be used to run the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn

failureRetentionPeriod

@Stability(Stable)
public CfnCanaryPropsMixin.Builder failureRetentionPeriod(Number failureRetentionPeriod)

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.

Parameters:

failureRetentionPeriod - The number of days to retain data about failed runs of this canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-failureretentionperiod

name

@Stability(Stable)
public CfnCanaryPropsMixin.Builder name(String name)

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 .

Parameters:

name - The name for this canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-name

provisionedResourceCleanup

@Stability(Stable)
public CfnCanaryPropsMixin.Builder provisionedResourceCleanup(String provisionedResourceCleanup)

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.

Parameters:

provisionedResourceCleanup - Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-provisionedresourcecleanup

resourcesToReplicateTags

@Stability(Stable)
public CfnCanaryPropsMixin.Builder resourcesToReplicateTags(List<String> resourcesToReplicateTags)

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.

Parameters:

resourcesToReplicateTags - 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 . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-resourcestoreplicatetags

runConfig

@Stability(Stable)
public CfnCanaryPropsMixin.Builder runConfig(IResolvable runConfig)

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.

Parameters:

runConfig - A structure that contains input information for a canary run. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runconfig

runConfig

@Stability(Stable)
public CfnCanaryPropsMixin.Builder runConfig(CfnCanaryPropsMixin.RunConfigProperty runConfig)

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.

Parameters:

runConfig - A structure that contains input information for a canary run. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runconfig

runtimeVersion

@Stability(Stable)
public CfnCanaryPropsMixin.Builder runtimeVersion(String runtimeVersion)

Specifies the runtime version to use for the canary.

For more information about runtime versions, see Canary Runtime Versions .

Parameters:

runtimeVersion - Specifies the runtime version to use for the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-runtimeversion

schedule

@Stability(Stable)
public CfnCanaryPropsMixin.Builder schedule(IResolvable schedule)

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Parameters:

schedule - A structure that contains information about how often the canary is to run, and when these runs are to stop. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-schedule

schedule

@Stability(Stable)
public CfnCanaryPropsMixin.Builder schedule(CfnCanaryPropsMixin.ScheduleProperty schedule)

A structure that contains information about how often the canary is to run, and when these runs are to stop.

Parameters:

schedule - A structure that contains information about how often the canary is to run, and when these runs are to stop. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-schedule

startCanaryAfterCreation

@Stability(Stable)
public CfnCanaryPropsMixin.Builder startCanaryAfterCreation(Boolean startCanaryAfterCreation)

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.

Parameters:

startCanaryAfterCreation - Specify TRUE to have the canary start making runs immediately after it is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-startcanaryaftercreation

startCanaryAfterCreation

@Stability(Stable)
public CfnCanaryPropsMixin.Builder startCanaryAfterCreation(IResolvable startCanaryAfterCreation)

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.

Parameters:

startCanaryAfterCreation - Specify TRUE to have the canary start making runs immediately after it is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-startcanaryaftercreation

successRetentionPeriod

@Stability(Stable)
public CfnCanaryPropsMixin.Builder successRetentionPeriod(Number successRetentionPeriod)

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.

Parameters:

successRetentionPeriod - The number of days to retain data about successful runs of this canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-successretentionperiod

tags

@Stability(Stable)
public CfnCanaryPropsMixin.Builder tags(List<? extends CfnTag> tags)

The list of key-value pairs that are associated with the canary.

Parameters:

tags - The list of key-value pairs that are associated with the canary. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-tags

visualReference

@Stability(Deprecated)
@Deprecated
public CfnCanaryPropsMixin.Builder visualReference(IResolvable visualReference)

Deprecated.

this property has been deprecated

Parameters:

visualReference - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreference

visualReference

@Stability(Deprecated)
@Deprecated
public CfnCanaryPropsMixin.Builder visualReference(CfnCanaryPropsMixin.VisualReferenceProperty visualReference)

Deprecated.

this property has been deprecated

Parameters:

visualReference - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreference

visualReferences

@Stability(Stable)
public CfnCanaryPropsMixin.Builder visualReferences(IResolvable visualReferences)

A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.

Visual references are used for visual monitoring comparisons.

syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences . visualReference field is not supported.

Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences for consistency and future compatibility.

Parameters:

visualReferences - A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreferences

visualReferences

@Stability(Stable)
public CfnCanaryPropsMixin.Builder visualReferences(List<? extends Object> visualReferences)

A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.

Visual references are used for visual monitoring comparisons.

syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences . visualReference field is not supported.

Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences for consistency and future compatibility.

Parameters:

visualReferences - A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-visualreferences

vpcConfig

@Stability(Stable)
public CfnCanaryPropsMixin.Builder vpcConfig(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.

For more information, see Running a Canary in a VPC .

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-vpcconfig

vpcConfig

@Stability(Stable)
public CfnCanaryPropsMixin.Builder vpcConfig(CfnCanaryPropsMixin.VPCConfigProperty 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.

For more information, see Running a Canary in a VPC .

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-vpcconfig

build

@Stability(Stable)
public CfnCanaryPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCanaryPropsMixin>

Returns:

a newly built instance of CfnCanaryPropsMixin.