authorize-security-group-egress¶
Note
To specify multiple rules in a single command use the --ip-permissions option
Description¶
[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups. When specifying an outbound rule for your security group in a VPC, the IpPermissions must include a destination for the traffic.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
authorize-security-group-egress
[--dry-run | --no-dry-run]
--group-id <value>
[--ip-permissions <value>]
[--tag-specifications <value>]
[--protocol <value>]
[--port <value>]
[--cidr <value>]
[--source-group <value>]
[--group-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--dry-run | --no-dry-run (boolean)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.
--group-id (string)
The ID of the security group.
--ip-permissions (list)
The sets of IP permissions. You can’t specify a destination security group and a CIDR IP address range in the same set of permissions.
(structure)
Describes a set of permissions for a security group rule.
FromPort -> (integer)
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of
-1indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.IpProtocol -> (string)
The IP protocol name (
tcp,udp,icmp,icmpv6) or number (see Protocol Numbers ).[VPC only] Use
-1to specify all protocols. When authorizing security group rules, specifying-1or a protocol number other thantcp,udp,icmp, oricmpv6allows traffic on all ports, regardless of any port range you specify. Fortcp,udp, andicmp, you must specify a port range. Foricmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.IpRanges -> (list)
The IPv4 ranges.
(structure)
Describes an IPv4 range.
CidrIp -> (string)
The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
Description -> (string)
A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
Ipv6Ranges -> (list)
[VPC only] The IPv6 ranges.
(structure)
[EC2-VPC only] Describes an IPv6 range.
CidrIpv6 -> (string)
The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
Description -> (string)
A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
PrefixListIds -> (list)
[VPC only] The prefix list IDs.
(structure)
Describes a prefix list ID.
Description -> (string)
A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
PrefixListId -> (string)
The ID of the prefix.
ToPort -> (integer)
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of
-1indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.UserIdGroupPairs -> (list)
The security group and Amazon Web Services account ID pairs.
(structure)
Describes a security group and Amazon Web Services account ID pair.
Note
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide .
Description -> (string)
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
GroupId -> (string)
The ID of the security group.
GroupName -> (string)
The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
PeeringStatus -> (string)
The status of a VPC peering connection, if applicable.
UserId -> (string)
The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
VpcId -> (string)
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId -> (string)
The ID of the VPC peering connection, if applicable.
Shorthand Syntax:
FromPort=integer,IpProtocol=string,IpRanges=[{CidrIp=string,Description=string},{CidrIp=string,Description=string}],Ipv6Ranges=[{CidrIpv6=string,Description=string},{CidrIpv6=string,Description=string}],PrefixListIds=[{Description=string,PrefixListId=string},{Description=string,PrefixListId=string}],ToPort=integer,UserIdGroupPairs=[{Description=string,GroupId=string,GroupName=string,PeeringStatus=string,UserId=string,VpcId=string,VpcPeeringConnectionId=string},{Description=string,GroupId=string,GroupName=string,PeeringStatus=string,UserId=string,VpcId=string,VpcPeeringConnectionId=string}] ...
JSON Syntax:
[
{
"FromPort": integer,
"IpProtocol": "string",
"IpRanges": [
{
"CidrIp": "string",
"Description": "string"
}
...
],
"Ipv6Ranges": [
{
"CidrIpv6": "string",
"Description": "string"
}
...
],
"PrefixListIds": [
{
"Description": "string",
"PrefixListId": "string"
}
...
],
"ToPort": integer,
"UserIdGroupPairs": [
{
"Description": "string",
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
...
]
}
...
]
--tag-specifications (list)
The tags applied to the security group rule.
(structure)
The tags to apply to a resource when the resource is being created.
Note
The
Valid Valueslists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.ResourceType -> (string)
The type of resource to tag on creation.
Tags -> (list)
The tags to apply to the resource.
(structure)
Describes a tag.
Key -> (string)
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:.Value -> (string)
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Shorthand Syntax:
ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...
JSON Syntax:
[
{
"ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-service"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type",
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
]
}
...
]
--protocol (string)
The IP protocol:
tcp|udp|icmp(VPC only) Use
allto specify all protocols.If this argument is provided without also providing the
portargument, then it will be applied to all ports for the specified protocol.
--port (string)
For TCP or UDP: The range of ports to allow. A single integer or a range (
min-max).For ICMP: A single integer or a range (
type-code) representing the ICMP type number and the ICMP code number respectively. A value of -1 indicates all ICMP codes for all ICMP types. A value of -1 just fortypeindicates all ICMP codes for the specified ICMP type.
--cidr (string)
The CIDR IP range.
--source-group (string)
The name or ID of the source security group.
--group-owner (string)
The AWS account ID that owns the source security group. Cannot be used when specifying a CIDR IP address.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To add a rule that allows outbound traffic to a specific address range
This example command adds a rule that grants access to the specified address ranges on TCP port 80.
Command (Linux):
aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges='[{CidrIp=10.0.0.0/16}]'
Command (Windows):
aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=10.0.0.0/16}]
To add a rule that allows outbound traffic to a specific security group
This example command adds a rule that grants access to the specified security group on TCP port 80.
Command (Linux):
aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs='[{GroupId=sg-4b51a32f}]'
Command (Windows):
aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs=[{GroupId=sg-4b51a32f}]
Output¶
Return -> (boolean)
Returns
trueif the request succeeds; otherwise, returns an error.
SecurityGroupRules -> (list)
Information about the outbound (egress) security group rules that were added.
(structure)
Describes a security group rule.
SecurityGroupRuleId -> (string)
The ID of the security group rule.
GroupId -> (string)
The ID of the security group.
GroupOwnerId -> (string)
The ID of the Amazon Web Services account that owns the security group.
IsEgress -> (boolean)
Indicates whether the security group rule is an outbound rule.
IpProtocol -> (string)
The IP protocol name (
tcp,udp,icmp,icmpv6) or number (see Protocol Numbers ).Use
-1to specify all protocols.FromPort -> (integer)
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort -> (integer)
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of
-1indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.CidrIpv4 -> (string)
The IPv4 CIDR range.
CidrIpv6 -> (string)
The IPv6 CIDR range.
PrefixListId -> (string)
The ID of the prefix list.
ReferencedGroupInfo -> (structure)
Describes the security group that is referenced in the rule.
GroupId -> (string)
The ID of the security group.
PeeringStatus -> (string)
The status of a VPC peering connection, if applicable.
UserId -> (string)
The Amazon Web Services account ID.
VpcId -> (string)
The ID of the VPC.
VpcPeeringConnectionId -> (string)
The ID of the VPC peering connection.
Description -> (string)
The security group rule description.
Tags -> (list)
The tags applied to the security group rule.
(structure)
Describes a tag.
Key -> (string)
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:.Value -> (string)
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.