EC2 / Client / authorize_security_group_egress

authorize_security_group_egress#

EC2.Client.authorize_security_group_egress(**kwargs)#

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.

Note

If you want to reference a security group across VPCs attached to a transit gateway using the security group referencing feature, note that you can only reference security groups for ingress rules. You cannot reference a security group for egress rules.

Request Syntax

response = client.authorize_security_group_egress(
    DryRun=True|False,
    GroupId='string',
    IpPermissions=[
        {
            'FromPort': 123,
            'IpProtocol': 'string',
            'IpRanges': [
                {
                    'CidrIp': 'string',
                    'Description': 'string'
                },
            ],
            'Ipv6Ranges': [
                {
                    'CidrIpv6': 'string',
                    'Description': 'string'
                },
            ],
            'PrefixListIds': [
                {
                    'Description': 'string',
                    'PrefixListId': 'string'
                },
            ],
            'ToPort': 123,
            'UserIdGroupPairs': [
                {
                    'Description': 'string',
                    'GroupId': 'string',
                    'GroupName': 'string',
                    'PeeringStatus': 'string',
                    'UserId': 'string',
                    'VpcId': 'string',
                    'VpcPeeringConnectionId': 'string'
                },
            ]
        },
    ],
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'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-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    CidrIp='string',
    FromPort=123,
    IpProtocol='string',
    ToPort=123,
    SourceSecurityGroupName='string',
    SourceSecurityGroupOwnerId='string'
)

Parameters:

DryRun (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 is UnauthorizedOperation.
GroupId (string) –
[REQUIRED]

The ID of the security group.
IpPermissions (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.
- (dict) –
  
  Describes a set of permissions for a security group rule.
  - FromPort (integer) –
    
    If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
  - IpProtocol (string) –
    
    The IP protocol name ( tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
    
    Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
  - IpRanges (list) –
    
    The IPv4 ranges.
    - (dict) –
      
      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) –
    
    The IPv6 ranges.
    - (dict) –
      
      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) –
    
    The prefix list IDs.
    - (dict) –
      
      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) –
    
    If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
  - UserIdGroupPairs (list) –
    
    The security group and Amazon Web Services account ID pairs.
    - (dict) –
      
      Describes a security group and Amazon Web Services account ID pair.
      - 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) –
        
        [Default VPC] The name of the security group. 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.
      - 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.
TagSpecifications (list) –
The tags applied to the security group rule.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists 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.
    - (dict) –
      
      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.
CidrIp (string) – Not supported. Use a set of IP permissions to specify the CIDR.
FromPort (integer) – Not supported. Use a set of IP permissions to specify the port.
IpProtocol (string) – Not supported. Use a set of IP permissions to specify the protocol name or number.
ToPort (integer) – Not supported. Use a set of IP permissions to specify the port.
SourceSecurityGroupName (string) – Not supported. Use a set of IP permissions to specify a destination security group.
SourceSecurityGroupOwnerId (string) – Not supported. Use a set of IP permissions to specify a destination security group.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False,
    'SecurityGroupRules': [
        {
            'SecurityGroupRuleId': 'string',
            'GroupId': 'string',
            'GroupOwnerId': 'string',
            'IsEgress': True|False,
            'IpProtocol': 'string',
            'FromPort': 123,
            'ToPort': 123,
            'CidrIpv4': 'string',
            'CidrIpv6': 'string',
            'PrefixListId': 'string',
            'ReferencedGroupInfo': {
                'GroupId': 'string',
                'PeeringStatus': 'string',
                'UserId': 'string',
                'VpcId': 'string',
                'VpcPeeringConnectionId': 'string'
            },
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- Return (boolean) –
  
  Returns true if the request succeeds; otherwise, returns an error.
- SecurityGroupRules (list) –
  
  Information about the outbound (egress) security group rules that were added.
  - (dict) –
    
    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 -1 to specify all protocols.
    - FromPort (integer) –
      
      If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
    - ToPort (integer) –
      
      If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.
    - CidrIpv4 (string) –
      
      The IPv4 CIDR range.
    - CidrIpv6 (string) –
      
      The IPv6 CIDR range.
    - PrefixListId (string) –
      
      The ID of the prefix list.
    - ReferencedGroupInfo (dict) –
      
      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 (if applicable).
    - Description (string) –
      
      The security group rule description.
    - Tags (list) –
      
      The tags applied to the security group rule.
      - (dict) –
        
        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.

Examples

This example adds a rule that grants access to the specified address ranges on TCP port 80.

response = client.authorize_security_group_egress(
    GroupId='sg-1a2b3c4d',
    IpPermissions=[
        {
            'FromPort': 80,
            'IpProtocol': 'tcp',
            'IpRanges': [
                {
                    'CidrIp': '10.0.0.0/16',
                },
            ],
            'ToPort': 80,
        },
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example adds a rule that grants access to the specified security group on TCP port 80.

response = client.authorize_security_group_egress(
    GroupId='sg-1a2b3c4d',
    IpPermissions=[
        {
            'FromPort': 80,
            'IpProtocol': 'tcp',
            'ToPort': 80,
            'UserIdGroupPairs': [
                {
                    'GroupId': 'sg-4b51a32f',
                },
            ],
        },
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}