Struct aws_sdk_synthetics::model::Canary

#[non_exhaustive]
pub struct Canary {

    pub id: Option<String>,
    pub name: Option<String>,
    pub code: Option<CanaryCodeOutput>,
    pub execution_role_arn: Option<String>,
    pub schedule: Option<CanaryScheduleOutput>,
    pub run_config: Option<CanaryRunConfigOutput>,
    pub success_retention_period_in_days: Option<i32>,
    pub failure_retention_period_in_days: Option<i32>,
    pub status: Option<CanaryStatus>,
    pub timeline: Option<CanaryTimeline>,
    pub artifact_s3_location: Option<String>,
    pub engine_arn: Option<String>,
    pub runtime_version: Option<String>,
    pub vpc_config: Option<VpcConfigOutput>,
    pub visual_reference: Option<VisualReferenceOutput>,
    pub tags: Option<HashMap<String, String>>,
    pub artifact_config: Option<ArtifactConfigOutput>,
}

This structure contains all information about one canary in your account.

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.

id: Option<String>

The unique ID of this canary.

name: Option<String>

The name of the canary.

code: Option<CanaryCodeOutput>

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.

execution_role_arn: Option<String>

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

schedule: Option<CanaryScheduleOutput>

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

run_config: Option<CanaryRunConfigOutput>

A structure that contains information about a canary run.

success_retention_period_in_days: Option<i32>

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

failure_retention_period_in_days: Option<i32>

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

status: Option<CanaryStatus>

A structure that contains information about the canary's status.

timeline: Option<CanaryTimeline>

A structure that contains information about when the canary was created, modified, and most recently run.

artifact_s3_location: Option<String>

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

engine_arn: Option<String>

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

runtime_version: Option<String>

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

vpc_config: Option<VpcConfigOutput>

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.

visual_reference: Option<VisualReferenceOutput>

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

tags: Option<HashMap<String, String>>

The list of key-value pairs that are associated with the canary.

artifact_config: Option<ArtifactConfigOutput>

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

Implementations

impl Canary

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

The unique ID of this canary.

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

The name of the canary.

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

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.

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

The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.

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

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<&CanaryRunConfigOutput>

A structure that contains information about a canary run.

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

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

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

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

pub fn status(&self) -> Option<&CanaryStatus>

A structure that contains information about the canary's status.

pub fn timeline(&self) -> Option<&CanaryTimeline>

A structure that contains information about when the canary was created, modified, and most recently run.

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

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

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

The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see Resources and Conditions for Lambda Actions.

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

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

pub fn vpc_config(&self) -> Option<&VpcConfigOutput>

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.

pub fn visual_reference(&self) -> Option<&VisualReferenceOutput>

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The list of key-value pairs that are associated with the canary.

pub fn artifact_config(&self) -> Option<&ArtifactConfigOutput>

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

impl Canary

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Canary

Trait Implementations

impl Clone for Canary

fn clone(&self) -> Canary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Canary

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

Formats the value using the given formatter.

impl PartialEq<Canary> for Canary

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Canary