Show / Hide Table of Contents

Class CfnSecurityGroupEgressProps

Properties for defining a CfnSecurityGroupEgress.

Inheritance
object
CfnSecurityGroupEgressProps
Implements
ICfnSecurityGroupEgressProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSecurityGroupEgressProps : ICfnSecurityGroupEgressProps
Syntax (vb)
Public Class CfnSecurityGroupEgressProps Implements ICfnSecurityGroupEgressProps
Remarks

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

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.AWS.EC2;

             var cfnSecurityGroupEgressProps = new CfnSecurityGroupEgressProps {
                 GroupId = "groupId",
                 IpProtocol = "ipProtocol",

                 // the properties below are optional
                 CidrIp = "cidrIp",
                 CidrIpv6 = "cidrIpv6",
                 Description = "description",
                 DestinationPrefixListId = "destinationPrefixListId",
                 DestinationSecurityGroupId = "destinationSecurityGroupId",
                 FromPort = 123,
                 ToPort = 123
             };

Synopsis

Constructors

CfnSecurityGroupEgressProps()

Properties for defining a CfnSecurityGroupEgress.

Properties

CidrIp

The IPv4 address range, in CIDR format.

CidrIpv6

The IPv6 address range, in CIDR format.

Description

The description of an egress (outbound) security group rule.

DestinationPrefixListId

The prefix list IDs for an AWS service.

DestinationSecurityGroupId

The ID of the security group.

FromPort

If the protocol is TCP or UDP, this is the start of the port range.

GroupId

The ID of the security group.

IpProtocol

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).

ToPort

If the protocol is TCP or UDP, this is the end of the port range.

Constructors

CfnSecurityGroupEgressProps()

Properties for defining a CfnSecurityGroupEgress.

public CfnSecurityGroupEgressProps()
Remarks

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

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.AWS.EC2;

             var cfnSecurityGroupEgressProps = new CfnSecurityGroupEgressProps {
                 GroupId = "groupId",
                 IpProtocol = "ipProtocol",

                 // the properties below are optional
                 CidrIp = "cidrIp",
                 CidrIpv6 = "cidrIpv6",
                 Description = "description",
                 DestinationPrefixListId = "destinationPrefixListId",
                 DestinationSecurityGroupId = "destinationSecurityGroupId",
                 FromPort = 123,
                 ToPort = 123
             };

Properties

CidrIp

The IPv4 address range, in CIDR format.

public string? CidrIp { get; set; }
Property Value

string

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 .

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

CidrIpv6

The IPv6 address range, in CIDR format.

public string? CidrIpv6 { get; set; }
Property Value

string

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 .

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

Description

The description of an egress (outbound) security group rule.

public string? Description { get; set; }
Property Value

string

Remarks

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

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

DestinationPrefixListId

The prefix list IDs for an AWS service.

public string? DestinationPrefixListId { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationprefixlistid

DestinationSecurityGroupId

The ID of the security group.

public object? DestinationSecurityGroupId { get; set; }
Property Value

object

Remarks

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

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

Type union: either string or ISecurityGroupRef

FromPort

If the protocol is TCP or UDP, this is the start of the port range.

public double? FromPort { get; set; }
Property Value

double?

Remarks

If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

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

GroupId

The ID of the security group.

public object GroupId { get; set; }
Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-groupid

Type union: either string or ISecurityGroupRef

IpProtocol

The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).

public string IpProtocol { get; set; }
Property Value

string

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.

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

ToPort

If the protocol is TCP or UDP, this is the end of the port range.

public double? ToPort { get; set; }
Property Value

double?

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

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

Implements

ICfnSecurityGroupEgressProps
Back to top Generated by DocFX