Struct UpdateCanaryInput 

#[non_exhaustive]
pub struct UpdateCanaryInput {

    pub name: Option<String>,
    pub code: Option<CanaryCodeInput>,
    pub execution_role_arn: Option<String>,
    pub runtime_version: Option<String>,
    pub schedule: Option<CanaryScheduleInput>,
    pub run_config: Option<CanaryRunConfigInput>,
    pub success_retention_period_in_days: Option<i32>,
    pub failure_retention_period_in_days: Option<i32>,
    pub vpc_config: Option<VpcConfigInput>,
    pub visual_reference: Option<VisualReferenceInput>,
    pub artifact_s3_location: Option<String>,
    pub artifact_config: Option<ArtifactConfigInput>,
    pub provisioned_resource_cleanup: Option<ProvisionedResourceCleanupSetting>,
    pub dry_run_id: Option<String>,
    pub visual_references: Option<Vec<VisualReferenceInput>>,
    pub browser_configs: Option<Vec<BrowserConfig>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

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

You cannot change the name of a canary that has already been created.

code: Option<CanaryCodeInput>

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

execution_role_arn: Option<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:CreateLogStream

runtime_version: Option<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: Option<CanaryScheduleInput>

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

run_config: Option<CanaryRunConfigInput>

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

Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

success_retention_period_in_days: Option<i32>

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

This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

failure_retention_period_in_days: Option<i32>

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

This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

vpc_config: Option<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.

visual_reference: Option<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.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

artifact_s3_location: Option<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 (.).

artifact_config: Option<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.

provisioned_resource_cleanup: Option<ProvisionedResourceCleanupSetting>

Specifies whether to also delete the Lambda functions and layers used by this canary 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.

dry_run_id: Option<String>

Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.

When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.

visual_references: Option<Vec<VisualReferenceInput>>

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.

For multibrowser visual monitoring, you can update the baseline for all configured browsers in a single update call by specifying a list of VisualReference objects, one per browser. Each VisualReference object maps to a specific browser configuration, allowing you to manage visual baselines for multiple browsers simultaneously.

For single configuration canaries using Chrome browser (default browser), use visualReferences for syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above canaries. The browserType in the visualReference object is not mandatory.

browser_configs: Option<Vec<BrowserConfig>>

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.

Implementations

impl UpdateCanaryInput

pub fn name(&self) -> Option<&str>

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

You cannot change the name of a canary that has already been created.

pub fn code(&self) -> Option<&CanaryCodeInput>

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

pub fn execution_role_arn(&self) -> Option<&str>

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:CreateLogStream

pub fn runtime_version(&self) -> Option<&str>

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.

pub fn schedule(&self) -> Option<&CanaryScheduleInput>

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

pub fn run_config(&self) -> Option<&CanaryRunConfigInput>

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

Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.

pub fn success_retention_period_in_days(&self) -> Option<i32>

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

This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

pub fn failure_retention_period_in_days(&self) -> Option<i32>

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

This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.

pub fn vpc_config(&self) -> Option<&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.

pub fn visual_reference(&self) -> Option<&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.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

pub fn artifact_s3_location(&self) -> Option<&str>

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 (.).

pub fn artifact_config(&self) -> Option<&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.

pub fn provisioned_resource_cleanup( &self, ) -> Option<&ProvisionedResourceCleanupSetting>

Specifies whether to also delete the Lambda functions and layers used by this canary 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.

pub fn dry_run_id(&self) -> Option<&str>

Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.

When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.

pub fn visual_references(&self) -> &[VisualReferenceInput]

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.

For multibrowser visual monitoring, you can update the baseline for all configured browsers in a single update call by specifying a list of VisualReference objects, one per browser. Each VisualReference object maps to a specific browser configuration, allowing you to manage visual baselines for multiple browsers simultaneously.

For single configuration canaries using Chrome browser (default browser), use visualReferences for syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above canaries. The browserType in the visualReference object is not mandatory.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .visual_references.is_none().

pub fn browser_configs(&self) -> &[BrowserConfig]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .browser_configs.is_none().

impl UpdateCanaryInput

pub fn builder() -> UpdateCanaryInputBuilder

Creates a new builder-style object to manufacture UpdateCanaryInput.

Trait Implementations

impl Clone for UpdateCanaryInput

fn clone(&self) -> UpdateCanaryInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateCanaryInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateCanaryInput

fn eq(&self, other: &UpdateCanaryInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateCanaryInput