Class: Ansible::Ruby::Modules::Ec2_ami

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb

Overview

Creates or deletes ec2 images.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#delete_snapshot ⇒ :yes, ...

Returns Whether or not to delete snapshots when deregistering AMI.

Returns:

  • (:yes, :no, nil) —

    Whether or not to delete snapshots when deregistering AMI.



46
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 46

attribute :delete_snapshot

#description ⇒ Object?

Returns An optional human-readable string describing the contents and purpose of the AMI.

Returns:

  • (Object, nil) —

    An optional human-readable string describing the contents and purpose of the AMI.



31
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 31

attribute :description

#device_mapping ⇒ Array<Hash>, ...

Returns An optional list of device hashes/dictionaries with custom configurations (same block-device-mapping parameters),Valid properties include: device_name, volume_type, size (in GB), delete_on_termination (boolean), no_device (boolean), snapshot_id, iops (for io1 volume_type).

Returns:

  • (Array<Hash>, Hash, nil) —

    An optional list of device hashes/dictionaries with custom configurations (same block-device-mapping parameters),Valid properties include: device_name, volume_type, size (in GB), delete_on_termination (boolean), no_device (boolean), snapshot_id, iops (for io1 volume_type)



42
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 42

attribute :device_mapping

#image_id ⇒ String?

Returns Image ID to be deregistered.

Returns:

  • (String, nil) —

    Image ID to be deregistered.



38
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 38

attribute :image_id

#instance_id ⇒ String?

Returns instance id of the image to create.

Returns:

  • (String, nil) —

    instance id of the image to create



11
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 11

attribute :instance_id

#launch_permissions ⇒ Hash?

Returns Users and groups that should be able to launch the ami. Expects dictionary with a key of user_ids and/or group_names. user_ids should be a list of account ids. group_name should be a list of groups, “all” is the only acceptable value currently.

Returns:

  • (Hash, nil) —

    Users and groups that should be able to launch the ami. Expects dictionary with a key of user_ids and/or group_names. user_ids should be a list of account ids. group_name should be a list of groups, “all” is the only acceptable value currently.



54
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 54

attribute :launch_permissions

#name ⇒ String?

Returns The name of the new image to create.

Returns:

  • (String, nil) —

    The name of the new image to create



15
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 15

attribute :name

#no_reboot ⇒ Boolean?

Returns An optional flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the responsibility of maintaining file system integrity is left to the owner of the instance. The default choice is “no”.

Returns:

  • (Boolean, nil) —

    An optional flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the responsibility of maintaining file system integrity is left to the owner of the instance. The default choice is “no”.



34
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 34

attribute :no_reboot

#state ⇒ String?

Returns create or deregister/delete image.

Returns:

  • (String, nil) —

    create or deregister/delete image



27
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 27

attribute :state

#tags ⇒ Hash?

Returns a dictionary of tags to add to the new image; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’.

Returns:

  • (Hash, nil) —

    a dictionary of tags to add to the new image; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’



50
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 50

attribute :tags

#wait ⇒ :yes, ...

Returns wait for the AMI to be in state ‘available’ before returning.

Returns:

  • (:yes, :no, nil) —

    wait for the AMI to be in state ‘available’ before returning.



19
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 19

attribute :wait

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



23
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_ami.rb', line 23

attribute :wait_timeout