Class: Ansible::Ruby::Modules::Ec2_tag

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

Overview

Creates, removes and lists tags for any EC2 resource. The resource is referenced by its resource id (e.g. an instance being i-XXXXXXX). It is designed to be used with complex args (tags), see the examples.

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

#purge_tags ⇒ Symbol?

Returns Whether unspecified tags should be removed from the resource.,Note that when combined with C(state: absent), specified tags with non-matching values are not purged.

Returns:

  • (Symbol, nil) —

    Whether unspecified tags should be removed from the resource.,Note that when combined with C(state: absent), specified tags with non-matching values are not purged.



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

attribute :purge_tags

#resource ⇒ String

Returns The EC2 resource id.

Returns:

  • (String) —

    The EC2 resource id.



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

attribute :resource

#state ⇒ :present, ...

Returns Whether the tags should be present or absent on the resource. Use list to interrogate the tags of an instance.

Returns:

  • (:present, :absent, :list, nil) —

    Whether the tags should be present or absent on the resource. Use list to interrogate the tags of an instance.



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

attribute :state

#tags ⇒ Hash

Returns a hash/dictionary of tags to add to the resource; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’.

Returns:

  • (Hash) —

    a hash/dictionary of tags to add to the resource; ‘“key”:“value”’ and ‘“key”:“value”,“key”:“value”’



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

attribute :tags