#[non_exhaustive]pub struct Canary {Show 22 fields
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 provisioned_resource_cleanup: Option<ProvisionedResourceCleanupSetting>,
pub browser_configs: Option<Vec<BrowserConfig>>,
pub engine_configs: Option<Vec<EngineConfig>>,
pub visual_references: Option<Vec<VisualReferenceOutput>>,
pub tags: Option<HashMap<String, String>>,
pub artifact_config: Option<ArtifactConfigOutput>,
pub dry_run_config: Option<DryRunConfigOutput>,
}Expand description
This structure contains all information about one canary in your account.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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.
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.
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.
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 it is AUTOMATIC, the Lambda functions and layers will be deleted 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.
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.
engine_configs: Option<Vec<EngineConfig>>A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.
All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions.
Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.
visual_references: Option<Vec<VisualReferenceOutput>>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.
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.
dry_run_config: Option<DryRunConfigOutput>Returns the dry run configurations for a canary.
Implementations§
Source§impl Canary
impl Canary
Sourcepub fn code(&self) -> Option<&CanaryCodeOutput>
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.
Sourcepub fn execution_role_arn(&self) -> Option<&str>
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.
Sourcepub fn schedule(&self) -> Option<&CanaryScheduleOutput>
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.
Sourcepub fn run_config(&self) -> Option<&CanaryRunConfigOutput>
pub fn run_config(&self) -> Option<&CanaryRunConfigOutput>
A structure that contains information about a canary run.
Sourcepub fn success_retention_period_in_days(&self) -> Option<i32>
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.
Sourcepub fn failure_retention_period_in_days(&self) -> Option<i32>
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.
Sourcepub fn status(&self) -> Option<&CanaryStatus>
pub fn status(&self) -> Option<&CanaryStatus>
A structure that contains information about the canary's status.
Sourcepub fn timeline(&self) -> Option<&CanaryTimeline>
pub fn timeline(&self) -> Option<&CanaryTimeline>
A structure that contains information about when the canary was created, modified, and most recently run.
Sourcepub fn artifact_s3_location(&self) -> Option<&str>
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.
Sourcepub fn engine_arn(&self) -> Option<&str>
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.
Sourcepub fn runtime_version(&self) -> Option<&str>
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.
Sourcepub fn vpc_config(&self) -> Option<&VpcConfigOutput>
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.
Sourcepub fn visual_reference(&self) -> Option<&VisualReferenceOutput>
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.
Sourcepub fn provisioned_resource_cleanup(
&self,
) -> Option<&ProvisionedResourceCleanupSetting>
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 it is AUTOMATIC, the Lambda functions and layers will be deleted 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.
Sourcepub fn browser_configs(&self) -> &[BrowserConfig]
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().
Sourcepub fn engine_configs(&self) -> &[EngineConfig]
pub fn engine_configs(&self) -> &[EngineConfig]
A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.
All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. You can no longer use engineArn in these versions.
Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .engine_configs.is_none().
Sourcepub fn visual_references(&self) -> &[VisualReferenceOutput]
pub fn visual_references(&self) -> &[VisualReferenceOutput]
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.
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().
The list of key-value pairs that are associated with the canary.
Sourcepub fn artifact_config(&self) -> Option<&ArtifactConfigOutput>
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.
Sourcepub fn dry_run_config(&self) -> Option<&DryRunConfigOutput>
pub fn dry_run_config(&self) -> Option<&DryRunConfigOutput>
Returns the dry run configurations for a canary.
Trait Implementations§
impl StructuralPartialEq for Canary
Auto Trait Implementations§
impl Freeze for Canary
impl RefUnwindSafe for Canary
impl Send for Canary
impl Sync for Canary
impl Unpin for Canary
impl UnwindSafe for Canary
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);