software.amazon.awscdk.services.ec2

Interface CfnSecurityGroupIngressProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityGroupIngressProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.298Z")
 @Stability(value=Stable)
public interface CfnSecurityGroupIngressProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnSecurityGroupIngressProps.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() Updates the description of an ingress (inbound) security group rule.
default Number	getFromPort() The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
default String	getGroupId() The ID of the security group.
default String	getGroupName() The name of the security group.
String	getIpProtocol() The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).
default String	getSourcePrefixListId() [EC2-VPC only] The ID of a prefix list.
default String	getSourceSecurityGroupId() The ID of the security group.
default String	getSourceSecurityGroupName() [EC2-Classic, default VPC] The name of the source security group.
default String	getSourceSecurityGroupOwnerId() [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
default Number	getToPort() The 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 Detail

getIpProtocol

@Stability(value=Stable)
 @NotNull
String getIpProtocol()

The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).

[VPC only] 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.

getCidrIp

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

The IPv4 address range, in CIDR format.

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 .

getCidrIpv6

@Stability(value=Stable)
 @Nullable
default String getCidrIpv6()

The IPv6 address range, in CIDR format.

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 .

getDescription

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

getFromPort

@Stability(value=Stable)
 @Nullable
default Number getFromPort()

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

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.

getGroupId

@Stability(value=Stable)
 @Nullable
default 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.

You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

getGroupName

@Stability(value=Stable)
 @Nullable
default String getGroupName()

The name of the security group.

Constraints: Up to 255 characters in length. Cannot start with sg- .

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

getSourcePrefixListId

@Stability(value=Stable)
 @Nullable
default String getSourcePrefixListId()

[EC2-VPC only] The ID of a prefix list.

getSourceSecurityGroupId

@Stability(value=Stable)
 @Nullable
default String 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.

getSourceSecurityGroupName

@Stability(value=Stable)
 @Nullable
default String getSourceSecurityGroupName()

[EC2-Classic, default VPC] The name of the source security group.

You can't specify this parameter in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.

You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

getSourceSecurityGroupOwnerId

@Stability(value=Stable)
 @Nullable
default String 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 SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId ; otherwise, this property is optional.

getToPort

@Stability(value=Stable)
 @Nullable
default Number getToPort()

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

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.

builder

@Stability(value=Stable)
static CfnSecurityGroupIngressProps.Builder builder()

Returns:

a CfnSecurityGroupIngressProps.Builder of CfnSecurityGroupIngressProps