Interface ICfnSecurityGroupIngressProps
Properties for defining a CfnSecurityGroupIngress
.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public interface ICfnSecurityGroupIngressProps
Syntax (vb)
Public Interface ICfnSecurityGroupIngressProps
Remarks
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 cfnSecurityGroupIngressProps = new CfnSecurityGroupIngressProps {
IpProtocol = "ipProtocol",
// the properties below are optional
CidrIp = "cidrIp",
CidrIpv6 = "cidrIpv6",
Description = "description",
FromPort = 123,
GroupId = "groupId",
GroupName = "groupName",
SourcePrefixListId = "sourcePrefixListId",
SourceSecurityGroupId = "sourceSecurityGroupId",
SourceSecurityGroupName = "sourceSecurityGroupName",
SourceSecurityGroupOwnerId = "sourceSecurityGroupOwnerId",
ToPort = 123
};
Synopsis
Properties
CidrIp | The IPv4 address range, in CIDR format. |
CidrIpv6 | The IPv6 address range, in CIDR format. |
Description | Updates the description of an ingress (inbound) security group rule. |
FromPort | The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. |
GroupId | The ID of the security group. |
GroupName | The name of the security group. |
IpProtocol | The IP protocol name ( |
SourcePrefixListId | The ID of a prefix list. |
SourceSecurityGroupId | The ID of the security group. |
SourceSecurityGroupName | [Default VPC] The name of the source security group. |
SourceSecurityGroupOwnerId | [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. |
ToPort | The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. |
Properties
CidrIp
The IPv4 address range, in CIDR format.
virtual string CidrIp { get; }
Property Value
System.String
Remarks
You must specify a source security group ( SourcePrefixListId
or SourceSecurityGroupId
) 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 .
CidrIpv6
The IPv6 address range, in CIDR format.
virtual string CidrIpv6 { get; }
Property Value
System.String
Remarks
You must specify a source security group ( SourcePrefixListId
or SourceSecurityGroupId
) 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 .
Description
Updates the description of an ingress (inbound) security group rule.
virtual string Description { get; }
Property Value
System.String
Remarks
You can replace an existing description, or add a description to a rule that did not have one previously.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
FromPort
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
virtual Nullable<double> FromPort { get; }
Property Value
System.Nullable<System.Double>
Remarks
A value of -1
indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.
GroupId
The ID of the security group.
virtual string GroupId { get; }
Property Value
System.String
Remarks
GroupName
The name of the security group.
virtual string GroupName { get; }
Property Value
System.String
Remarks
Constraints: Up to 255 characters in length. Cannot start with sg-
.
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
IpProtocol
The IP protocol name ( tcp
, udp
, icmp
, icmpv6
) or number (see Protocol Numbers ).
string IpProtocol { get; }
Property Value
System.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.
SourcePrefixListId
The ID of a prefix list.
virtual string SourcePrefixListId { get; }
Property Value
System.String
Remarks
SourceSecurityGroupId
The ID of the security group.
virtual string SourceSecurityGroupId { get; }
Property Value
System.String
Remarks
You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
SourceSecurityGroupName
[Default VPC] The name of the source security group.
virtual string SourceSecurityGroupName { get; }
Property Value
System.String
Remarks
You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
For security groups in a nondefault VPC, you must specify the group ID.
SourceSecurityGroupOwnerId
[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
virtual string SourceSecurityGroupOwnerId { get; }
Property Value
System.String
Remarks
You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
If you specify SourceSecurityGroupName
or SourceSecurityGroupId
and that security group is owned by a different account than the account creating the stack, you must specify SourceSecurityGroupOwnerId
; otherwise, this property is optional.
ToPort
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
virtual Nullable<double> ToPort { get; }
Property Value
System.Nullable<System.Double>
Remarks
A value of -1
indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Use this for ICMP and any protocol that uses ports.