Class: Aws::Backup::Types::PutBackupVaultNotificationsInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_vault_events ⇒ Array<String>

An array of events that indicate the status of jobs to back up resources to the backup vault.

For common use cases and code samples, see Using Amazon SNS to track Backup events.

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 | RECOVERY_POINT_MODIFIED

  • S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.

Returns:

  • (Array<String>) 


6439
6440
6441
6442
6443
6444
6445
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6439

class PutBackupVaultNotificationsInput < Struct.new(
  :backup_vault_name,
  :sns_topic_arn,
  :backup_vault_events)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_name ⇒ String

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.

Returns:

  • (String) 


6439
6440
6441
6442
6443
6444
6445
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6439

class PutBackupVaultNotificationsInput < Struct.new(
  :backup_vault_name,
  :sns_topic_arn,
  :backup_vault_events)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

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.

Returns:

  • (String) 


6439
6440
6441
6442
6443
6444
6445
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6439

class PutBackupVaultNotificationsInput < Struct.new(
  :backup_vault_name,
  :sns_topic_arn,
  :backup_vault_events)
  SENSITIVE = []
  include Aws::Structure
end