software.amazon.awscdk.services.ec2

Class CfnSecurityGroup.IngressProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnSecurityGroup.IngressProperty.Builder

Enclosing interface:

CfnSecurityGroup.IngressProperty

public static final class CfnSecurityGroup.IngressProperty.Builder
extends java.lang.Object

A builder for CfnSecurityGroup.IngressProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnSecurityGroup.IngressProperty	build() Builds the configured instance.
CfnSecurityGroup.IngressProperty.Builder	cidrIp(java.lang.String cidrIp) Sets the value of CfnSecurityGroup.IngressProperty.getCidrIp()
CfnSecurityGroup.IngressProperty.Builder	cidrIpv6(java.lang.String cidrIpv6) Sets the value of CfnSecurityGroup.IngressProperty.getCidrIpv6()
CfnSecurityGroup.IngressProperty.Builder	description(java.lang.String description) Sets the value of CfnSecurityGroup.IngressProperty.getDescription()
CfnSecurityGroup.IngressProperty.Builder	fromPort(java.lang.Number fromPort) Sets the value of CfnSecurityGroup.IngressProperty.getFromPort()
CfnSecurityGroup.IngressProperty.Builder	ipProtocol(java.lang.String ipProtocol) Sets the value of CfnSecurityGroup.IngressProperty.getIpProtocol()
CfnSecurityGroup.IngressProperty.Builder	sourcePrefixListId(java.lang.String sourcePrefixListId) Sets the value of CfnSecurityGroup.IngressProperty.getSourcePrefixListId()
CfnSecurityGroup.IngressProperty.Builder	sourceSecurityGroupId(java.lang.String sourceSecurityGroupId) Sets the value of CfnSecurityGroup.IngressProperty.getSourceSecurityGroupId()
CfnSecurityGroup.IngressProperty.Builder	sourceSecurityGroupName(java.lang.String sourceSecurityGroupName) Sets the value of CfnSecurityGroup.IngressProperty.getSourceSecurityGroupName()
CfnSecurityGroup.IngressProperty.Builder	sourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId) Sets the value of CfnSecurityGroup.IngressProperty.getSourceSecurityGroupOwnerId()
CfnSecurityGroup.IngressProperty.Builder	toPort(java.lang.Number toPort) Sets the value of CfnSecurityGroup.IngressProperty.getToPort()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

ipProtocol

public CfnSecurityGroup.IngressProperty.Builder ipProtocol(java.lang.String ipProtocol)

Sets the value of CfnSecurityGroup.IngressProperty.getIpProtocol()

Parameters:

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.

Returns:

this

cidrIp

public CfnSecurityGroup.IngressProperty.Builder cidrIp(java.lang.String cidrIp)

Sets the value of CfnSecurityGroup.IngressProperty.getCidrIp()

Parameters:

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 .

Returns:

this

cidrIpv6

public CfnSecurityGroup.IngressProperty.Builder cidrIpv6(java.lang.String cidrIpv6)

Sets the value of CfnSecurityGroup.IngressProperty.getCidrIpv6()

Parameters:

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 .

Returns:

this

description

public CfnSecurityGroup.IngressProperty.Builder description(java.lang.String description)

Sets the value of CfnSecurityGroup.IngressProperty.getDescription()

Parameters:

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

Returns:

this

fromPort

public CfnSecurityGroup.IngressProperty.Builder fromPort(java.lang.Number fromPort)

Sets the value of CfnSecurityGroup.IngressProperty.getFromPort()

Parameters:

fromPort - If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

Returns:

this

sourcePrefixListId

public CfnSecurityGroup.IngressProperty.Builder sourcePrefixListId(java.lang.String sourcePrefixListId)

Sets the value of CfnSecurityGroup.IngressProperty.getSourcePrefixListId()

Parameters:

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

Returns:

this

sourceSecurityGroupId

public CfnSecurityGroup.IngressProperty.Builder sourceSecurityGroupId(java.lang.String sourceSecurityGroupId)

Sets the value of CfnSecurityGroup.IngressProperty.getSourceSecurityGroupId()

Parameters:

sourceSecurityGroupId - 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.

Returns:

this

sourceSecurityGroupName

public CfnSecurityGroup.IngressProperty.Builder sourceSecurityGroupName(java.lang.String sourceSecurityGroupName)

Sets the value of CfnSecurityGroup.IngressProperty.getSourceSecurityGroupName()

Parameters:

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.

Returns:

this

sourceSecurityGroupOwnerId

public CfnSecurityGroup.IngressProperty.Builder sourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)

Sets the value of CfnSecurityGroup.IngressProperty.getSourceSecurityGroupOwnerId()

Parameters:

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.

Returns:

this

toPort

public CfnSecurityGroup.IngressProperty.Builder toPort(java.lang.Number toPort)

Sets the value of CfnSecurityGroup.IngressProperty.getToPort()

Parameters:

toPort - If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

Returns:

this

build

public CfnSecurityGroup.IngressProperty build()

Builds the configured instance.

Returns:

a new instance of CfnSecurityGroup.IngressProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided