You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::EC2::ExportTask

Inherits:
Resource
  • Object
show all
Defined in:
lib/aws/ec2/export_task.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#container_format ⇒ String (readonly)

The container format used to combine disk images with metadata (such as OVF).

Returns:

  • (String) —

    the current value of container_format



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def container_format
  @container_format
end

#description ⇒ String (readonly)

Description of the resource being exported.

Returns:

  • (String) —

    the current value of description



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def description
  @description
end

#disk_image_format ⇒ String (readonly)

The format for the exported image.

Returns:

  • (String) —

    the current value of disk_image_format



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def disk_image_format
  @disk_image_format
end

#export_task_id ⇒ String (readonly) Also known as: id

Returns:

  • (String) 


52
53
54
 
# File 'lib/aws/ec2/export_task.rb', line 52

def export_task_id
  @export_task_id
end

#instance_id ⇒ String (readonly)

ID of instance being exported.

Returns:

  • (String) —

    the current value of instance_id



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def instance_id
  @instance_id
end

#s3_bucket ⇒ S3::Bucket (readonly)

Returns:



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def s3_bucket
  @s3_bucket
end

#s3_key ⇒ String (readonly)

The key of the Amazon S3 object the image will be exported to.

Returns:

  • (String) —

    the current value of s3_key



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def s3_key
  @s3_key
end

#state ⇒ Symbol (readonly)

State of the conversion task. Valid values :active, :cancelling, :cancelled and :completed.

Returns:

  • (Symbol) —

    the current value of state



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def state
  @state
end

#status_message ⇒ String (readonly)

Status message related to the export task.

Returns:

  • (String) —

    the current value of status_message



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def status_message
  @status_message
end

#target_environment ⇒ String (readonly)

The target virtualization environment.

Returns:

  • (String) —

    the current value of target_environment



43
44
45
 
# File 'lib/aws/ec2/export_task.rb', line 43

def target_environment
  @target_environment
end

Instance Method Details

#cancel ⇒ nil

Cancels the export task.

Returns:

  • (nil) 


113
114
115
116
 
# File 'lib/aws/ec2/export_task.rb', line 113

def cancel
  client.cancel_export_task(:export_task_id => export_task_id)
  nil
end

#instance ⇒ Instance

Returns:



97
98
99
 
# File 'lib/aws/ec2/export_task.rb', line 97

def instance
  Instance.new(instance_id, :config => config)
end

#s3_object ⇒ S3::S3Object

Returns:



107
108
109
 
# File 'lib/aws/ec2/export_task.rb', line 107

def s3_object
  s3_bucket.objects[s3_key]
end