| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Synthetics.DeleteCanary
Description
Permanently deletes the specified canary.
If you specify DeleteLambda to true, CloudWatch Synthetics also
deletes the Lambda functions and layers that are used by the canary.
Other 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 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.
Synopsis
- data DeleteCanary = DeleteCanary' {
- deleteLambda :: Maybe Bool
- name :: Text
- newDeleteCanary :: Text -> DeleteCanary
- deleteCanary_deleteLambda :: Lens' DeleteCanary (Maybe Bool)
- deleteCanary_name :: Lens' DeleteCanary Text
- data DeleteCanaryResponse = DeleteCanaryResponse' {
- httpStatus :: Int
- newDeleteCanaryResponse :: Int -> DeleteCanaryResponse
- deleteCanaryResponse_httpStatus :: Lens' DeleteCanaryResponse Int
Creating a Request
data DeleteCanary Source #
See: newDeleteCanary smart constructor.
Constructors
| DeleteCanary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DeleteCanary |
Create a value of DeleteCanary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteLambda:DeleteCanary', deleteCanary_deleteLambda - Specifies whether to also delete the Lambda functions and layers used by
this canary. The default is false.
Type: Boolean
DeleteCanary, deleteCanary_name - The name of the canary that you want to delete. To find the names of
your canaries, use
DescribeCanaries.
Request Lenses
deleteCanary_deleteLambda :: Lens' DeleteCanary (Maybe Bool) Source #
Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.
Type: Boolean
deleteCanary_name :: Lens' DeleteCanary Text Source #
The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.
Destructuring the Response
data DeleteCanaryResponse Source #
See: newDeleteCanaryResponse smart constructor.
Constructors
| DeleteCanaryResponse' | |
Fields
| |
Instances
newDeleteCanaryResponse Source #
Arguments
| :: Int | |
| -> DeleteCanaryResponse |
Create a value of DeleteCanaryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteCanaryResponse', deleteCanaryResponse_httpStatus - The response's http status code.
Response Lenses
deleteCanaryResponse_httpStatus :: Lens' DeleteCanaryResponse Int Source #
The response's http status code.