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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ec2_ami

Includes:

Helpers::Aws

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami.rb,
lib/ansible/ruby/modules/custom/cloud/core/amazon/ec2_ami.rb

Overview

Registers or deregisters ec2 images.

Instance Method Summary

• #architecture ⇒ String^?

  The target architecture of the image to register.

• #billing_products ⇒ Object^?

  A list of valid billing codes.

• #delete_snapshot ⇒ :yes, ...

  Delete snapshots when deregistering the AMI.

• #description ⇒ Object^?

  Human-readable string describing the contents and purpose of the AMI.

• #device_mapping ⇒ Array<Hash>, ...

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

• #enhanced_networking ⇒ Object^?

  A boolean representing whether enhanced networking with ENA is enabled or not.

• #image_id ⇒ String^?

  Image ID to be deregistered.

• #image_location ⇒ Object^?

  The s3 location of an image to use for the AMI.

• #instance_id ⇒ String^?

  Instance ID to create the AMI from.

• #kernel_id ⇒ Object^?

  The target kernel id of the image to register.

• #launch_permissions ⇒ Hash^?

  Users and groups that should be able to launch the AMI.

• #name ⇒ String^?

  The name of the new AMI.

• #no_reboot ⇒ Symbol^?

  Flag indicating that the bundling process should not attempt to shutdown the instance before bundling.

• #purge_tags ⇒ String^?

  Whether to remove existing tags that aren’t passed in the C(tags) parameter.

• #ramdisk_id ⇒ Object^?

  The ID of the RAM disk.

• #root_device_name ⇒ String^?

  The root device name of the image to register.

• #sriov_net_support ⇒ Object^?

  Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

• #state ⇒ :absent, ...

  Register or deregister an AMI.

• #tags ⇒ Hash^?

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

• #virtualization_type ⇒ String^?

  The virtualization type of the image to register.

• #wait ⇒ :yes, ...

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

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

Methods included from Helpers::Aws

included

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#architecture ⇒ String^?

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

attribute :architecture

#billing_products ⇒ Object^?

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

attribute :billing_products

#delete_snapshot ⇒ :yes, ...

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

attribute :delete_snapshot

#description ⇒ Object^?

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

attribute :description

#device_mapping ⇒ Array<Hash>, ...

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

attribute :device_mapping

#enhanced_networking ⇒ Object^?

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

attribute :enhanced_networking

#image_id ⇒ String^?

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

attribute :image_id

#image_location ⇒ Object^?

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

attribute :image_location

#instance_id ⇒ String^?

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

attribute :instance_id

#kernel_id ⇒ Object^?

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

attribute :kernel_id

#launch_permissions ⇒ Hash^?

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

attribute :launch_permissions

#name ⇒ String^?

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

attribute :name

#no_reboot ⇒ Symbol^?

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

attribute :no_reboot

#purge_tags ⇒ String^?

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

attribute :purge_tags

#ramdisk_id ⇒ Object^?

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

attribute :ramdisk_id

#root_device_name ⇒ String^?

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

attribute :root_device_name

#sriov_net_support ⇒ Object^?

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

attribute :sriov_net_support

#state ⇒ :absent, ...

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

attribute :state

#tags ⇒ Hash^?

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

attribute :tags

#virtualization_type ⇒ String^?

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

attribute :virtualization_type

#wait ⇒ :yes, ...

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

attribute :wait

#wait_timeout ⇒ Integer^?

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

attribute :wait_timeout