Class: Ansible::Ruby::Modules::Ec2_group

Inherits:
Base show all
Includes:
Helpers::Aws
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/ec2_group.rb,
lib/ansible/ruby/modules/custom/cloud/core/amazon/ec2_group.rb

Overview

maintains ec2 security groups. This module has a dependency on python-boto >= 2.5

Instance Method Summary collapse

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

#description ⇒ String?

Returns Description of the security group. Required when C(state) is C(present).

Returns:

  • (String, nil) —

    Description of the security group. Required when C(state) is C(present).



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

attribute :description

#group_id ⇒ String?

Returns Id of group to delete (works only with absent).,One of and only one of I(name) or I(group_id) is required.

Returns:

  • (String, nil) —

    Id of group to delete (works only with absent).,One of and only one of I(name) or I(group_id) is required.



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

attribute :group_id

#name ⇒ String?

Returns Name of the security group.,One of and only one of I(name) or I(group_id) is required.,Required if I(state=present).

Returns:

  • (String, nil) —

    Name of the security group.,One of and only one of I(name) or I(group_id) is required.,Required if I(state=present).



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

attribute :name

#purge_rules ⇒ String?

Returns Purge existing rules on security group that are not found in rules.

Returns:

  • (String, nil) —

    Purge existing rules on security group that are not found in rules



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

attribute :purge_rules

#purge_rules_egress ⇒ String?

Returns Purge existing rules_egress on security group that are not found in rules_egress.

Returns:

  • (String, nil) —

    Purge existing rules_egress on security group that are not found in rules_egress



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

attribute :purge_rules_egress

#purge_tags ⇒ Boolean?

Returns If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then tags will not be modified.

Returns:

  • (Boolean, nil) —

    If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then tags will not be modified.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_group.rb', line 51

attribute :purge_tags

#rules ⇒ Array<Hash>, ...

Returns List of firewall inbound rules to enforce in this group (see example). If none are supplied, no inbound rules will be enabled. Rules list may include its own name in ‘group_name`. This allows idempotent loopback additions (e.g. allow group to access itself). Rule sources list support was added in version 2.4. This allows to define multiple sources per source type as well as multiple source types per rule. Prior to 2.4 an individual source is allowed. In version 2.5 support for rule descriptions was added.

Returns:

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

    List of firewall inbound rules to enforce in this group (see example). If none are supplied, no inbound rules will be enabled. Rules list may include its own name in ‘group_name`. This allows idempotent loopback additions (e.g. allow group to access itself). Rule sources list support was added in version 2.4. This allows to define multiple sources per source type as well as multiple source types per rule. Prior to 2.4 an individual source is allowed. In version 2.5 support for rule descriptions was added.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_group.rb', line 28

attribute :rules

#rules_egress ⇒ Array<Hash>, ...

Returns List of firewall outbound rules to enforce in this group (see example). If none are supplied, a default all-out rule is assumed. If an empty list is supplied, no outbound rules will be enabled. Rule Egress sources list support was added in version 2.4. In version 2.5 support for rule descriptions was added.

Returns:

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

    List of firewall outbound rules to enforce in this group (see example). If none are supplied, a default all-out rule is assumed. If an empty list is supplied, no outbound rules will be enabled. Rule Egress sources list support was added in version 2.4. In version 2.5 support for rule descriptions was added.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_group.rb', line 32

attribute :rules_egress

#state ⇒ :present, ...

Returns Create or delete a security group.

Returns:

  • (:present, :absent, nil) —

    Create or delete a security group



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

attribute :state

#tags ⇒ Object?

Returns A dictionary of one or more tags to assign to the security group.

Returns:

  • (Object, nil) —

    A dictionary of one or more tags to assign to the security group.



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_group.rb', line 48

attribute :tags

#vpc_id ⇒ String, ...

Returns ID of the VPC to create the group in.

Returns:

  • (String, Integer, nil) —

    ID of the VPC to create the group in.



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

attribute :vpc_id