Class: MintPress::Aws::EC2::Snapshot

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

Properties (Read/Write)

  • #description ⇒ [String]
    'A description for the snapshot.'
    Property Attributes
    • source ⇒ "create_snapshot"
    • orig_name ⇒ 'description'
    • create_snapshot_prop ⇒ 'description'
    • read_only ⇒ false
    • create_snapshots_prop ⇒ 'description'
    

26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 26

property :description, description: 'A description for the snapshot.', source: "create_snapshot", orig_name: 'description', type: [String], create_snapshot_prop: 'description', read_only: false, create_snapshots_prop: 'description'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to apply to the snapshot during creation.'
    Property Attributes
    • source ⇒ "create_snapshot"
    • orig_name ⇒ 'tags'
    • create_snapshot_prop ⇒ 'tag_specifications'
    • read_only ⇒ false
    • create_snapshots_prop ⇒ 'tag_specifications'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 33

property :tags, description: 'The tags to apply to the snapshot during creation.', source: "create_snapshot", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_snapshot_prop: 'tag_specifications', read_only: false, create_snapshots_prop: 'tag_specifications', hash: true
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
    Property Attributes
    • create_snapshot_prop ⇒ 'dry_run'
    • read_only ⇒ false
    • source ⇒ "create_snapshot"
    • create_snapshots_prop ⇒ 'dry_run'
    • delete_snapshot_prop ⇒ 'dry_run'
    • describe_snapshots_prop ⇒ 'dry_run'
    

35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 35

property :dry_run, create_snapshot_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_snapshot", description: 'Checks whether you have the required permissions for the action,
without actually making the request, and provides an error response.
If you have the required permissions, the error response is
DryRunOperation. Otherwise, it is UnauthorizedOperation.', create_snapshots_prop: 'dry_run', delete_snapshot_prop: 'dry_run', describe_snapshots_prop: 'dry_run'
  • #instance ⇒ [MintPress::Aws::EC2::Instance] (Default Value: MintPress::Aws::EC2::Instance.new)
    'The instance to specify which volumes should be included in the snapshots.'
    Property Attributes
    • create_snapshots_prop ⇒ 'instance_specification'
    • default ⇒ MintPress::Aws::EC2::Instance.new
    • read_only ⇒ false
    • source ⇒ "create_snapshots"
    

39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 39

property :instance, create_snapshots_prop: 'instance_specification', type: [MintPress::Aws::EC2::Instance], default: MintPress::Aws::EC2::Instance.new, read_only: false, source: "create_snapshots", description: 'The instance to specify which volumes should be included in the
snapshots.'
  • #copy_tags_from_source ⇒ [String]
    'Copies the tags from the specified volume to corresponding snapshot.'
    Property Attributes
    • create_snapshots_prop ⇒ 'copy_tags_from_source'
    • read_only ⇒ false
    • source ⇒ "create_snapshots"
    

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

property :copy_tags_from_source, create_snapshots_prop: 'copy_tags_from_source', type: [String], read_only: false, source: "create_snapshots", description: 'Copies the tags from the specified volume to corresponding snapshot.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. description - A description of the snapshot. encrypted - Indicates whether the snapshot is encrypted (true | false) owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter. progress - The progress of the snapshot, as a percentage (for example, 80%). snapshot-id - The snapshot ID. start-time - The time stamp when the snapshot was initiated. status - The status of the snapshot (pending | completed | error). tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. volume-id - The ID of the volume the snapshot is for. volume-size - The size of the volume, in GiB.'
    Property Attributes
    • describe_snapshots_prop ⇒ 'filters'
    • source ⇒ "describe_snapshots"
    

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
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 42

property :filters, describe_snapshots_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_snapshots", description: 'The filters.


description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true |
false)
owner-alias - The owner alias, from an Amazon-maintained list
(amazon). This is not the user-configured AWS account alias set
using the IAM console. We recommend that you use the related
parameter instead of this filter.
owner-id - The AWS account ID of the owner. We recommend that you
use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for
example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed |
error).
tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner
for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.'
    Property Attributes
    • describe_snapshots_prop ⇒ 'max_results'
    • source ⇒ "describe_snapshots"
    

70
71
72
73
74
75
76
77
78
79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 70

property :max_results, describe_snapshots_prop: 'max_results', type: [Integer], source: "describe_snapshots", description: 'The maximum number of snapshot results returned by DescribeSnapshots
in paginated output. When this parameter is used, DescribeSnapshots
only returns MaxResults results in a single page along with a
NextToken response element. The remaining results of the initial
request can be seen by sending another DescribeSnapshots request
with the returned NextToken value. This value can be between 5 and
1,000; if MaxResults is given a value larger than 1,000, only 1,000
results are returned. If this parameter is not used, then
DescribeSnapshots returns all results. You cannot specify this
parameter and the snapshot IDs parameter in the same request.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions.'
    Property Attributes
    • read_only ⇒ false
    • disposition ⇒ :attribute
    • source ⇒ "describe_snapshots"
    • orig_name ⇒ 'snapshot_id'
    • delete_snapshot_prop ⇒ 'snapshot_id'
    • describe_snapshots_prop ⇒ 'snapshot_ids'
    • default ⇒ Proc.new { self.name }
    

80
81
82
83
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 80

property :id, read_only: false, disposition: :attribute, description: 'The snapshot IDs.

Default: Describes the snapshots for which you have create volume
permissions.', source: "describe_snapshots", orig_name: 'snapshot_id', type: [String], delete_snapshot_prop: 'snapshot_id', array: false, hash: false, describe_snapshots_prop: 'snapshot_ids', default: Proc.new { self.name }
  • #volume ⇒ [MintPress::Aws::EC2::Volume] (Default Value: MintPress::Aws::EC2::Volume.new)
    'The ID of the EBS volume.'
    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'volume'
    • create_snapshot_prop ⇒ 'volume_id'
    • read_only ⇒ false
    • default ⇒ MintPress::Aws::EC2::Volume.new
    • from ⇒ String
    

84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 84

property :volume, disposition: :association, description: 'The ID of the EBS volume.', source: "Snapshot", orig_name: 'volume', type: [MintPress::Aws::EC2::Volume], create_snapshot_prop: 'volume_id', read_only: false, default: MintPress::Aws::EC2::Volume.new, from: String
  • #owners ⇒ Array of ⇒ [String]
    'Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.'
    Property Attributes
    • describe_snapshots_prop ⇒ 'owner_ids'
    • source ⇒ "describe_snapshots"
    

88
89
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 88

property :owners, describe_snapshots_prop: 'owner_ids', type: [String], array: true, source: "describe_snapshots", description: 'Scopes the results to snapshots with the specified owners. You can
specify a combination of AWS account IDs, self, and amazon.'
  • #restorable_by_users ⇒ Array of ⇒ [String]
    'The IDs of the AWS accounts that can create volumes from the snapshot.'
    Property Attributes
    • describe_snapshots_prop ⇒ 'restorable_by_user_ids'
    • source ⇒ "describe_snapshots"
    

90
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 90

property :restorable_by_users, describe_snapshots_prop: 'restorable_by_user_ids', type: [String], array: true, source: "describe_snapshots", description: 'The IDs of the AWS accounts that can create volumes from the snapshot.'
  • #name ⇒ String

    Property Attributes 
    

91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 91

property :name, type: String
  • #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 
    

95
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 95

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
    

98
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 98

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

Properties (Read Only)

  • #encrypted ⇒ [TrueClass,FalseClass]
    'Indicates whether the snapshot is encrypted.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'encrypted'
    • read_only ⇒ true
    

27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 27

property :encrypted, disposition: :read_only_attribute, description: 'Indicates whether the snapshot is encrypted.', source: "Snapshot", orig_name: 'encrypted', type: [TrueClass,FalseClass], read_only: true
  • #owner_alias ⇒ [String]
    'The AWS owner alias, from an Amazon-maintained list (amazon).'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'owner_alias'
    • read_only ⇒ true
    

28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 28

property :owner_alias, disposition: :read_only_attribute, description: 'The AWS owner alias, from an Amazon-maintained list (amazon).', source: "Snapshot", orig_name: 'owner_alias', type: [String], read_only: true
  • #progress ⇒ [String]
    'The progress of the snapshot, as a percentage.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'progress'
    • read_only ⇒ true
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 29

property :progress, disposition: :read_only_attribute, description: 'The progress of the snapshot, as a percentage.', source: "Snapshot", orig_name: 'progress', type: [String], read_only: true
  • #start_time ⇒ [Time]
    'The time stamp when the snapshot was initiated.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'start_time'
    • read_only ⇒ true
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 30

property :start_time, disposition: :read_only_attribute, description: 'The time stamp when the snapshot was initiated.', source: "Snapshot", orig_name: 'start_time', type: [Time], read_only: true
  • #state ⇒ [String]
    'The snapshot state.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'state'
    • read_only ⇒ true
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 31

property :state, disposition: :read_only_attribute, description: 'The snapshot state.', source: "Snapshot", orig_name: 'state', type: [String], read_only: true
  • #state_message ⇒ [String]
    'Encrypted Amazon EBS snapshots are copied asynchronously.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'state_message'
    • read_only ⇒ true
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 32

property :state_message, disposition: :read_only_attribute, description: 'Encrypted Amazon EBS snapshots are copied asynchronously.', source: "Snapshot", orig_name: 'state_message', type: [String], read_only: true
  • #volume_size ⇒ [Integer]
    'The size of the volume, in GiB.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'volume_size'
    • read_only ⇒ true
    

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

property :volume_size, disposition: :read_only_attribute, description: 'The size of the volume, in GiB.', source: "Snapshot", orig_name: 'volume_size', type: [Integer], read_only: true
  • #data_encryption_key ⇒ [String]
    'The data encryption key identifier for the snapshot.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'data_encryption_key_id'
    • read_only ⇒ true
    

85
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 85

property :data_encryption_key, disposition: :read_only_attribute, description: 'The data encryption key identifier for the snapshot.', source: "Snapshot", orig_name: 'data_encryption_key_id', type: [String], read_only: true
  • #kms_key ⇒ [String]
    'The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'kms_key_id'
    • read_only ⇒ true
    

86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 86

property :kms_key, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.', source: "Snapshot", orig_name: 'kms_key_id', type: [String], read_only: true
  • #owner ⇒ [String]
    'The AWS account ID of the EBS snapshot owner.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "Snapshot"
    • orig_name ⇒ 'owner_id'
    • read_only ⇒ true
    

87
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/snapshot.rb', line 87

property :owner, disposition: :read_only_attribute, description: 'The AWS account ID of the EBS snapshot owner.', source: "Snapshot", orig_name: 'owner_id', type: [String], read_only: true

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 = {}) ⇒ Snapshot

Returns a new instance of Snapshot.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object