Package software.amazon.awscdk.services.ec2

Class CfnSecurityGroupEgress

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnSecurityGroupEgress
All Implemented Interfaces:
IInspectable, ISecurityGroupEgressRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.948Z") @Stability(Stable) public class CfnSecurityGroupEgress extends CfnResource implements IInspectable, ISecurityGroupEgressRef
Adds the specified outbound (egress) rule to a security group.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses 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 destinations: an IPv4 address range, an 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. To specify all types or all codes, use -1.

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

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.*;
 CfnSecurityGroupEgress cfnSecurityGroupEgress = CfnSecurityGroupEgress.Builder.create(this, "MyCfnSecurityGroupEgress")
         .groupId("groupId")
         .ipProtocol("ipProtocol")
         // the properties below are optional
         .cidrIp("cidrIp")
         .cidrIpv6("cidrIpv6")
         .description("description")
         .destinationPrefixListId("destinationPrefixListId")
         .destinationSecurityGroupId("destinationSecurityGroupId")
         .fromPort(123)
         .toPort(123)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSecurityGroupEgress

      protected CfnSecurityGroupEgress(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSecurityGroupEgress

      protected CfnSecurityGroupEgress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSecurityGroupEgress

      @Stability(Stable) public CfnSecurityGroupEgress(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSecurityGroupEgressProps props)
      Create a new AWS::EC2::SecurityGroupEgress.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnSecurityGroupEgress

      @Stability(Stable) @NotNull public static Boolean isCfnSecurityGroupEgress(@NotNull Object x)
      Checks whether the given object is a CfnSecurityGroupEgress.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSecurityGroupEgressRef

      @Stability(Stable) @NotNull public SecurityGroupEgressReference getSecurityGroupEgressRef()
      A reference to a SecurityGroupEgress resource.
      Specified by:
      getSecurityGroupEgressRef in interface ISecurityGroupEgressRef

    • getGroupId

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

    • setGroupId

      @Stability(Stable) public void setGroupId(@NotNull String value)
      The ID of the security group.

    • getIpProtocol

      @Stability(Stable) @NotNull public String getIpProtocol()
      The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).

    • setIpProtocol

      @Stability(Stable) public void setIpProtocol(@NotNull String value)
      The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).

    • getCidrIp

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

    • setCidrIp

      @Stability(Stable) public void setCidrIp(@Nullable String value)
      The IPv4 address range, in CIDR format.

    • getCidrIpv6

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

    • setCidrIpv6

      @Stability(Stable) public void setCidrIpv6(@Nullable String value)
      The IPv6 address range, in CIDR format.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of an egress (outbound) security group rule.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of an egress (outbound) security group rule.

    • getDestinationPrefixListId

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

    • setDestinationPrefixListId

      @Stability(Stable) public void setDestinationPrefixListId(@Nullable String value)
      The prefix list IDs for an AWS service.

    • getDestinationSecurityGroupId

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

    • setDestinationSecurityGroupId

      @Stability(Stable) public void setDestinationSecurityGroupId(@Nullable String value)
      The ID of the security group.

    • getFromPort

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

    • setFromPort

      @Stability(Stable) public void setFromPort(@Nullable Number value)
      If the protocol is TCP or UDP, this is the start of the port range.

    • getToPort

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

    • setToPort

      @Stability(Stable) public void setToPort(@Nullable Number value)
      If the protocol is TCP or UDP, this is the end of the port range.