Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Interface CfnSecurityGroupIngressMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityGroupIngressMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.623Z")
@Stability(Stable)
public interface CfnSecurityGroupIngressMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnSecurityGroupIngressPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ec2.*;
 CfnSecurityGroupIngressMixinProps cfnSecurityGroupIngressMixinProps = CfnSecurityGroupIngressMixinProps.builder()
         .cidrIp("cidrIp")
         .cidrIpv6("cidrIpv6")
         .description("description")
         .fromPort(123)
         .groupId("groupId")
         .groupName("groupName")
         .ipProtocol("ipProtocol")
         .sourcePrefixListId("sourcePrefixListId")
         .sourceSecurityGroupId("sourceSecurityGroupId")
         .sourceSecurityGroupName("sourceSecurityGroupName")
         .sourceSecurityGroupOwnerId("sourceSecurityGroupOwnerId")
         .toPort(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSecurityGroupIngressMixinProps.Builder	A builder for CfnSecurityGroupIngressMixinProps
static final class	CfnSecurityGroupIngressMixinProps.Jsii$Proxy	An implementation for CfnSecurityGroupIngressMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnSecurityGroupIngressMixinProps.Builder	builder()
default String	getCidrIp()	The IPv4 address range, in CIDR format.
default String	getCidrIpv6()	The IPv6 address range, in CIDR format.
default String	getDescription()	Updates the description of an ingress (inbound) security group rule.
default Number	getFromPort()	The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
default Object	getGroupId()	The ID of the security group.
default Object	getGroupName()	[Default VPC] The name of the security group.
default String	getIpProtocol()	The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
default Object	getSourcePrefixListId()	The ID of a prefix list.
default Object	getSourceSecurityGroupId()	The ID of the security group.
default String	getSourceSecurityGroupName()	[Default VPC] The name of the source security group.
default String	getSourceSecurityGroupOwnerId()	[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
default Number	getToPort()	The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCidrIp

@Stability(Stable)
@Nullable
default String getCidrIp()

The IPv4 address range, in CIDR format.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-cidrip

getCidrIpv6

@Stability(Stable)
@Nullable
default String getCidrIpv6()

The IPv6 address range, in CIDR format.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-cidripv6

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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 ._-:/()#,@[]+=;{}!$*

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-description

getFromPort

@Stability(Stable)
@Nullable
default Number getFromPort()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-fromport

getGroupId

@Stability(Stable)
@Nullable
default Object getGroupId()

The ID of the security group.

Returns union: either String or ISecurityGroupRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-groupid

getGroupName

@Stability(Stable)
@Nullable
default Object getGroupName()

[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.

Returns union: either String or ISecurityGroupRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-groupname

getIpProtocol

@Stability(Stable)
@Nullable
default String getIpProtocol()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-ipprotocol

getSourcePrefixListId

@Stability(Stable)
@Nullable
default Object getSourcePrefixListId()

The ID of a prefix list.

Returns union: either String or IPrefixListRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourceprefixlistid

getSourceSecurityGroupId

@Stability(Stable)
@Nullable
default Object getSourceSecurityGroupId()

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.

Returns union: either String or ISecurityGroupRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupid

getSourceSecurityGroupName

@Stability(Stable)
@Nullable
default String getSourceSecurityGroupName()

[Default VPC] The name of the source security group.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupname

getSourceSecurityGroupOwnerId

@Stability(Stable)
@Nullable
default String getSourceSecurityGroupOwnerId()

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-sourcesecuritygroupownerid

getToPort

@Stability(Stable)
@Nullable
default Number getToPort()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupingress.html#cfn-ec2-securitygroupingress-toport

builder

@Stability(Stable)
static CfnSecurityGroupIngressMixinProps.Builder builder()

Returns:

a CfnSecurityGroupIngressMixinProps.Builder of CfnSecurityGroupIngressMixinProps