synthetics/aws.sdk.kotlin.services.synthetics.model/UpdateCanaryRequest/Builder

Builder

Properties

var artifactConfig: ArtifactConfigInput?

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

artifactS3Location

var artifactS3Location: String?

The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).

code

var code: CanaryCodeInput?

A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.

executionRoleArn

var executionRoleArn: 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:

failureRetentionPeriodInDays

var failureRetentionPeriodInDays: Int?

The number of days to retain data about failed runs of this canary.

name

var name: String?

The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.

runConfig

var runConfig: CanaryRunConfigInput?

A structure that contains the timeout value that is used for each individual run of the canary.

runtimeVersion

var runtimeVersion: String?

Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.

schedule

var schedule: CanaryScheduleInput?

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

successRetentionPeriodInDays

var successRetentionPeriodInDays: Int?

The number of days to retain data about successful runs of this canary.

visualReference

var visualReference: VisualReferenceInput?

Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.

vpcConfig

var vpcConfig: VpcConfigInput?

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.