Package software.amazon.awscdk.services.ec2

Interface CfnSecurityGroupIngressProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSecurityGroupIngressProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.933Z") @Stability(Stable) public interface CfnSecurityGroupIngressProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnSecurityGroupIngress.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnSecurityGroupIngressProps cfnSecurityGroupIngressProps = CfnSecurityGroupIngressProps.builder()
         .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)
         .build();

  • Method Details

    • getIpProtocol

      @Stability(Stable) @NotNull 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.

    • getCidrIp

      @Stability(Stable) @Nullable default String getCidrIp()
      The IPv4 address range, in CIDR format.

      You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).

      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 .

    • getCidrIpv6

      @Stability(Stable) @Nullable default String getCidrIpv6()
      The IPv6 address range, in CIDR format.

      You must specify a source security group ( SourcePrefixListId or SourceSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).

      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 .

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

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

    • getGroupId

      @Stability(Stable) @Nullable default String getGroupId()
      The ID of the security group.

    • getGroupName

      @Stability(Stable) @Nullable default String getGroupName()
      The name of the security group.

      Constraints: Up to 255 characters in length. Cannot start with sg- .

      Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

    • getSourcePrefixListId

      @Stability(Stable) @Nullable default String getSourcePrefixListId()
      The ID of a prefix list.

    • getSourceSecurityGroupId

      @Stability(Stable) @Nullable default String 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.

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

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

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

    • builder

      @Stability(Stable) static CfnSecurityGroupIngressProps.Builder builder()
      Returns:
      a CfnSecurityGroupIngressProps.Builder of CfnSecurityGroupIngressProps