File: glacier.rb

package info (click to toggle)
ruby-aws-sdk 1.66.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,808 kB
  • ctags: 4,854
  • sloc: ruby: 28,354; makefile: 7
file content (79 lines) | stat: -rw-r--r-- 2,562 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
#     http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.

require 'aws/core'
require 'aws/glacier/config'

module AWS

  # This class is the starting point for working with Amazon Glacier.
  #
  # To use Amazon Glacier you must first
  # [sign up here](http://aws.amazon.com/glacier/).
  #
  # For more information about Amazon Glacier:
  #
  # * [Amazon Glacier](http://aws.amazon.com/glacier/)
  # * [Amazon Glacier Documentation](http://aws.amazon.com/documentation/glacier/)
  #
  # # Credentials
  #
  # You can setup default credentials for all AWS services via
  # AWS.config:
  #
  #     AWS.config(
  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
  #
  # Or you can set them directly on the AWS::Glacier interface:
  #
  #     glacier = AWS::Glacier.new(
  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
  #
  # See {Client} for documentation on all of the supported API operations.
  #
  # @!attribute [r] client
  #   @return [Client] the low-level Glacier client object
  class Glacier

    autoload :Archive, 'aws/glacier/archive'
    autoload :ArchiveCollection, 'aws/glacier/archive_collection'
    autoload :Client, 'aws/glacier/client'
    autoload :Errors, 'aws/glacier/errors'
    autoload :Resource, 'aws/glacier/resource'
    autoload :Vault, 'aws/glacier/vault'
    autoload :VaultCollection, 'aws/glacier/vault_collection'
    autoload :VaultNotificationConfiguration, 'aws/glacier/vault_notification_configuration'

    include Core::ServiceInterface

    endpoint_prefix 'glacier'

    # @option options[String] :account_id ('-')
    def initialize options = {}
      @account_id = options[:account_id] || '-'
      super
    end

    # @return [String]
    attr_accessor :account_id

    # @return [VaultCollection] Returns a collection for working with
    #   vaults that belong to this account.
    def vaults
      VaultCollection.new(:config => config, :account_id => account_id)
    end

  end
end