Interface CfnSecurityGroupPropsMixin.IEgressProperty
Adds the specified outbound (egress) rule to a security group.
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.EC2
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public interface CfnSecurityGroupPropsMixin.IEgressPropertySyntax (vb)
Public Interface CfnSecurityGroupPropsMixin.IEgressPropertyRemarks
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP address ranges 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.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.EC2;
var egressProperty = new EgressProperty {
CidrIp = "cidrIp",
CidrIpv6 = "cidrIpv6",
Description = "description",
DestinationPrefixListId = "destinationPrefixListId",
DestinationSecurityGroupId = "destinationSecurityGroupId",
FromPort = 123,
IpProtocol = "ipProtocol",
ToPort = 123
};Synopsis
Properties
| CidrIp | The IPv4 address range, in CIDR format. |
| CidrIpv6 | The IPv6 address range, in CIDR format. |
| Description | A description for the security group rule. |
| DestinationPrefixListId | The prefix list IDs for the destination AWS service. |
| DestinationSecurityGroupId | The ID of the destination VPC security group. |
| FromPort | If the protocol is TCP or UDP, this is the start of the port range. |
| IpProtocol | The IP protocol name ( |
| ToPort | If the protocol is TCP or UDP, this is the end of the port range. |
Properties
CidrIp
The IPv4 address range, in CIDR format.
string? CidrIp { get; }Property Value
Remarks
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 .
CidrIpv6
The IPv6 address range, in CIDR format.
string? CidrIpv6 { get; }Property Value
Remarks
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 .
Description
A description for the security group rule.
string? Description { get; }Property Value
Remarks
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
DestinationPrefixListId
The prefix list IDs for the destination AWS service.
string? DestinationPrefixListId { get; }Property Value
Remarks
This is the AWS service that you want 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 .
DestinationSecurityGroupId
The ID of the destination VPC security group.
object? DestinationSecurityGroupId { get; }Property Value
Remarks
You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .
Type union: either string or ISecurityGroupRef
FromPort
If the protocol is TCP or UDP, this is the start of the port range.
double? FromPort { get; }Property Value
Remarks
If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
IpProtocol
The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
string? IpProtocol { get; }Property Value
Remarks
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.
ToPort
If the protocol is TCP or UDP, this is the end of the port range.
double? ToPort { get; }Property Value
Remarks
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).