public static final class CfnSecurityGroupIngress.Builder
extends java.lang.Object
CfnSecurityGroupIngress
.Modifier and Type | Method and Description |
---|---|
CfnSecurityGroupIngress |
build() |
CfnSecurityGroupIngress.Builder |
cidrIp(java.lang.String cidrIp)
The IPv4 address range, in CIDR format.
|
CfnSecurityGroupIngress.Builder |
cidrIpv6(java.lang.String cidrIpv6)
The IPv6 address range, in CIDR format.
|
static CfnSecurityGroupIngress.Builder |
create(Construct scope,
java.lang.String id) |
CfnSecurityGroupIngress.Builder |
description(java.lang.String description)
Updates the description of an ingress (inbound) security group rule.
|
CfnSecurityGroupIngress.Builder |
fromPort(java.lang.Number fromPort)
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
|
CfnSecurityGroupIngress.Builder |
groupId(java.lang.String groupId)
The ID of the security group.
|
CfnSecurityGroupIngress.Builder |
groupName(java.lang.String groupName)
The name of the security group.
|
CfnSecurityGroupIngress.Builder |
ipProtocol(java.lang.String ipProtocol)
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) ).
|
CfnSecurityGroupIngress.Builder |
sourcePrefixListId(java.lang.String sourcePrefixListId)
[EC2-VPC only] The ID of a prefix list.
|
CfnSecurityGroupIngress.Builder |
sourceSecurityGroupId(java.lang.String sourceSecurityGroupId)
The ID of the security group.
|
CfnSecurityGroupIngress.Builder |
sourceSecurityGroupName(java.lang.String sourceSecurityGroupName)
[EC2-Classic, default VPC] The name of the source security group.
|
CfnSecurityGroupIngress.Builder |
sourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)
[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
|
CfnSecurityGroupIngress.Builder |
toPort(java.lang.Number toPort)
The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
|
public static CfnSecurityGroupIngress.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnSecurityGroupIngress.Builder
.public CfnSecurityGroupIngress.Builder ipProtocol(java.lang.String ipProtocol)
[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.
ipProtocol
- 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) ). This parameter is required.this
public CfnSecurityGroupIngress.Builder cidrIp(java.lang.String cidrIp)
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 .
cidrIp
- The IPv4 address range, in CIDR format. This parameter is required.this
public CfnSecurityGroupIngress.Builder cidrIpv6(java.lang.String cidrIpv6)
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. This parameter is required.this
public CfnSecurityGroupIngress.Builder description(java.lang.String description)
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 ._-:/()#,@[]+=;{}!$*
description
- Updates the description of an ingress (inbound) security group rule. This parameter is required.this
public CfnSecurityGroupIngress.Builder fromPort(java.lang.Number fromPort)
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.
fromPort
- The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. This parameter is required.this
public CfnSecurityGroupIngress.Builder groupId(java.lang.String groupId)
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.
groupId
- The ID of the security group. This parameter is required.this
public CfnSecurityGroupIngress.Builder groupName(java.lang.String groupName)
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 ._-:/()#,@[]+=&;{}!$*
groupName
- The name of the security group. This parameter is required.this
public CfnSecurityGroupIngress.Builder sourcePrefixListId(java.lang.String sourcePrefixListId)
sourcePrefixListId
- [EC2-VPC only] The ID of a prefix list. This parameter is required.this
public CfnSecurityGroupIngress.Builder sourceSecurityGroupId(java.lang.String sourceSecurityGroupId)
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.
sourceSecurityGroupId
- The ID of the security group. This parameter is required.this
public CfnSecurityGroupIngress.Builder sourceSecurityGroupName(java.lang.String sourceSecurityGroupName)
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.
sourceSecurityGroupName
- [EC2-Classic, default VPC] The name of the source security group. This parameter is required.this
public CfnSecurityGroupIngress.Builder sourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)
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.
sourceSecurityGroupOwnerId
- [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. This parameter is required.this
public CfnSecurityGroupIngress.Builder toPort(java.lang.Number toPort)
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.
toPort
- The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. This parameter is required.this
public CfnSecurityGroupIngress build()