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

Inherits:
Base show all
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 collapse

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

#ami_id ⇒ Object?

Returns An AMI ID to match.

Returns:

  • (Object, nil) —

    An AMI ID to match.



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

attribute :ami_id

#ami_tags ⇒ Hash?

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

Returns:

  • (Hash, nil) —

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



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

attribute :ami_tags

#architecture ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :architecture

#hypervisor ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :hypervisor

#is_public ⇒ Symbol?

Returns Whether or not the image(s) are public.

Returns:

  • (Symbol, nil) —

    Whether or not the image(s) are public.



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

attribute :is_public

#name ⇒ String?

Returns An AMI name to match.

Returns:

  • (String, nil) —

    An AMI name to match.



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

attribute :name

#no_result_action ⇒ :success, ...

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

Returns:

  • (:success, :fail, nil) —

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



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

attribute :no_result_action

#owner ⇒ String?

Returns 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. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash () before the character. For example, a value of *amazon?\ searches for the literal string *amazon?.

Returns:

  • (String, nil) —

    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. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash () before the character. For example, a value of *amazon?\ searches for the literal string *amazon?.



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

attribute :owner

#platform ⇒ Object?

Returns Platform type to match.

Returns:

  • (Object, nil) —

    Platform type to match.



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

attribute :platform

#product_code ⇒ Object?

Returns Marketplace product code to match.

Returns:

  • (Object, nil) —

    Marketplace product code to match.



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

attribute :product_code

#region ⇒ Object

Returns The AWS region to use.

Returns:

  • (Object) —

    The AWS region to use.



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

attribute :region

#root_device_type ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :root_device_type

#sort ⇒ :name, ...

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

Returns:

  • (:name, :description, :tag, :architecture, :block_device_mapping, :creationDate, :hypervisor, :is_public, :location, :owner_id, :platform, :root_device_name, :root_device_type, :state, :virtualization_type, nil) —

    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.



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

attribute :sort

#sort_end ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :sort_end

#sort_order ⇒ :ascending, ...

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

Returns:

  • (:ascending, :descending, nil) —

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



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

attribute :sort_order

#sort_start ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :sort_start

#sort_tag ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :sort_tag

#state ⇒ String?

Returns AMI state to match.

Returns:

  • (String, nil) —

    AMI state to match.



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

attribute :state

#virtualization_type ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :virtualization_type