AWS CDK Reference

Appearance

v2.274.0

CfnSecurityGroupIngressProps Struct ​

Properties for defining a CfnSecurityGroupIngress.

Source
Generated code
Type last changed
v2.227.0 · 21 Nov 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnSecurityGroupIngressProps: ec2.CfnSecurityGroupIngressProps = {
  ipProtocol: 'ipProtocol',

  // the properties below are optional
  cidrIp: 'cidrIp',
  cidrIpv6: 'cidrIpv6',
  description: 'description',
  fromPort: 123,
  groupId: 'groupId',
  groupName: 'groupName',
  sourcePrefixListId: 'sourcePrefixListId',
  sourceSecurityGroupId: 'sourceSecurityGroupId',
  sourceSecurityGroupName: 'sourceSecurityGroupName',
  sourceSecurityGroupOwnerId: 'sourceSecurityGroupOwnerId',
  toPort: 123,
};

Properties ​

cidrIpoptionalstringcidr_ipoptionalstrcidrIpoptionalStringCidrIpoptionalstringCidrIpoptional*string#
The IPv4 address range, in CIDR format.
notes

You must specify exactly one of the following: CidrIp , CidrIpv6 , SourcePrefixListId , or SourceSecurityGroupId .

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 .

cidrIpv6optionalstringcidr_ipv6optionalstrcidrIpv6optionalStringCidrIpv6optionalstringCidrIpv6optional*string#
The IPv6 address range, in CIDR format.
notes

You must specify exactly one of the following: CidrIp , CidrIpv6 , SourcePrefixListId , or SourceSecurityGroupId .

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 .

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Updates the description of an ingress (inbound) security group rule.

You can replace an existing description, or add a description to a rule that did not have one previously.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-😕()#,@[]+=;{}!$*

fromPortoptionalnumberfrom_portoptionalint | floatfromPortoptionalNumberFromPortoptionaldoubleFromPortoptional*float64#
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Use this for ICMP and any protocol that uses ports.

groupIdoptionalstring | ISecurityGroupRefgroup_idoptionaltyping.Union[str, ISecurityGroupRef]groupIdoptionalStringGroupIdoptionalstringGroupIdoptionalinterface{}#
The ID of the security group.
groupNameoptionalstring | ISecurityGroupRefgroup_nameoptionaltyping.Union[str, ISecurityGroupRef]groupNameoptionalStringGroupNameoptionalstringGroupNameoptionalinterface{}#
[Default VPC] The name of the security group.

For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.

ipProtocolstringip_protocolstripProtocolStringIpProtocolstringIpProtocol*stringrequired#
The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
notes

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.

sourcePrefixListIdoptionalstring | IPrefixListRefsource_prefix_list_idoptionaltyping.Union[str, IPrefixListRef]sourcePrefixListIdoptionalStringSourcePrefixListIdoptionalstringSourcePrefixListIdoptionalinterface{}#
The ID of a prefix list.
sourceSecurityGroupIdoptionalstring | ISecurityGroupRefsource_security_group_idoptionaltyping.Union[str, ISecurityGroupRef]sourceSecurityGroupIdoptionalStringSourceSecurityGroupIdoptionalstringSourceSecurityGroupIdoptionalinterface{}#
The ID of the security group.

You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.

sourceSecurityGroupNameoptionalstringsource_security_group_nameoptionalstrsourceSecurityGroupNameoptionalStringSourceSecurityGroupNameoptionalstringSourceSecurityGroupNameoptional*string#
[Default VPC] The name of the source security group.
notes

You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.

For security groups in a nondefault VPC, you must specify the group ID.

sourceSecurityGroupOwnerIdoptionalstringsource_security_group_owner_idoptionalstrsourceSecurityGroupOwnerIdoptionalStringSourceSecurityGroupOwnerIdoptionalstringSourceSecurityGroupOwnerIdoptional*string#
[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
notes

You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.

If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify SourceSecurityGroupOwnerId ; otherwise, this property is optional.

toPortoptionalnumberto_portoptionalint | floattoPortoptionalNumberToPortoptionaldoubleToPortoptional*float64#
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Use this for ICMP and any protocol that uses ports.