You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass PutBackupVaultNotificationsInput data as a hash:

{
  backup_vault_name: "BackupVaultName", # required
  sns_topic_arn: "ARN", # required
  backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_vault_eventsArray<String>

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

Returns:

  • (Array<String>)


2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2899

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

#backup_vault_nameString

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2899

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

#sns_topic_arnString

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)


2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2899

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