Struct aws_sdk_synthetics::client::fluent_builders::UpdateCanary

pub struct UpdateCanary<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to UpdateCanary.

Use this operation to change the settings of a canary that has already been created.

You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.

Implementations

impl<C, M, R> UpdateCanary<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<UpdateCanaryOutput, SdkError<UpdateCanaryError>> where
    R::Policy: SmithyRetryPolicy<UpdateCanaryInputOperationOutputAlias, UpdateCanaryOutput, UpdateCanaryError, UpdateCanaryInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

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 set_name(self, input: Option<String>) -> Self

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, input: CanaryCodeInput) -> Self

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.

pub fn set_code(self, input: Option<CanaryCodeInput>) -> Self

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.

pub fn execution_role_arn(self, input: impl Into<String>) -> Self

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 set_execution_role_arn(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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 set_runtime_version(self, input: Option<String>) -> Self

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, input: CanaryScheduleInput) -> Self

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

pub fn set_schedule(self, input: Option<CanaryScheduleInput>) -> Self

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, input: CanaryRunConfigInput) -> Self

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

pub fn set_run_config(self, input: Option<CanaryRunConfigInput>) -> Self

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

pub fn success_retention_period_in_days(self, input: i32) -> Self

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

pub fn set_success_retention_period_in_days(self, input: Option<i32>) -> Self

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

pub fn failure_retention_period_in_days(self, input: i32) -> Self

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

pub fn set_failure_retention_period_in_days(self, input: Option<i32>) -> Self

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

pub fn vpc_config(self, input: VpcConfigInput) -> Self

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 set_vpc_config(self, input: Option<VpcConfigInput>) -> Self

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, input: VisualReferenceInput) -> Self

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 set_visual_reference(self, input: Option<VisualReferenceInput>) -> Self

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, input: impl Into<String>) -> Self

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

pub fn set_artifact_s3_location(self, input: Option<String>) -> Self

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

pub fn artifact_config(self, input: ArtifactConfigInput) -> Self

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 set_artifact_config(self, input: Option<ArtifactConfigInput>) -> Self

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for UpdateCanary<C, M, R>

fn clone(&self) -> UpdateCanary<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for UpdateCanary<C, M, R>

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

Formats the value using the given formatter.