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.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:00.690Z")
@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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSecurityGroupEgressProps.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()	The description of an egress (outbound) security group rule.
default String	getDestinationPrefixListId()	The prefix list IDs for an AWS service.
default String	getDestinationSecurityGroupId()	The ID of the security group.
default Number	getFromPort()	If the protocol is TCP or UDP, this is the start of the port range.
String	getGroupId()	The ID of the security group.
String	getIpProtocol()	The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
default Number	getToPort()	If the protocol is TCP or UDP, this is the end of the port range.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

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

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.

See Also:

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

getCidrIp

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

The IPv4 address range, in CIDR format.

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

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-securitygroupegress.html#cfn-ec2-securitygroupegress-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 , DestinationPrefixListId , or DestinationSecurityGroupId .

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-securitygroupegress.html#cfn-ec2-securitygroupegress-cidripv6

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

See Also:

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

getDestinationPrefixListId

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

The prefix list IDs for an AWS service.

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

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

See Also:

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

getDestinationSecurityGroupId

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

The ID of the security group.

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

See Also:

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

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 ICMP type or -1 (all ICMP types).

See Also:

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

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 ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

See Also:

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

builder

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

Returns:

a CfnSecurityGroupEgressProps.Builder of CfnSecurityGroupEgressProps