Class: MintPress::Aws::EC2::ExportImageTask

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

Properties (Read/Write)

  • #description ⇒ [String]
    'A description of the image being exported.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ExportImageTask"
    • orig_name ⇒ 'description'
    

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

property :description, disposition: :attribute, description: 'A description of the image being exported.', source: "MintPress::Aws::EC2::ExportImageTask", orig_name: 'description', type: [String]
  • #progress ⇒ [String]
    'The percent complete of the export image task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ExportImageTask"
    • orig_name ⇒ 'progress'
    

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

property :progress, disposition: :attribute, description: 'The percent complete of the export image task.', source: "MintPress::Aws::EC2::ExportImageTask", orig_name: 'progress', type: [String]
  • #s3_export_location ⇒ [MintPress::Aws::EC2::ExportTaskS3Location] (Default Value: MintPress::Aws::EC2::ExportTaskS3Location.new)
    'Information about the destination Amazon S3 bucket.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ExportImageTask"
    • orig_name ⇒ 's3_export_location'
    • default ⇒ MintPress::Aws::EC2::ExportTaskS3Location.new
    

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

property :s3_export_location, disposition: :attribute, description: 'Information about the destination Amazon S3 bucket.', source: "MintPress::Aws::EC2::ExportImageTask", orig_name: 's3_export_location', type: [MintPress::Aws::EC2::ExportTaskS3Location], default: MintPress::Aws::EC2::ExportTaskS3Location.new
  • #status ⇒ [String]
    'The status of the export image task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ExportImageTask"
    • orig_name ⇒ 'status'
    

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

property :status, disposition: :attribute, description: 'The status of the export image task.', source: "MintPress::Aws::EC2::ExportImageTask", orig_name: 'status', type: [String]
  • #status_message ⇒ [String]
    'The status message for the export image task.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ExportImageTask"
    • orig_name ⇒ 'status_message'
    

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

property :status_message, disposition: :attribute, description: 'The status message for the export image task.', source: "MintPress::Aws::EC2::ExportImageTask", orig_name: 'status_message', type: [String]
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'Any tags assigned to the image being exported.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ExportImageTask"
    • orig_name ⇒ 'tags'
    

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

property :tags, disposition: :attribute, description: 'Any tags assigned to the image being exported.', source: "MintPress::Aws::EC2::ExportImageTask", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, 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_export_image_tasks_prop ⇒ 'dry_run'
    • source ⇒ "describe_export_image_tasks"
    

27
28
29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/export_image_task.rb', line 27

property :dry_run, describe_export_image_tasks_prop: 'dry_run', type: [TrueClass,FalseClass], source: "describe_export_image_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.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
    Property Attributes
    • describe_export_image_tasks_prop ⇒ 'filters'
    • source ⇒ "describe_export_image_tasks"
    

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

property :filters, describe_export_image_tasks_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_export_image_tasks", description: 'Filter tasks using the task-state filter and one of the following
values: active, completed, deleting, or deleted.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in a single call.'
    Property Attributes
    • describe_export_image_tasks_prop ⇒ 'max_results'
    • source ⇒ "describe_export_image_tasks"
    

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

property :max_results, describe_export_image_tasks_prop: 'max_results', type: [Integer], source: "describe_export_image_tasks", description: 'The maximum number of results to return in a single call.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The IDs of the export image tasks.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_export_image_tasks"
    • orig_name ⇒ 'export_image_task_id'
    • describe_export_image_tasks_prop ⇒ 'export_image_task_ids'
    • default ⇒ Proc.new { self.name }
    

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

property :id, disposition: :attribute, description: 'The IDs of the export image tasks.', source: "describe_export_image_tasks", orig_name: 'export_image_task_id', type: [String], array: false, hash: false, describe_export_image_tasks_prop: 'export_image_task_ids', default: Proc.new { self.name }
  • #image ⇒ [MintPress::Aws::EC2::Image]
    'The ID of the image.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EC2::ExportImageTask"
    • orig_name ⇒ 'image_id'
    • from ⇒ String
    

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

property :image, disposition: :attribute, description: 'The ID of the image.', source: "MintPress::Aws::EC2::ExportImageTask", orig_name: 'image_id', type: [MintPress::Aws::EC2::Image], from: String
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of ExportImageTask.

Instance Method Details

#describe ⇒ Object