Class: Aws::Synthetics::Types::UpdateCanaryRequest

Inherits:

Struct

Object
Struct
Aws::Synthetics::Types::UpdateCanaryRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-synthetics/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#add_replica_locations ⇒ Array<Types::AddReplicaLocationInput>
A list of locations (Amazon Web Services Regions) to add as replicas for the canary.
#artifact_config ⇒ Types::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.
#artifact_s3_location ⇒ String
The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.
#browser_configs ⇒ Array<Types::BrowserConfig>
A structure that specifies the browser type to use for a canary run.
#code ⇒ Types::CanaryCodeInput
A structure that includes the entry point from which the canary should start running your script.
#dry_run_id ⇒ String
Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.
#execution_role_arn ⇒ String
The ARN of the IAM role to be used to run the canary.
#failure_retention_period_in_days ⇒ Integer
The number of days to retain data about failed runs of this canary.
#kms_key_arn ⇒ String
The Amazon Resource Name (ARN) of the customer-managed AWS Key Management Service (AWS KMS) key used to encrypt the canary's AWS Lambda function environment variables at rest.
#name ⇒ String
The name of the canary that you want to update.
#provisioned_resource_cleanup ⇒ String
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
#remove_replica_locations ⇒ Array<String>
A list of locations (Amazon Web Services Regions) to remove as replicas for the canary.
#run_config ⇒ Types::CanaryRunConfigInput
A structure that contains the timeout value that is used for each individual run of the canary.
#runtime_version ⇒ String
Specifies the runtime version to use for the canary.
#schedule ⇒ Types::CanaryScheduleInput
A structure that contains information about how often the canary is to run, and when these runs are to stop.
#success_retention_period_in_days ⇒ Integer
The number of days to retain data about successful runs of this canary.
#visual_reference ⇒ Types::VisualReferenceInput
Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.
#visual_references ⇒ Array<Types::VisualReferenceInput>
A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.
#vpc_config ⇒ Types::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.

Instance Attribute Details

#add_replica_locations ⇒ `Array<Types::AddReplicaLocationInput>`

A list of locations (Amazon Web Services Regions) to add as replicas for the canary. Each location specifies a Region and optional VPC configuration for the replica. You can add up to 50 replica locations.

Returns:

(Array<Types::AddReplicaLocationInput>)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#artifact_config ⇒ `Types::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.

Returns:

(Types::ArtifactConfigInput)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#artifact_s3_location ⇒ `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 (.).

Returns:

(String)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#browser_configs ⇒ `Array<Types::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.

Returns:

(Array<Types::BrowserConfig>)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#code ⇒ `Types::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.

Returns:

(Types::CanaryCodeInput)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run_id ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ `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

Returns:

(String)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#failure_retention_period_in_days ⇒ `Integer`

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.

Returns:

(Integer)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ `String`

The Amazon Resource Name (ARN) of the customer-managed AWS Key Management Service (AWS KMS) key used to encrypt the canary's AWS Lambda function environment variables at rest. If you don't specify a value, the service uses an AWS-managed key. If you omit this parameter, the service retains the existing value. To revert to the AWS-managed key, set this parameter to an empty string.

Returns:

(String)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_resource_cleanup ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#remove_replica_locations ⇒ `Array<String>`

A list of locations (Amazon Web Services Regions) to remove as replicas for the canary. You must specify at least one location to remove. All replicas can be removed in a single API call and you cannot remove the primary location.

Returns:

(Array<String>)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#run_config ⇒ `Types::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.

Returns:

(Types::CanaryRunConfigInput)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_version ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ `Types::CanaryScheduleInput`

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

Returns:

(Types::CanaryScheduleInput)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#success_retention_period_in_days ⇒ `Integer`

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.

Returns:

(Integer)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#visual_reference ⇒ `Types::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

Returns:

(Types::VisualReferenceInput)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#visual_references ⇒ `Array<Types::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.

Returns:

(Array<Types::VisualReferenceInput>)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ `Types::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.

Returns:

(Types::VpcConfigInput)

# File 'lib/aws-sdk-synthetics/types.rb', line 2742

class UpdateCanaryRequest < Struct.new(
  :name,
  :code,
  :execution_role_arn,
  :runtime_version,
  :schedule,
  :run_config,
  :success_retention_period_in_days,
  :failure_retention_period_in_days,
  :vpc_config,
  :visual_reference,
  :artifact_s3_location,
  :artifact_config,
  :provisioned_resource_cleanup,
  :dry_run_id,
  :visual_references,
  :browser_configs,
  :add_replica_locations,
  :remove_replica_locations,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Synthetics::Types::UpdateCanaryRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#add_replica_locations ⇒ Array<Types::AddReplicaLocationInput>

#artifact_config ⇒ Types::ArtifactConfigInput

#artifact_s3_location ⇒ String

#browser_configs ⇒ Array<Types::BrowserConfig>

#code ⇒ Types::CanaryCodeInput

#dry_run_id ⇒ String

#execution_role_arn ⇒ String

#failure_retention_period_in_days ⇒ Integer

#kms_key_arn ⇒ String

#name ⇒ String

#provisioned_resource_cleanup ⇒ String

#remove_replica_locations ⇒ Array<String>

#run_config ⇒ Types::CanaryRunConfigInput

#runtime_version ⇒ String

#schedule ⇒ Types::CanaryScheduleInput

#success_retention_period_in_days ⇒ Integer

#visual_reference ⇒ Types::VisualReferenceInput

#visual_references ⇒ Array<Types::VisualReferenceInput>

#vpc_config ⇒ Types::VpcConfigInput

#add_replica_locations ⇒ `Array<Types::AddReplicaLocationInput>`

#artifact_config ⇒ `Types::ArtifactConfigInput`

#artifact_s3_location ⇒ `String`

#browser_configs ⇒ `Array<Types::BrowserConfig>`

#code ⇒ `Types::CanaryCodeInput`

#dry_run_id ⇒ `String`

#execution_role_arn ⇒ `String`

#failure_retention_period_in_days ⇒ `Integer`

#kms_key_arn ⇒ `String`

#name ⇒ `String`

#provisioned_resource_cleanup ⇒ `String`

#remove_replica_locations ⇒ `Array<String>`

#run_config ⇒ `Types::CanaryRunConfigInput`

#runtime_version ⇒ `String`

#schedule ⇒ `Types::CanaryScheduleInput`

#success_retention_period_in_days ⇒ `Integer`

#visual_reference ⇒ `Types::VisualReferenceInput`

#visual_references ⇒ `Array<Types::VisualReferenceInput>`

#vpc_config ⇒ `Types::VpcConfigInput`