Class: MintPress::Aws::Glacier::Vault

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb

Properties (Read/Write)

  • #vault_name ⇒ [String]
    'The name of the vault.'
    Property Attributes
    • create_vault_prop ⇒ 'vault_name'
    • read_only ⇒ false
    • source ⇒ "create_vault"
    • delete_vault_prop ⇒ 'vault_name'
    • describe_vault_prop ⇒ 'vault_name'
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 34

property :vault_name, create_vault_prop: 'vault_name', type: [String], read_only: false, source: "create_vault", description: 'The name of the vault.', delete_vault_prop: 'vault_name', describe_vault_prop: 'vault_name'
  • #limit ⇒ [Integer]
    'The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.'
    Property Attributes
    • list_vaults_prop ⇒ 'limit'
    • read_only ⇒ false
    • source ⇒ "list_vaults"
    

35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 35

property :limit, list_vaults_prop: 'limit', type: [Integer], read_only: false, source: "list_vaults", description: 'The maximum number of vaults to be returned. The default limit is 10.
The number of vaults returned might be fewer than the specified limit,
but the number of returned vaults never exceeds the limit.'
  • #account ⇒ [MintPress::Aws::Glacier::Account] (Default Value: MintPress::Aws::Glacier::Account.new)
    'The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single "-" (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ("-") in the ID.'
    Property Attributes
    • create_vault_prop ⇒ 'account_id'
    • disposition ⇒ :association
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Glacier::Vault"
    • delete_vault_prop ⇒ 'account_id'
    • describe_vault_prop ⇒ 'account_id'
    • list_vaults_prop ⇒ 'account_id'
    • orig_name ⇒ 'account'
    • default ⇒ MintPress::Aws::Glacier::Account.new
    • from ⇒ String
    

44
45
46
47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 44

property :account, create_vault_prop: 'account_id', type: [MintPress::Aws::Glacier::Account], disposition: :association, read_only: false, source: "MintPress::Aws::Glacier::Vault", description: 'The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the
request. You can either specify an AWS account ID or optionally a
single "-" (hyphen), in which case Amazon Glacier uses the AWS
account ID associated with the credentials used to sign the request.
If you specify your account ID, do not include any hyphens ("-") in
the ID.', delete_vault_prop: 'account_id', describe_vault_prop: 'account_id', list_vaults_prop: 'account_id', orig_name: 'account', default: MintPress::Aws::Glacier::Account.new, from: String
  • #archive ⇒ [MintPress::Aws::Glacier::Archive] (Default Value: MintPress::Aws::Glacier::Archive.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'archive'
    • default ⇒ MintPress::Aws::Glacier::Archive.new
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 51

property :archive, disposition: :association, source: "Vault", orig_name: 'archive', type: [MintPress::Aws::Glacier::Archive], default: MintPress::Aws::Glacier::Archive.new
  • #completed_jobs ⇒ Hash of ⇒ [MintPress::Aws::Glacier::Job]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'completed_jobs'
    

52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 52

property :completed_jobs, disposition: :association, source: "Vault", orig_name: 'completed_jobs', type: [MintPress::Aws::Glacier::Job], array: false, hash: true
  • #failed_jobs ⇒ Hash of ⇒ [MintPress::Aws::Glacier::Job]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'failed_jobs'
    

53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 53

property :failed_jobs, disposition: :association, source: "Vault", orig_name: 'failed_jobs', type: [MintPress::Aws::Glacier::Job], array: false, hash: true
  • #job ⇒ [MintPress::Aws::Glacier::Job] (Default Value: MintPress::Aws::Glacier::Job.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'job'
    • default ⇒ MintPress::Aws::Glacier::Job.new
    

54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 54

property :job, disposition: :association, source: "Vault", orig_name: 'job', type: [MintPress::Aws::Glacier::Job], default: MintPress::Aws::Glacier::Job.new
  • #jobs ⇒ Hash of ⇒ [MintPress::Aws::Glacier::Job]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'jobs'
    

55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 55

property :jobs, disposition: :association, source: "Vault", orig_name: 'jobs', type: [MintPress::Aws::Glacier::Job], array: false, hash: true
  • #jobs_in_progress ⇒ Hash of ⇒ [MintPress::Aws::Glacier::Job]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'jobs_in_progress'
    

56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 56

property :jobs_in_progress, disposition: :association, source: "Vault", orig_name: 'jobs_in_progress', type: [MintPress::Aws::Glacier::Job], array: false, hash: true
  • #multipart_uplaods ⇒ Hash of ⇒ [MintPress::Aws::Glacier::MultipartUpload]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'multipart_uplaods'
    

57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 57

property :multipart_uplaods, disposition: :association, source: "Vault", orig_name: 'multipart_uplaods', type: [MintPress::Aws::Glacier::MultipartUpload], array: false, hash: true
  • #multipart_upload ⇒ [MintPress::Aws::Glacier::MultipartUpload] (Default Value: MintPress::Aws::Glacier::MultipartUpload.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'multipart_upload'
    • default ⇒ MintPress::Aws::Glacier::MultipartUpload.new
    

58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 58

property :multipart_upload, disposition: :association, source: "Vault", orig_name: 'multipart_upload', type: [MintPress::Aws::Glacier::MultipartUpload], default: MintPress::Aws::Glacier::MultipartUpload.new
  • #notification ⇒ [MintPress::Aws::Glacier::Notification] (Default Value: MintPress::Aws::Glacier::Notification.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'notification'
    • default ⇒ MintPress::Aws::Glacier::Notification.new
    

59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 59

property :notification, disposition: :association, source: "Vault", orig_name: 'notification', type: [MintPress::Aws::Glacier::Notification], default: MintPress::Aws::Glacier::Notification.new
  • #succeeded_jobs ⇒ Hash of ⇒ [MintPress::Aws::Glacier::Job]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Vault"
    • orig_name ⇒ 'succeeded_jobs'
    

60
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 60

property :succeeded_jobs, disposition: :association, source: "Vault", orig_name: 'succeeded_jobs', type: [MintPress::Aws::Glacier::Job], array: false, hash: true
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 64

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

67
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 67

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #creation_date ⇒ [Time]
    'The Universal Coordinated Time (UTC) date when the vault was created.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Vault"
    • orig_name ⇒ 'creation_date'
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 38

property :creation_date, read_only: true, disposition: :read_only_attribute, description: 'The Universal Coordinated Time (UTC) date when the vault was created.', source: "MintPress::Aws::Glacier::Vault", orig_name: 'creation_date', type: [Time]
  • #last_inventory_date ⇒ [Time]
    'The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last vault inventory.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Vault"
    • orig_name ⇒ 'last_inventory_date'
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 39

property :last_inventory_date, read_only: true, disposition: :read_only_attribute, description: 'The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last vault inventory.', source: "MintPress::Aws::Glacier::Vault", orig_name: 'last_inventory_date', type: [Time]
  • #name ⇒ [String]
    '(also: #vault_name)'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Vault"
    • orig_name ⇒ 'name'
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 40

property :name, read_only: true, disposition: :read_only_attribute, description: '(also: #vault_name)', source: "MintPress::Aws::Glacier::Vault", orig_name: 'name', type: [String]
  • #number_of_archives ⇒ [Integer]
    'The number of archives in the vault as of the last inventory date.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Vault"
    • orig_name ⇒ 'number_of_archives'
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 41

property :number_of_archives, read_only: true, disposition: :read_only_attribute, description: 'The number of archives in the vault as of the last inventory date.', source: "MintPress::Aws::Glacier::Vault", orig_name: 'number_of_archives', type: [Integer]
  • #size_in_bytes ⇒ [Integer]
    'Total size, in bytes, of the archives in the vault as of the last inventory date.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Vault"
    • orig_name ⇒ 'size_in_bytes'
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 42

property :size_in_bytes, read_only: true, disposition: :read_only_attribute, description: 'Total size, in bytes, of the archives in the vault as of the last inventory date.', source: "MintPress::Aws::Glacier::Vault", orig_name: 'size_in_bytes', type: [Integer]
  • #vault_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the vault.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Vault"
    • orig_name ⇒ 'vault_arn'
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/vault.rb', line 43

property :vault_arn, read_only: true, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) of the vault.', source: "MintPress::Aws::Glacier::Vault", orig_name: 'vault_arn', type: [String]

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Vault

Returns a new instance of Vault.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#list ⇒ Object