Package software.amazon.awscdk.services.ec2

Interface CfnSecurityGroupEgressProps

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

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.*;
 CfnSecurityGroupEgressProps cfnSecurityGroupEgressProps = CfnSecurityGroupEgressProps.builder()
         .groupId("groupId")
         .ipProtocol("ipProtocol")
         // the properties below are optional
         .cidrIp("cidrIp")
         .cidrIpv6("cidrIpv6")
         .description("description")
         .destinationPrefixListId("destinationPrefixListId")
         .destinationSecurityGroupId("destinationSecurityGroupId")
         .fromPort(123)
         .toPort(123)
         .build();

  • Method Details

    • getGroupId

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

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

    • 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 destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) 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 destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) 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()
      The description of an egress (outbound) security group rule.

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

    • getDestinationPrefixListId

      @Stability(Stable) @Nullable default String getDestinationPrefixListId()
      The prefix list IDs for an AWS service.

      This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

      You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).

    • getDestinationSecurityGroupId

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

      You must specify a destination security group ( DestinationPrefixListId or DestinationSecurityGroupId ) or a CIDR range ( CidrIp or CidrIpv6 ).

    • getFromPort

      @Stability(Stable) @Nullable default Number getFromPort()
      If the protocol is TCP or UDP, this is the start of the port range.

      If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

    • getToPort

      @Stability(Stable) @Nullable default Number getToPort()
      If the protocol is TCP or UDP, this is the end of the port range.

      If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

    • builder

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