synthetics/aws.sdk.kotlin.services.synthetics.model/StartCanaryDryRunRequest/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 Amazon S3 bucket can't include a period (.).

code

var code: CanaryCodeInput?

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 Amazon S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.

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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

name

var name: String?

The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.

provisionedResourceCleanup

var provisionedResourceCleanup: ProvisionedResourceCleanupSetting?

Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.

runConfig

var runConfig: CanaryRunConfigInput?

A structure that contains input information for a canary run.

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.

successRetentionPeriodInDays

var successRetentionPeriodInDays: Int?

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.

visualReference

var visualReference: VisualReferenceInput?

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.

vpcConfig

var vpcConfig: VpcConfigInput?

If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Functions

artifactConfig

fun artifactConfig(block: ArtifactConfigInput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.ArtifactConfigInput inside the given block

code

fun code(block: CanaryCodeInput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.CanaryCodeInput inside the given block

runConfig

fun runConfig(block: CanaryRunConfigInput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.CanaryRunConfigInput inside the given block

visualReference

fun visualReference(block: VisualReferenceInput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.VisualReferenceInput inside the given block

vpcConfig

fun vpcConfig(block: VpcConfigInput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.VpcConfigInput inside the given block