CfnSecurityGroupIngress

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.ec2.CfnSecurityGroupIngress

All Implemented Interfaces:

IConstruct, IDependable, IInspectable
```
@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:20.322Z")
public class CfnSecurityGroupIngress
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::EC2::SecurityGroupIngress`.
Adds an inbound rule to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances associated with the specified security group.
You must specify only one of the following properties: CidrIp , CidrIpv6 , SourcePrefixListId , SourceSecurityGroupId , or SourceSecurityGroupName .
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify a port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
You must specify a source security group ( SourcePrefixListId , SourceSecurityGroupId , or SourceSecurityGroupName ) or a CIDR range ( CidrIp or CidrIpv6 ). If you do not specify one of these parameters, the stack will launch successfully but the rule will not be added to the security group.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
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.*;
 CfnSecurityGroupIngress cfnSecurityGroupIngress = CfnSecurityGroupIngress.Builder.create(this, "MyCfnSecurityGroupIngress")
         .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 Class and Description

static class CfnSecurityGroupIngress.Builder
A fluent builder for CfnSecurityGroupIngress.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnSecurityGroupIngress.Builder` A fluent builder for `CfnSecurityGroupIngress`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnSecurityGroupIngress(Construct scope, java.lang.String id, CfnSecurityGroupIngressProps props)` Create a new `AWS::EC2::SecurityGroupIngress`.
`protected`	`CfnSecurityGroupIngress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnSecurityGroupIngress(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getCidrIp()` The IPv4 address range, in CIDR format.
`java.lang.String`	`getCidrIpv6()` The IPv6 address range, in CIDR format.
`java.lang.String`	`getDescription()` Updates the description of an ingress (inbound) security group rule.
`java.lang.Number`	`getFromPort()` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`java.lang.String`	`getGroupId()` The ID of the security group.
`java.lang.String`	`getGroupName()` The name of the security group.
`java.lang.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) ).
`java.lang.String`	`getSourcePrefixListId()` [EC2-VPC only] The ID of a prefix list.
`java.lang.String`	`getSourceSecurityGroupId()` The ID of the security group.
`java.lang.String`	`getSourceSecurityGroupName()` [EC2-Classic, default VPC] The name of the source security group.
`java.lang.String`	`getSourceSecurityGroupOwnerId()` [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
`java.lang.Number`	`getToPort()` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setCidrIp(java.lang.String value)` The IPv4 address range, in CIDR format.
`void`	`setCidrIpv6(java.lang.String value)` The IPv6 address range, in CIDR format.
`void`	`setDescription(java.lang.String value)` Updates the description of an ingress (inbound) security group rule.
`void`	`setFromPort(java.lang.Number value)` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`void`	`setGroupId(java.lang.String value)` The ID of the security group.
`void`	`setGroupName(java.lang.String value)` The name of the security group.
`void`	`setIpProtocol(java.lang.String value)` 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) ).
`void`	`setSourcePrefixListId(java.lang.String value)` [EC2-VPC only] The ID of a prefix list.
`void`	`setSourceSecurityGroupId(java.lang.String value)` The ID of the security group.
`void`	`setSourceSecurityGroupName(java.lang.String value)` [EC2-Classic, default VPC] The name of the source security group.
`void`	`setSourceSecurityGroupOwnerId(java.lang.String value)` [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
`void`	`setToPort(java.lang.Number value)` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnSecurityGroupIngress
```
protected CfnSecurityGroupIngress(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnSecurityGroupIngress
```
protected CfnSecurityGroupIngress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnSecurityGroupIngress
```
public CfnSecurityGroupIngress(Construct scope,
                               java.lang.String id,
                               CfnSecurityGroupIngressProps props)
```
    Create a new `AWS::EC2::SecurityGroupIngress`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getIpProtocol
```
public java.lang.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.
  - setIpProtocol
```
public void setIpProtocol(java.lang.String value)
```
    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
```
public java.lang.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 .
  - setCidrIp
```
public void setCidrIp(java.lang.String value)
```
    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
```
public java.lang.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 .
  - setCidrIpv6
```
public void setCidrIpv6(java.lang.String value)
```
    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
```
public java.lang.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 ._-:/()#,@[]+=;{}!$*
  - setDescription
```
public void setDescription(java.lang.String value)
```
    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
```
public java.lang.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.
  - setFromPort
```
public void setFromPort(java.lang.Number value)
```
    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
```
public java.lang.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.
  - setGroupId
```
public void setGroupId(java.lang.String value)
```
    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
```
public java.lang.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 ._-:/()#,@[]+=&;{}!$*
  - setGroupName
```
public void setGroupName(java.lang.String value)
```
    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
```
public java.lang.String getSourcePrefixListId()
```
    [EC2-VPC only] The ID of a prefix list.
  - setSourcePrefixListId
```
public void setSourcePrefixListId(java.lang.String value)
```
    [EC2-VPC only] The ID of a prefix list.
  - getSourceSecurityGroupId
```
public java.lang.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.
  - setSourceSecurityGroupId
```
public void setSourceSecurityGroupId(java.lang.String value)
```
    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
```
public java.lang.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.
  - setSourceSecurityGroupName
```
public void setSourceSecurityGroupName(java.lang.String value)
```
    [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
```
public java.lang.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.
  - setSourceSecurityGroupOwnerId
```
public void setSourceSecurityGroupOwnerId(java.lang.String value)
```
    [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
```
public java.lang.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.
  - setToPort
```
public void setToPort(java.lang.Number value)
```
    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.

Class CfnSecurityGroupIngress

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnSecurityGroupIngress

CfnSecurityGroupIngress

CfnSecurityGroupIngress

Method Detail

inspect

renderProperties

getCfnProperties

getIpProtocol

setIpProtocol

getCidrIp

setCidrIp

getCidrIpv6

setCidrIpv6

getDescription

setDescription

getFromPort

setFromPort

getGroupId

setGroupId

getGroupName

setGroupName

getSourcePrefixListId

setSourcePrefixListId

getSourceSecurityGroupId

setSourceSecurityGroupId

getSourceSecurityGroupName

setSourceSecurityGroupName

getSourceSecurityGroupOwnerId

setSourceSecurityGroupOwnerId

getToPort

setToPort