Class: MintPress::Aws::EC2::BundleTask

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

Properties (Read/Write)

  • #bundle_task_error ⇒ [MintPress::Aws::EC2::BundleTaskError] (Default Value: MintPress::Aws::EC2::BundleTaskError.new)
    'If the task fails, a description of the error.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::BundleTask"
    • orig_name ⇒ 'bundle_task_error'
    • default ⇒ MintPress::Aws::EC2::BundleTaskError.new
    

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

property :bundle_task_error, disposition: :attribute, description: 'If the task fails, a description of the error.', source: "MintPress::Aws::EC2::BundleTask", orig_name: 'bundle_task_error', type: [MintPress::Aws::EC2::BundleTaskError], default: MintPress::Aws::EC2::BundleTaskError.new
  • #progress ⇒ [String]
    'The level of task completion, as a percent (for example, 20%).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::BundleTask"
    • orig_name ⇒ 'progress'
    

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

property :progress, disposition: :attribute, description: 'The level of task completion, as a percent (for example, 20%).', source: "MintPress::Aws::EC2::BundleTask", orig_name: 'progress', type: [String]
  • #start_time ⇒ [Time]
    'The time this task started.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::BundleTask"
    • orig_name ⇒ 'start_time'
    

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

property :start_time, disposition: :attribute, description: 'The time this task started.', source: "MintPress::Aws::EC2::BundleTask", orig_name: 'start_time', type: [Time]
  • #state ⇒ [String]
    'The state of the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::BundleTask"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The state of the task.', source: "MintPress::Aws::EC2::BundleTask", orig_name: 'state', type: [String]
  • #storage ⇒ [MintPress::Aws::EC2::Storage] (Default Value: MintPress::Aws::EC2::Storage.new)
    'The Amazon S3 storage locations.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::BundleTask"
    • orig_name ⇒ 'storage'
    • default ⇒ MintPress::Aws::EC2::Storage.new
    

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

property :storage, disposition: :attribute, description: 'The Amazon S3 storage locations.', source: "MintPress::Aws::EC2::BundleTask", orig_name: 'storage', type: [MintPress::Aws::EC2::Storage], default: MintPress::Aws::EC2::Storage.new
  • #update_time ⇒ [Time]
    'The time of the most recent update for the task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::BundleTask"
    • orig_name ⇒ 'update_time'
    

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

property :update_time, disposition: :attribute, description: 'The time of the most recent update for the task.', source: "MintPress::Aws::EC2::BundleTask", orig_name: 'update_time', type: [Time]
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'The filters. bundle-id - The ID of the bundle task. error-code - If the task failed, the error code returned. error-message - If the task failed, the error message returned. instance-id - The ID of the instance. progress - The level of task completion, as a percentage (for example, 20%). s3-bucket - The Amazon S3 bucket to store the AMI. s3-prefix - The beginning of the AMI name. start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z). state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed). update-time - The time of the most recent update for the task.'
    Property Attributes
    • describe_bundle_tasks_prop ⇒ 'filters'
    • source ⇒ "describe_bundle_tasks"
    

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/bundle_task.rb', line 27

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


bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for
example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example,
2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown
| bundling | storing | cancelling | complete |
failed).
update-time - The time of the most recent update for the task.', 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
    • describe_bundle_tasks_prop ⇒ 'dry_run'
    • source ⇒ "describe_bundle_tasks"
    

44
45
46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/bundle_task.rb', line 44

property :dry_run, describe_bundle_tasks_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_bundle_tasks", 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.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The bundle task IDs. Default: Describes all your bundle tasks.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_bundle_tasks"
    • orig_name ⇒ 'bundle_id'
    • describe_bundle_tasks_prop ⇒ 'bundle_ids'
    • default ⇒ Proc.new { self.name }
    

48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/bundle_task.rb', line 48

property :id, disposition: :attribute, description: 'The bundle task IDs.

Default: Describes all your bundle tasks.', source: "describe_bundle_tasks", orig_name: 'bundle_id', type: [String], array: false, hash: false, describe_bundle_tasks_prop: 'bundle_ids', default: Proc.new { self.name }
  • #instance ⇒ [MintPress::Aws::EC2::Instance]
    'The ID of the instance associated with this bundle task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::BundleTask"
    • orig_name ⇒ 'instance_id'
    • from ⇒ String
    

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

property :instance, disposition: :attribute, description: 'The ID of the instance associated with this bundle task.', source: "MintPress::Aws::EC2::BundleTask", orig_name: 'instance_id', type: [MintPress::Aws::EC2::Instance], from: String
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Properties (Read Only)

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

Returns a new instance of BundleTask.

Instance Method Details

#describe ⇒ Object