Struct aws_sdk_synthetics::client::fluent_builders::DeleteCanary

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

Fluent builder constructing a request to DeleteCanary.

Permanently deletes the specified canary.

When you delete a canary, resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

• The Lambda functions and layers used by this canary. These have the prefix cwsyn-MyCanaryName .

• The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName .

• Amazon S3 objects and buckets, such as the canary's artifact location.

• IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName .

• CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName .

Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

Implementations

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

pub async fn send(
    self
) -> Result<DeleteCanaryOutput, SdkError<DeleteCanaryError>> where
    R::Policy: SmithyRetryPolicy<DeleteCanaryInputOperationOutputAlias, DeleteCanaryOutput, DeleteCanaryError, DeleteCanaryInputOperationRetryAlias>, 

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 delete. To find the names of your canaries, use DescribeCanaries.

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

The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

Trait Implementations

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

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

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

Formats the value using the given formatter.