.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VM::EC2::REST::security_group 3pm"
.TH VM::EC2::REST::security_group 3pm "2022-10-14" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME VM::EC2::REST::security_group \- Query and manipulate security groups"
.IX Header "NAME VM::EC2::REST::security_group - Query and manipulate security groups"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:standard\*(Aq;
.Ve
.SH "METHODS"
.IX Header "METHODS"
The methods in this section allow you to query and manipulate security
groups (firewall rules). See VM::EC2::SecurityGroup for functionality
that is available through these objects.
.PP
Implemented:
 AuthorizeSecurityGroupEgress (\s-1EC2\-VPC\s0 only)
 AuthorizeSecurityGroupIngress
 CreateSecurityGroup
 DeleteSecurityGroup
 DescribeSecurityGroups
 RevokeSecurityGroupEgress (\s-1EC2\-VPC\s0 only)
 RevokeSecurityGroupIngress
.PP
Unimplemented:
 (none)
.ie n .SS "@sg = $ec2\->describe_security_groups(@group_ids)"
.el .SS "\f(CW@sg\fP = \f(CW$ec2\fP\->describe_security_groups(@group_ids)"
.IX Subsection "@sg = $ec2->describe_security_groups(@group_ids)"
.ie n .SS "@sg = $ec2\->describe_security_groups(%args);"
.el .SS "\f(CW@sg\fP = \f(CW$ec2\fP\->describe_security_groups(%args);"
.IX Subsection "@sg = $ec2->describe_security_groups(%args);"
.ie n .SS "@sg = $ec2\->describe_security_groups(\e%filters);"
.el .SS "\f(CW@sg\fP = \f(CW$ec2\fP\->describe_security_groups(\e%filters);"
.IX Subsection "@sg = $ec2->describe_security_groups(%filters);"
Searches for security groups (firewall rules) matching the provided
filters and return a series of VM::EC2::SecurityGroup objects.
.PP
In the named-argument form you can provide the following optional
arguments:
.PP
.Vb 2
\& \-group_name      A single group name or an arrayref containing a list
\&                   of names
\&
\& \-name            Shorter version of \-group_name
\&
\& \-group_id        A single group id (i.e. \*(Aqsg\-12345\*(Aq) or an arrayref
\&                   containing a list of ids
\&
\& \-filter          Filter on tags and other attributes.
.Ve
.PP
The \-filter argument name can be omitted if there are no other
arguments you wish to pass.
.PP
The full list of security group filters can be found at:
http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeSecurityGroups.html
.ie n .SS "$group = $ec2\->create_security_group(\-group_name=>$name, \-group_description=>$description, \-vpc_id     => $vpc_id )"
.el .SS "\f(CW$group\fP = \f(CW$ec2\fP\->create_security_group(\-group_name=>$name, \-group_description=>$description, \-vpc_id     => \f(CW$vpc_id\fP )"
.IX Subsection "$group = $ec2->create_security_group(-group_name=>$name, -group_description=>$description, -vpc_id => $vpc_id )"
Create a security group. Arguments are:
.PP
.Vb 4
\& \-group_name              Name of the security group (required)
\& \-group_description       Description of the security group (required)
\& \-vpc_id                  Virtual private cloud security group ID
\&                           (required for VPC security groups)
.Ve
.PP
For convenience, you may use \-name and \-description as aliases for
\&\-group_name and \-group_description respectively.
.PP
If succcessful, the method returns an object of type
VM::EC2::SecurityGroup.
.ie n .SS "$boolean = $ec2\->delete_security_group($group_id)"
.el .SS "\f(CW$boolean\fP = \f(CW$ec2\fP\->delete_security_group($group_id)"
.IX Subsection "$boolean = $ec2->delete_security_group($group_id)"
.ie n .SS "$boolean = $ec2\->delete_security_group(\-group_id   => $group_id, \-group_name => $name);"
.el .SS "\f(CW$boolean\fP = \f(CW$ec2\fP\->delete_security_group(\-group_id   => \f(CW$group_id\fP, \-group_name => \f(CW$name\fP);"
.IX Subsection "$boolean = $ec2->delete_security_group(-group_id => $group_id, -group_name => $name);"
Delete a security group. Arguments are:
.PP
.Vb 2
\& \-group_name              Name of the security group
\& \-group_id                ID of the security group
.Ve
.PP
Either \-group_name or \-group_id is required. In the single-argument
form, the method deletes the security group given by its id.
.PP
If succcessful, the method returns true.
.ie n .SS "$boolean = $ec2\->update_security_group($security_group)"
.el .SS "\f(CW$boolean\fP = \f(CW$ec2\fP\->update_security_group($security_group)"
.IX Subsection "$boolean = $ec2->update_security_group($security_group)"
Add one or more incoming firewall rules to a security group. The rules
to add are stored in a VM::EC2::SecurityGroup which is created
either by \fBdescribe_security_groups()\fR or \fBcreate_security_group()\fR. This method combines
the actions AuthorizeSecurityGroupIngress,
AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and
RevokeSecurityGroupEgress.
.PP
For details, see VM::EC2::SecurityGroup. Here is a brief summary:
.PP
.Vb 1
\& $sg = $ec2\->create_security_group(\-name=>\*(AqMyGroup\*(Aq,\-description=>\*(AqExample group\*(Aq);
\&
\& # TCP on port 80 for the indicated address ranges
\& $sg\->authorize_incoming(\-protocol  => \*(Aqtcp\*(Aq,
\&                         \-port      => 80,
\&                         \-source_ip => [\*(Aq192.168.2.0/24\*(Aq,\*(Aq192.168.2.1/24\*(Aq});
\&
\& # TCP on ports 22 and 23 from anyone
\& $sg\->authorize_incoming(\-protocol  => \*(Aqtcp\*(Aq,
\&                         \-port      => \*(Aq22..23\*(Aq,
\&                         \-source_ip => \*(Aq0.0.0.0/0\*(Aq);
\&
\& # ICMP on echo (ping) port from anyone
\& $sg\->authorize_incoming(\-protocol  => \*(Aqicmp\*(Aq,
\&                         \-port      => \-1,
\&                         \-source_ip => \*(Aq0.0.0.0/0\*(Aq);
\&
\& # TCP to port 25 (mail) from instances belonging to
\& # the "Mail relay" group belonging to user 12345678.
\& $sg\->authorize_incoming(\-protocol  => \*(Aqtcp\*(Aq,
\&                         \-port      => 25,
\&                         \-group     => \*(Aq12345678/Mail relay\*(Aq);
\&
\& $result = $ec2\->update_security_group($sg);
.Ve
.PP
or more simply:
.PP
.Vb 1
\& $result = $sg\->update();
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL\s0 (either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.