Struct CreateCanaryInput 

#[non_exhaustive]
pub struct CreateCanaryInput {

    pub name: Option<String>,
    pub code: Option<CanaryCodeInput>,
    pub artifact_s3_location: Option<String>,
    pub execution_role_arn: 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 runtime_version: Option<String>,
    pub vpc_config: Option<VpcConfigInput>,
    pub resources_to_replicate_tags: Option<Vec<ResourceToTag>>,
    pub provisioned_resource_cleanup: Option<ProvisionedResourceCleanupSetting>,
    pub browser_configs: Option<Vec<BrowserConfig>>,
    pub tags: Option<HashMap<String, String>>,
    pub artifact_config: Option<ArtifactConfigInput>,
}

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 for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

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.

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

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

schedule: Option<CanaryScheduleInput>

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

run_config: Option<CanaryRunConfigInput>

A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

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

runtime_version: Option<String>

Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.

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.

resources_to_replicate_tags: Option<Vec<ResourceToTag>>

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.

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 you omit this parameter, the default of AUTOMATIC is used, which means that 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>>

CloudWatch Synthetics now supports multibrowser canaries for syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 runtimes. This feature allows you to run your canaries on both Firefox and Chrome browsers. To create a multibrowser canary, you need to specify the BrowserConfigs with a list of browsers you want to use.

If not specified, browserConfigs defaults to Chrome.

tags: Option<HashMap<String, String>>

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

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.

Implementations

impl CreateCanaryInput

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

The name for this canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

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

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

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

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

A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

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. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.

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

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

Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.

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 resources_to_replicate_tags(&self) -> &[ResourceToTag]

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

If you specify this parameter and don't specify any tags in the Tags parameter, the canary creation fails.

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

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 you omit this parameter, the default of AUTOMATIC is used, which means that 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.

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

CloudWatch Synthetics now supports multibrowser canaries for syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 runtimes. This feature allows you to run your canaries on both Firefox and Chrome browsers. To create a multibrowser canary, you need to specify the BrowserConfigs with a list of browsers you want to use.

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

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

A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.

To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value lambda-function.

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.

impl CreateCanaryInput

pub fn builder() -> CreateCanaryInputBuilder

Creates a new builder-style object to manufacture CreateCanaryInput.

Trait Implementations

impl Clone for CreateCanaryInput

fn clone(&self) -> CreateCanaryInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCanaryInput

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

Formats the value using the given formatter.

impl PartialEq for CreateCanaryInput

fn eq(&self, other: &CreateCanaryInput) -> 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 CreateCanaryInput