Class: Ansible::Ruby::Modules::Ec2_ami_find

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb

Overview

Returns list of matching AMIs with AMI ID, along with other useful information Can search AMIs with different owners Can search by matching tag(s), by AMI name and/or other criteria Results can be sorted and sliced

Instance Method Summary

• #ami_id ⇒ Object^?

  An AMI ID to match.

• #ami_tags ⇒ Hash^?

  A hash/dictionary of tags to match for the AMI.

• #architecture ⇒ Object^?

  An architecture type to match (e.g. x86_64).

• #hypervisor ⇒ Object^?

  A hypervisor type type to match (e.g. xen).

• #is_public ⇒ Symbol^?

  Whether or not the image(s) are public.

• #name ⇒ String^?

  An AMI name to match.

• #no_result_action ⇒ :success, ...

  What to do when no results are found.,‘success’ reports success and returns an empty array,‘fail’ causes the module to report failure.

• #owner ⇒ String^?

  Search AMIs owned by the specified owner,Can specify an AWS account ID, or one of the special IDs ‘self’, ‘amazon’ or ‘aws-marketplace’,If not specified, all EC2 AMIs in the specified region will be searched.,You can include wildcards in many of the search options.

• #platform ⇒ Object^?

  Platform type to match.

• #product_code ⇒ Object^?

  Marketplace product code to match.

• #region ⇒ Object

  The AWS region to use.

• #root_device_type ⇒ Object^?

  Root device type to match (e.g. ebs, instance-store).

• #sort ⇒ :name, ...

  Optional attribute which with to sort the results.,If specifying ‘tag’, the ‘tag_name’ parameter is required.,Starting at version 2.1, additional sort choices of architecture, block_device_mapping, creationDate, hypervisor, is_public, location, owner_id, platform, root_device_name, root_device_type, state, and virtualization_type are supported.

• #sort_end ⇒ Integer^?

  Which result to end with (when sorting).,Corresponds to Python slice notation.

• #sort_order ⇒ :ascending, ...

  Order in which to sort results.,Only used when the ‘sort’ parameter is specified.

• #sort_start ⇒ Object^?

  Which result to start with (when sorting).,Corresponds to Python slice notation.

• #sort_tag ⇒ Object^?

  Tag name with which to sort results.,Required when specifying ‘sort=tag’.

• #state ⇒ String^?

  AMI state to match.

• #virtualization_type ⇒ Object^?

  Virtualization type to match (e.g. hvm).

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

#ami_id ⇒ Object^?

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

attribute :ami_id

#ami_tags ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 26

attribute :ami_tags

#architecture ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 30

attribute :architecture

#hypervisor ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 33

attribute :hypervisor

#is_public ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 36

attribute :is_public

#name ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 40

attribute :name

#no_result_action ⇒ :success, ...

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

attribute :no_result_action

#owner ⇒ String^?

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

attribute :owner

#platform ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 44

attribute :platform

#product_code ⇒ Object^?

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

attribute :product_code

#region ⇒ Object

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

attribute :region

#root_device_type ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 75

attribute :root_device_type

#sort ⇒ :name, ...

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

attribute :sort

#sort_end ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 64

attribute :sort_end

#sort_order ⇒ :ascending, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 57

attribute :sort_order

#sort_start ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 61

attribute :sort_start

#sort_tag ⇒ Object^?

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

attribute :sort_tag

#state ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 68

attribute :state

#virtualization_type ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_ami_find.rb', line 72

attribute :virtualization_type