amazon.aws.ec2_group – maintain an ec2 VPC security group.¶
Note
This plugin is part of the amazon.aws collection (version 1.4.1).
To install it use: ansible-galaxy collection install amazon.aws
.
To use it in a playbook, specify: amazon.aws.ec2_group
.
New in version 1.0.0: of amazon.aws
Requirements¶
The below requirements are needed on the host that executes this module.
boto
boto3
python >= 2.6
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aws_access_key
string
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_access_key, access_key |
||
aws_ca_bundle
path
|
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
|
||
aws_config
dictionary
|
A dictionary to modify the botocore configuration.
Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
|
||
aws_secret_key
string
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_secret_key, secret_key |
||
debug_botocore_endpoint_logs
boolean
|
|
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
|
|
description
string
|
Description of the security group. Required when
state is present . |
||
ec2_url
string
|
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
aliases: aws_endpoint_url, endpoint_url |
||
group_id
string
|
Id of group to delete (works only with absent).
One of and only one of name or group_id is required.
|
||
name
string
|
Name of the security group.
One of and only one of name or group_id is required.
Required if state=present.
|
||
profile
string
|
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
aliases: aws_profile |
||
purge_rules
boolean
|
"true"
|
Purge existing rules on security group that are not found in rules.
|
|
purge_rules_egress
boolean
|
"true"
|
Purge existing rules_egress on security group that are not found in rules_egress.
|
|
purge_tags
boolean
|
|
If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
|
|
region
string
|
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region |
||
rules
list
/ elements=dictionary
|
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.
|
||
cidr_ip
string
|
The IPv4 CIDR range traffic is coming from.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
cidr_ipv6
string
|
The IPv6 CIDR range traffic is coming from.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
from_port
integer
|
The start of the range of ports that traffic is coming from. A value of
-1 indicates all ports. |
||
group_desc
string
|
If the group_name is set and the Security Group doesn't exist a new Security Group will be created with group_desc as the description.
|
||
group_id
string
|
The ID of the Security Group that traffic is coming from.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
group_name
string
|
Name of the Security Group that traffic is coming from.
If the Security Group doesn't exist a new Security Group will be created with group_desc as the description.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
ip_prefix
string
|
The IP Prefix https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-prefix-lists.html that traffic is coming from.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
proto
string
|
The IP protocol name (
tcp , udp , icmp , icmpv6 ) or number (https://en.wikipedia.org/wiki/List_of_IP_protocol_numbers) |
||
rule_desc
string
|
A description for the rule.
|
||
to_port
integer
|
The end of the range of ports that traffic is coming from. A value of
-1 indicates all ports. |
||
rules_egress
list
/ elements=dictionary
|
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.
|
||
cidr_ip
string
|
The IPv4 CIDR range traffic is going to.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
cidr_ipv6
string
|
The IPv6 CIDR range traffic is going to.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
from_port
integer
|
The start of the range of ports that traffic is going to. A value of
-1 indicates all ports. |
||
group_desc
string
|
If the group_name is set and the Security Group doesn't exist a new Security Group will be created with group_desc as the description.
|
||
group_id
string
|
The ID of the Security Group that traffic is going to.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
group_name
string
|
Name of the Security Group that traffic is going to.
If the Security Group doesn't exist a new Security Group will be created with group_desc as the description.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
ip_prefix
string
|
The IP Prefix https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-prefix-lists.html that traffic is going to.
You can specify only one of cidr_ip, cidr_ipv6, ip_prefix, group_id and group_name.
|
||
proto
string
|
The IP protocol name (
tcp , udp , icmp , icmpv6 ) or number (https://en.wikipedia.org/wiki/List_of_IP_protocol_numbers) |
||
rule_desc
string
|
A description for the rule.
|
||
to_port
integer
|
The end of the range of ports that traffic is going to. A value of
-1 indicates all ports. |
||
security_token
string
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: aws_security_token, access_token |
||
state
string
|
|
Create or delete a security group.
|
|
tags
dictionary
|
A dictionary of one or more tags to assign to the security group.
aliases: resource_tags |
||
validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
|
vpc_id
string
|
ID of the VPC to create the group in.
|
Notes¶
Note
If a rule declares a group_name and that group doesn’t exist, it will be automatically created. In that case, group_desc should be provided as well. The module will refuse to create a depended-on group without a description.
Preview diff mode support is added in version 2.7.
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples¶
- name: example using security group rule descriptions
amazon.aws.ec2_group:
name: "{{ name }}"
description: sg with rule descriptions
vpc_id: vpc-xxxxxxxx
profile: "{{ aws_profile }}"
region: us-east-1
rules:
- proto: tcp
ports:
- 80
cidr_ip: 0.0.0.0/0
rule_desc: allow all on port 80
- name: example ec2 group
amazon.aws.ec2_group:
name: example
description: an example EC2 group
vpc_id: 12345
region: eu-west-1
aws_secret_key: SECRET
aws_access_key: ACCESS
rules:
- proto: tcp
from_port: 80
to_port: 80
cidr_ip: 0.0.0.0/0
- proto: tcp
from_port: 22
to_port: 22
cidr_ip: 10.0.0.0/8
- proto: tcp
from_port: 443
to_port: 443
# this should only be needed for EC2 Classic security group rules
# because in a VPC an ELB will use a user-account security group
group_id: amazon-elb/sg-87654321/amazon-elb-sg
- proto: tcp
from_port: 3306
to_port: 3306
group_id: 123412341234/sg-87654321/exact-name-of-sg
- proto: udp
from_port: 10050
to_port: 10050
cidr_ip: 10.0.0.0/8
- proto: udp
from_port: 10051
to_port: 10051
group_id: sg-12345678
- proto: icmp
from_port: 8 # icmp type, -1 = any type
to_port: -1 # icmp subtype, -1 = any subtype
cidr_ip: 10.0.0.0/8
- proto: all
# the containing group name may be specified here
group_name: example
- proto: all
# in the 'proto' attribute, if you specify -1, all, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6),
# traffic on all ports is allowed, regardless of any ports you specify
from_port: 10050 # this value is ignored
to_port: 10050 # this value is ignored
cidr_ip: 10.0.0.0/8
rules_egress:
- proto: tcp
from_port: 80
to_port: 80
cidr_ip: 0.0.0.0/0
cidr_ipv6: 64:ff9b::/96
group_name: example-other
# description to use if example-other needs to be created
group_desc: other example EC2 group
- name: example2 ec2 group
amazon.aws.ec2_group:
name: example2
description: an example2 EC2 group
vpc_id: 12345
region: eu-west-1
rules:
# 'ports' rule keyword was introduced in version 2.4. It accepts a single port value or a list of values including ranges (from_port-to_port).
- proto: tcp
ports: 22
group_name: example-vpn
- proto: tcp
ports:
- 80
- 443
- 8080-8099
cidr_ip: 0.0.0.0/0
# 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.
- proto: tcp
ports:
- 6379
- 26379
group_name:
- example-vpn
- example-redis
- proto: tcp
ports: 5665
group_name: example-vpn
cidr_ip:
- 172.16.1.0/24
- 172.16.17.0/24
cidr_ipv6:
- 2607:F8B0::/32
- 64:ff9b::/96
group_id:
- sg-edcd9784
diff: True
- name: "Delete group by its id"
amazon.aws.ec2_group:
region: eu-west-1
group_id: sg-33b4ee5b
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Andrew de Quincey (@adq)