Interface CfnSecurityGroupIngressProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnSecurityGroupIngressProps.Jsii$Proxy
CfnSecurityGroupIngress.
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.*;
CfnSecurityGroupIngressProps cfnSecurityGroupIngressProps = CfnSecurityGroupIngressProps.builder()
.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)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnSecurityGroupIngressPropsstatic final classAn implementation forCfnSecurityGroupIngressProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe IPv4 address range, in CIDR format.default StringThe IPv6 address range, in CIDR format.default StringUpdates the description of an ingress (inbound) security group rule.default NumberThe start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.default StringThe ID of the security group.default StringThe name of the security group.default StringThe ID of a prefix list.default StringThe ID of the security group.default String[Default VPC] The name of the source security group.default String[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.default NumberThe end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIpProtocol
The IP protocol name (tcp,udp,icmp,icmpv6) or number (see Protocol Numbers ).Use
-1to specify all protocols. When authorizing security group rules, specifying-1or a protocol number other thantcp,udp,icmp, oricmpv6allows traffic on all ports, regardless of any port range you specify. Fortcp,udp, andicmp, you must specify a port range. Foricmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.- See Also:
-
getCidrIp
The IPv4 address range, in CIDR format.You must specify exactly one of the following:
CidrIp,CidrIpv6,SourcePrefixListId, orSourceSecurityGroupId.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:
-
getCidrIpv6
The IPv6 address range, in CIDR format.You must specify exactly one of the following:
CidrIp,CidrIpv6,SourcePrefixListId, orSourceSecurityGroupId.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:
-
getDescription
Updates the description of an ingress (inbound) security group rule.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 ._-:/()#,@[]+=;{}!$*
- See Also:
-
getFromPort
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.A value of
-1indicates 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.
- See Also:
-
getGroupId
The ID of the security group.- See Also:
-
getGroupName
The name of the security group.Constraints: Up to 255 characters in length. Cannot start with
sg-.Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
- See Also:
-
getSourcePrefixListId
The ID of a prefix list.- See Also:
-
getSourceSecurityGroupId
The ID of the security group.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.
- See Also:
-
getSourceSecurityGroupName
[Default VPC] The name of the source security group.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.
- See Also:
-
getSourceSecurityGroupOwnerId
[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.
If you specify
SourceSecurityGroupNameorSourceSecurityGroupIdand that security group is owned by a different account than the account creating the stack, you must specifySourceSecurityGroupOwnerId; otherwise, this property is optional.- See Also:
-
getToPort
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.A value of
-1indicates 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.
- See Also:
-
builder
-