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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Turns on notifications on a backup vault for the specified topic and events.

Creating a Request

data PutBackupVaultNotifications Source #

See: newPutBackupVaultNotifications smart constructor.

Constructors

PutBackupVaultNotifications'

Fields

backupVaultName :: Text
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.
sNSTopicArn :: Text
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.
backupVaultEvents :: [BackupVaultEvent]
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.

Instances

Instances details

Eq PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods (==) :: PutBackupVaultNotifications -> PutBackupVaultNotifications -> Bool # (/=) :: PutBackupVaultNotifications -> PutBackupVaultNotifications -> Bool #
Read PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods readsPrec :: Int -> ReadS PutBackupVaultNotifications # readList :: ReadS [PutBackupVaultNotifications] # readPrec :: ReadPrec PutBackupVaultNotifications # readListPrec :: ReadPrec [PutBackupVaultNotifications] #
Show PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods showsPrec :: Int -> PutBackupVaultNotifications -> ShowS # show :: PutBackupVaultNotifications -> String # showList :: [PutBackupVaultNotifications] -> ShowS #
Generic PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Associated Types type Rep PutBackupVaultNotifications :: Type -> Type # Methods from :: PutBackupVaultNotifications -> Rep PutBackupVaultNotifications x # to :: Rep PutBackupVaultNotifications x -> PutBackupVaultNotifications #
NFData PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods rnf :: PutBackupVaultNotifications -> () #
Hashable PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods hashWithSalt :: Int -> PutBackupVaultNotifications -> Int # hash :: PutBackupVaultNotifications -> Int #
ToJSON PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods toJSON :: PutBackupVaultNotifications -> Value # toEncoding :: PutBackupVaultNotifications -> Encoding # toJSONList :: [PutBackupVaultNotifications] -> Value # toEncodingList :: [PutBackupVaultNotifications] -> Encoding #
AWSRequest PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Associated Types type AWSResponse PutBackupVaultNotifications # Methods request :: PutBackupVaultNotifications -> Request PutBackupVaultNotifications # response :: MonadResource m => Logger -> Service -> Proxy PutBackupVaultNotifications -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutBackupVaultNotifications))) #
ToHeaders PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods toHeaders :: PutBackupVaultNotifications -> [Header] #
ToPath PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods toPath :: PutBackupVaultNotifications -> ByteString #
ToQuery PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods toQuery :: PutBackupVaultNotifications -> QueryString #
type Rep PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications type Rep PutBackupVaultNotifications = D1 ('MetaData "PutBackupVaultNotifications" "Amazonka.Backup.PutBackupVaultNotifications" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "PutBackupVaultNotifications'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sNSTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "backupVaultEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BackupVaultEvent]))))
type AWSResponse PutBackupVaultNotifications Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications type AWSResponse PutBackupVaultNotifications = PutBackupVaultNotificationsResponse

newPutBackupVaultNotifications Source #

Arguments

:: Text	`$sel:backupVaultName:PutBackupVaultNotifications'`
-> Text	`$sel:sNSTopicArn:PutBackupVaultNotifications'`
-> 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

Instances details

Eq PutBackupVaultNotificationsResponse Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods (==) :: PutBackupVaultNotificationsResponse -> PutBackupVaultNotificationsResponse -> Bool # (/=) :: PutBackupVaultNotificationsResponse -> PutBackupVaultNotificationsResponse -> Bool #
Read PutBackupVaultNotificationsResponse Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods readsPrec :: Int -> ReadS PutBackupVaultNotificationsResponse # readList :: ReadS [PutBackupVaultNotificationsResponse] # readPrec :: ReadPrec PutBackupVaultNotificationsResponse # readListPrec :: ReadPrec [PutBackupVaultNotificationsResponse] #
Show PutBackupVaultNotificationsResponse Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods showsPrec :: Int -> PutBackupVaultNotificationsResponse -> ShowS # show :: PutBackupVaultNotificationsResponse -> String # showList :: [PutBackupVaultNotificationsResponse] -> ShowS #
Generic PutBackupVaultNotificationsResponse Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Associated Types type Rep PutBackupVaultNotificationsResponse :: Type -> Type # Methods from :: PutBackupVaultNotificationsResponse -> Rep PutBackupVaultNotificationsResponse x # to :: Rep PutBackupVaultNotificationsResponse x -> PutBackupVaultNotificationsResponse #
NFData PutBackupVaultNotificationsResponse Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications Methods rnf :: PutBackupVaultNotificationsResponse -> () #
type Rep PutBackupVaultNotificationsResponse Source #
Instance details Defined in Amazonka.Backup.PutBackupVaultNotifications type Rep PutBackupVaultNotificationsResponse = D1 ('MetaData "PutBackupVaultNotificationsResponse" "Amazonka.Backup.PutBackupVaultNotifications" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "PutBackupVaultNotificationsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutBackupVaultNotificationsResponse :: PutBackupVaultNotificationsResponse Source #

Create a value of PutBackupVaultNotificationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.