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

Class: Aws::Glacier::Notification

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_id, vault_name, options = {}) ⇒ Notification #initialize(options = {}) ⇒ Notification

Returns a new instance of Notification

Overloads:

  • #initialize(account_id, vault_name, options = {}) ⇒ Notification

    Parameters:

    • account_id (String)
    • vault_name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Notification

    Options Hash (options):

    • :account_id (required, String)
    • :vault_name (required, String)
    • :client (Client)


21
22
23
24
25
26
27
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 21

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @account_id = (args, options)
  @vault_name = extract_vault_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#account_idString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 32

def 
  @account_id
end

#clientClient

Returns:



58
59
60
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 58

def client
  @client
end

#dataTypes::VaultNotificationConfig

Returns the data for this Aws::Glacier::Notification. Calls Client#get_vault_notifications if #data_loaded? is false.

Returns:



81
82
83
84
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 81

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



89
90
91
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 89

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


notification.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)


100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 100

def delete(options = {})
  options = options.merge(
    account_id: @account_id,
    vault_name: @vault_name
  )
  resp = @client.delete_vault_notifications(options)
  resp.data
end

#eventsArray<String>

A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

Returns:

  • (Array<String>)


51
52
53
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 51

def events
  data.events
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::Glacier::Notification. Returns self making it possible to chain methods.

notification.reload.data

Returns:

  • (self)


68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 68

def load
  resp = @client.get_vault_notifications(
    account_id: @account_id,
    vault_name: @vault_name
  )
  @data = resp.vault_notification_config
  self
end

#set(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


notification.set({
  vault_notification_config: {
    sns_topic: "string",
    events: ["string"],
  },
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)


121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 121

def set(options = {})
  options = options.merge(
    account_id: @account_id,
    vault_name: @vault_name
  )
  resp = @client.set_vault_notifications(options)
  resp.data
end

#sns_topicString

The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

Returns:

  • (String)


44
45
46
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 44

def sns_topic
  data.sns_topic
end

#vaultVault

Returns:



133
134
135
136
137
138
139
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 133

def vault
  Vault.new(
    account_id: @account_id,
    name: @vault_name,
    client: @client
  )
end

#vault_nameString

Returns:

  • (String)


37
38
39
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/notification.rb', line 37

def vault_name
  @vault_name
end