Class: Aws::Synthetics::Types::DeleteCanaryRequest

Inherits:

Struct

• Object
• Struct
• Aws::Synthetics::Types::DeleteCanaryRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-synthetics/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #delete_lambda ⇒ Boolean

  Specifies whether to also delete the Lambda functions and layers used by this canary.

• #name ⇒ String

  The name of the canary that you want to delete.

Instance Attribute Details

#delete_lambda ⇒ Boolean

Specifies whether to also delete the Lambda functions and layers used by this canary. The default is ‘false`.

Your setting for this parameter is used only if the canary doesn’t have ‘AUTOMATIC` for its `ProvisionedResourceCleanup` field. If that field is set to `AUTOMATIC`, then the Lambda functions and layers will be deleted when this canary is deleted.

Type: Boolean

Returns:

• (Boolean)

# File 'lib/aws-sdk-synthetics/types.rb', line 937

class DeleteCanaryRequest < Struct.new(
  :name,
  :delete_lambda)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

[1]: docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html

Returns:

• (String)

# File 'lib/aws-sdk-synthetics/types.rb', line 937

class DeleteCanaryRequest < Struct.new(
  :name,
  :delete_lambda)
  SENSITIVE = []
  include Aws::Structure
end