Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

AuthorizeSecurityGroupIngressCommand

Adds the specified inbound (ingress) rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules .

You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.

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

For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.

For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, AuthorizeSecurityGroupIngressCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, AuthorizeSecurityGroupIngressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // AuthorizeSecurityGroupIngressRequest
  CidrIp: "STRING_VALUE",
  FromPort: Number("int"),
  GroupId: "STRING_VALUE",
  GroupName: "STRING_VALUE",
  IpPermissions: [ // IpPermissionList
    { // IpPermission
      IpProtocol: "STRING_VALUE",
      FromPort: Number("int"),
      ToPort: Number("int"),
      UserIdGroupPairs: [ // UserIdGroupPairList
        { // UserIdGroupPair
          Description: "STRING_VALUE",
          UserId: "STRING_VALUE",
          GroupName: "STRING_VALUE",
          GroupId: "STRING_VALUE",
          VpcId: "STRING_VALUE",
          VpcPeeringConnectionId: "STRING_VALUE",
          PeeringStatus: "STRING_VALUE",
        },
      ],
      IpRanges: [ // IpRangeList
        { // IpRange
          Description: "STRING_VALUE",
          CidrIp: "STRING_VALUE",
        },
      ],
      Ipv6Ranges: [ // Ipv6RangeList
        { // Ipv6Range
          Description: "STRING_VALUE",
          CidrIpv6: "STRING_VALUE",
        },
      ],
      PrefixListIds: [ // PrefixListIdList
        { // PrefixListId
          Description: "STRING_VALUE",
          PrefixListId: "STRING_VALUE",
        },
      ],
    },
  ],
  IpProtocol: "STRING_VALUE",
  SourceSecurityGroupName: "STRING_VALUE",
  SourceSecurityGroupOwnerId: "STRING_VALUE",
  ToPort: Number("int"),
  TagSpecifications: [ // TagSpecificationList
    { // TagSpecification
      ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "declarative-policies-report" || "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" || "outpost-lag" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "service-link-virtual-interface" || "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" || "route-server" || "route-server-endpoint" || "route-server-peer" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "verified-access-endpoint-target" || "ipam-external-resource-verification-token" || "mac-modification-task",
      Tags: [ // TagList
        { // Tag
          Key: "STRING_VALUE",
          Value: "STRING_VALUE",
        },
      ],
    },
  ],
  DryRun: true || false,
};
const command = new AuthorizeSecurityGroupIngressCommand(input);
const response = await client.send(command);
// { // AuthorizeSecurityGroupIngressResult
//   Return: true || false,
//   SecurityGroupRules: [ // SecurityGroupRuleList
//     { // SecurityGroupRule
//       SecurityGroupRuleId: "STRING_VALUE",
//       GroupId: "STRING_VALUE",
//       GroupOwnerId: "STRING_VALUE",
//       IsEgress: true || false,
//       IpProtocol: "STRING_VALUE",
//       FromPort: Number("int"),
//       ToPort: Number("int"),
//       CidrIpv4: "STRING_VALUE",
//       CidrIpv6: "STRING_VALUE",
//       PrefixListId: "STRING_VALUE",
//       ReferencedGroupInfo: { // ReferencedSecurityGroup
//         GroupId: "STRING_VALUE",
//         PeeringStatus: "STRING_VALUE",
//         UserId: "STRING_VALUE",
//         VpcId: "STRING_VALUE",
//         VpcPeeringConnectionId: "STRING_VALUE",
//       },
//       Description: "STRING_VALUE",
//       Tags: [ // TagList
//         { // Tag
//           Key: "STRING_VALUE",
//           Value: "STRING_VALUE",
//         },
//       ],
//       SecurityGroupRuleArn: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

There was an error loading the code editor. Retry