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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delete_lambdaBoolean

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)


1097
1098
1099
1100
1101
1102
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1097

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

#nameString

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

Returns:

  • (String)


1097
1098
1099
1100
1101
1102
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1097

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