Revoke Security Group Egress

ec2_revoke_security_group_egress

R Documentation

Removes the specified outbound (egress) rules from the specified security group

Description

Removes the specified outbound (egress) rules from the specified security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

Usage

ec2_revoke_security_group_egress(DryRun, GroupId, IpPermissions,
  SecurityGroupRuleIds, CidrIp, FromPort, IpProtocol, ToPort,
  SourceSecurityGroupName, SourceSecurityGroupOwnerId)

Arguments

DryRun

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

[required] The ID of the security group.

IpPermissions

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.

SecurityGroupRuleIds

The IDs of the security group rules.

CidrIp

Not supported. Use a set of IP permissions to specify the CIDR.

FromPort

Not supported. Use a set of IP permissions to specify the port.

IpProtocol

Not supported. Use a set of IP permissions to specify the protocol name or number.

ToPort

Not supported. Use a set of IP permissions to specify the port.

SourceSecurityGroupName

Not supported. Use a set of IP permissions to specify a destination security group.

SourceSecurityGroupOwnerId

Not supported. Use a set of IP permissions to specify a destination security group.

Value

A list with the following syntax:

list(
  Return = TRUE|FALSE,
  UnknownIpPermissions = list(
    list(
      FromPort = 123,
      IpProtocol = "string",
      IpRanges = list(
        list(
          CidrIp = "string",
          Description = "string"
        )
      ),
      Ipv6Ranges = list(
        list(
          CidrIpv6 = "string",
          Description = "string"
        )
      ),
      PrefixListIds = list(
        list(
          Description = "string",
          PrefixListId = "string"
        )
      ),
      ToPort = 123,
      UserIdGroupPairs = list(
        list(
          Description = "string",
          GroupId = "string",
          GroupName = "string",
          PeeringStatus = "string",
          UserId = "string",
          VpcId = "string",
          VpcPeeringConnectionId = "string"
        )
      )
    )
  )
)

Request syntax

svc$revoke_security_group_egress(
  DryRun = TRUE|FALSE,
  GroupId = "string",
  IpPermissions = list(
    list(
      FromPort = 123,
      IpProtocol = "string",
      IpRanges = list(
        list(
          CidrIp = "string",
          Description = "string"
        )
      ),
      Ipv6Ranges = list(
        list(
          CidrIpv6 = "string",
          Description = "string"
        )
      ),
      PrefixListIds = list(
        list(
          Description = "string",
          PrefixListId = "string"
        )
      ),
      ToPort = 123,
      UserIdGroupPairs = list(
        list(
          Description = "string",
          GroupId = "string",
          GroupName = "string",
          PeeringStatus = "string",
          UserId = "string",
          VpcId = "string",
          VpcPeeringConnectionId = "string"
        )
      )
    )
  ),
  SecurityGroupRuleIds = list(
    "string"
  ),
  CidrIp = "string",
  FromPort = 123,
  IpProtocol = "string",
  ToPort = 123,
  SourceSecurityGroupName = "string",
  SourceSecurityGroupOwnerId = "string"
)