public static final class CfnSecurityGroupIngressProps.Builder
extends java.lang.Object
CfnSecurityGroupIngressProps
Constructor and Description |
---|
Builder() |
public CfnSecurityGroupIngressProps.Builder ipProtocol(java.lang.String ipProtocol)
CfnSecurityGroupIngressProps.getIpProtocol()
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.
[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.this
public CfnSecurityGroupIngressProps.Builder cidrIp(java.lang.String cidrIp)
CfnSecurityGroupIngressProps.getCidrIp()
cidrIp
- 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 .
this
public CfnSecurityGroupIngressProps.Builder cidrIpv6(java.lang.String cidrIpv6)
CfnSecurityGroupIngressProps.getCidrIpv6()
cidrIpv6
- 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 .
this
public CfnSecurityGroupIngressProps.Builder description(java.lang.String description)
CfnSecurityGroupIngressProps.getDescription()
description
- 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 ._-:/()#,@[]+=;{}!$*
this
public CfnSecurityGroupIngressProps.Builder fromPort(java.lang.Number fromPort)
CfnSecurityGroupIngressProps.getFromPort()
fromPort
- 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.
this
public CfnSecurityGroupIngressProps.Builder groupId(java.lang.String groupId)
CfnSecurityGroupIngressProps.getGroupId()
groupId
- 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.
this
public CfnSecurityGroupIngressProps.Builder groupName(java.lang.String groupName)
CfnSecurityGroupIngressProps.getGroupName()
groupName
- 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 ._-:/()#,@[]+=&;{}!$*
this
public CfnSecurityGroupIngressProps.Builder sourcePrefixListId(java.lang.String sourcePrefixListId)
CfnSecurityGroupIngressProps.getSourcePrefixListId()
sourcePrefixListId
- [EC2-VPC only] The ID of a prefix list.this
public CfnSecurityGroupIngressProps.Builder sourceSecurityGroupId(java.lang.String sourceSecurityGroupId)
CfnSecurityGroupIngressProps.getSourceSecurityGroupId()
sourceSecurityGroupId
- 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.this
public CfnSecurityGroupIngressProps.Builder sourceSecurityGroupName(java.lang.String sourceSecurityGroupName)
CfnSecurityGroupIngressProps.getSourceSecurityGroupName()
sourceSecurityGroupName
- [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.
this
public CfnSecurityGroupIngressProps.Builder sourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)
CfnSecurityGroupIngressProps.getSourceSecurityGroupOwnerId()
sourceSecurityGroupOwnerId
- [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.
this
public CfnSecurityGroupIngressProps.Builder toPort(java.lang.Number toPort)
CfnSecurityGroupIngressProps.getToPort()
toPort
- 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.
this
public CfnSecurityGroupIngressProps build()
CfnSecurityGroupIngressProps
java.lang.NullPointerException
- if any required attribute was not provided