Struct aws_sdk_synthetics::client::fluent_builders::CreateCanary

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

Fluent builder constructing a request to CreateCanary.

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once.

Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.

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

Implementations

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

pub async fn send(
    self
) -> Result<CreateCanaryOutput, SdkError<CreateCanaryError>> where
    R::Policy: SmithyRetryPolicy<CreateCanaryInputOperationOutputAlias, CreateCanaryOutput, CreateCanaryError, CreateCanaryInputOperationRetryAlias>, 

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

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

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

pub fn schedule(self, input: CanaryScheduleInput) -> Self

A structure that contains information about how often the canary is to run and when these test 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 test runs are to stop.

pub fn run_config(self, input: CanaryRunConfigInput) -> Self

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

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

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

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

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.

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

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

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.

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

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 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 more information about runtime versions, see Canary Runtime Versions.

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 tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_tags.

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.

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

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.

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 CreateCanary<C, M, R>

fn clone(&self) -> CreateCanary<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 CreateCanary<C, M, R>

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

Formats the value using the given formatter.