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^?

Returns The target architecture of the image to register.

Returns:

• (String, nil) —

  The target architecture of the image to register

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

attribute :architecture

#billing_products ⇒ Object^?

Returns A list of valid billing codes. To be used with valid accounts by aws marketplace vendors.

Returns:

• (Object, nil) —

  A list of valid billing codes. To be used with valid accounts by aws marketplace vendors.

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

attribute :billing_products

#delete_snapshot ⇒ :yes, ...

Returns Delete snapshots when deregistering the AMI.

Returns:

• (:yes, :no, nil) —

  Delete snapshots when deregistering the AMI.

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

attribute :delete_snapshot

#description ⇒ Object^?

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

Returns:

• (Object, nil) —

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

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

attribute :description

#device_mapping ⇒ Array<Hash>, ...

Returns 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.

Returns:

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

  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

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

attribute :device_mapping

#enhanced_networking ⇒ Object^?

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

Returns:

• (Object, nil) —

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

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

attribute :enhanced_networking

#image_id ⇒ String^?

Returns Image ID to be deregistered.

Returns:

• (String, nil) —

  Image ID to be deregistered.

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

attribute :image_id

#image_location ⇒ Object^?

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

Returns:

• (Object, nil) —

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

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

attribute :image_location

#instance_id ⇒ String^?

Returns Instance ID to create the AMI from.

Returns:

• (String, nil) —

  Instance ID to create the AMI from.

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

attribute :instance_id

#kernel_id ⇒ Object^?

Returns The target kernel id of the image to register.

Returns:

• (Object, nil) —

  The target kernel id of the image to register.

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

attribute :kernel_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.,You must pass all desired launch permissions if you wish to modify existing launch permissions (passing just groups will remove all users).

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.,You must pass all desired launch permissions if you wish to modify existing launch permissions (passing just groups will remove all users)

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

attribute :launch_permissions

#name ⇒ String^?

Returns The name of the new AMI.

Returns:

• (String, nil) —

  The name of the new AMI.

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

attribute :name

#no_reboot ⇒ Symbol^?

Returns 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.

Returns:

• (Symbol, nil) —

  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.

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

attribute :no_reboot

#purge_tags ⇒ String^?

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

Returns:

• (String, nil) —

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

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

attribute :purge_tags

#ramdisk_id ⇒ Object^?

Returns The ID of the RAM disk.

Returns:

• (Object, nil) —

  The ID of the RAM disk.

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

attribute :ramdisk_id

#root_device_name ⇒ String^?

Returns The root device name of the image to register.

Returns:

• (String, nil) —

  The root device name of the image to register.

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

attribute :root_device_name

#sriov_net_support ⇒ Object^?

Returns 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.

Returns:

• (Object, nil) —

  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.

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

attribute :sriov_net_support

#state ⇒ :absent, ...

Returns Register or deregister an AMI.

Returns:

• (:absent, :present, nil) —

  Register or deregister an AMI.

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

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”’

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

attribute :tags

#virtualization_type ⇒ String^?

Returns The virtualization type of the image to register.

Returns:

• (String, nil) —

  The virtualization type of the image to register.

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

attribute :virtualization_type

#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.

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

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.

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

attribute :wait_timeout