Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.Backup.PutBackupVaultNotifications
Description
Turns on notifications on a backup vault for the specified topic and events.
Synopsis
- data PutBackupVaultNotifications = PutBackupVaultNotifications' {}
- newPutBackupVaultNotifications :: Text -> Text -> PutBackupVaultNotifications
- putBackupVaultNotifications_backupVaultName :: Lens' PutBackupVaultNotifications Text
- putBackupVaultNotifications_sNSTopicArn :: Lens' PutBackupVaultNotifications Text
- putBackupVaultNotifications_backupVaultEvents :: Lens' PutBackupVaultNotifications [BackupVaultEvent]
- data PutBackupVaultNotificationsResponse = PutBackupVaultNotificationsResponse' {
- newPutBackupVaultNotificationsResponse :: PutBackupVaultNotificationsResponse
Creating a Request
data PutBackupVaultNotifications Source #
See: newPutBackupVaultNotifications
smart constructor.
Constructors
PutBackupVaultNotifications' | |
Fields
|
Instances
newPutBackupVaultNotifications Source #
Arguments
:: Text | |
-> Text | |
-> PutBackupVaultNotifications |
Create a value of PutBackupVaultNotifications
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:backupVaultName:PutBackupVaultNotifications'
, putBackupVaultNotifications_backupVaultName
- The name of a logical container where backups are stored. Backup vaults
are identified by names that are unique to the account used to create
them and the Amazon Web Services Region where they are created. They
consist of lowercase letters, numbers, and hyphens.
$sel:sNSTopicArn:PutBackupVaultNotifications'
, putBackupVaultNotifications_sNSTopicArn
- The Amazon Resource Name (ARN) that specifies the topic for a backup
vault’s events; for example,
arn:aws:sns:us-west-2:111122223333:MyVaultTopic
.
$sel:backupVaultEvents:PutBackupVaultNotifications'
, putBackupVaultNotifications_backupVaultEvents
- An array of events that indicate the status of jobs to back up resources
to the backup vault.
The following events are supported:
BACKUP_JOB_STARTED
, BACKUP_JOB_COMPLETED
,
COPY_JOB_STARTED
, COPY_JOB_SUCCESSFUL
, COPY_JOB_FAILED
,
RESTORE_JOB_STARTED
, RESTORE_JOB_COMPLETED
, and
RECOVERY_POINT_MODIFIED
.
To find failed backup jobs, use BACKUP_JOB_COMPLETED
and filter using
event metadata.
Other events in the following list are deprecated.
Request Lenses
putBackupVaultNotifications_backupVaultName :: Lens' PutBackupVaultNotifications Text Source #
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
putBackupVaultNotifications_sNSTopicArn :: Lens' PutBackupVaultNotifications Text Source #
The Amazon Resource Name (ARN) that specifies the topic for a backup
vault’s events; for example,
arn:aws:sns:us-west-2:111122223333:MyVaultTopic
.
putBackupVaultNotifications_backupVaultEvents :: Lens' PutBackupVaultNotifications [BackupVaultEvent] Source #
An array of events that indicate the status of jobs to back up resources to the backup vault.
The following events are supported:
BACKUP_JOB_STARTED
, BACKUP_JOB_COMPLETED
,
COPY_JOB_STARTED
, COPY_JOB_SUCCESSFUL
, COPY_JOB_FAILED
,
RESTORE_JOB_STARTED
, RESTORE_JOB_COMPLETED
, and
RECOVERY_POINT_MODIFIED
.
To find failed backup jobs, use BACKUP_JOB_COMPLETED
and filter using
event metadata.
Other events in the following list are deprecated.
Destructuring the Response
data PutBackupVaultNotificationsResponse Source #
See: newPutBackupVaultNotificationsResponse
smart constructor.
Constructors
PutBackupVaultNotificationsResponse' | |
Instances
newPutBackupVaultNotificationsResponse :: PutBackupVaultNotificationsResponse Source #
Create a value of PutBackupVaultNotificationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.