Package software.amazon.awscdk.services.ec2

Class CfnSecurityGroupIngressProps.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnSecurityGroupIngressProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSecurityGroupIngressProps>

Enclosing interface:

CfnSecurityGroupIngressProps

@Stability(Stable)
public static final class CfnSecurityGroupIngressProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSecurityGroupIngressProps>

A builder for CfnSecurityGroupIngressProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

ipProtocol

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder ipProtocol(String ipProtocol)

Sets the value of CfnSecurityGroupIngressProps.getIpProtocol()

Parameters:

ipProtocol - The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ). This parameter is required. 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

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder cidrIp(String cidrIp)

Sets the value of CfnSecurityGroupIngressProps.getCidrIp()

Parameters:

cidrIp - The IPv4 address range, in CIDR format. You must specify exactly one of the following: CidrIp , CidrIpv6 , SourcePrefixListId , or SourceSecurityGroupId .

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

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder cidrIpv6(String cidrIpv6)

Sets the value of CfnSecurityGroupIngressProps.getCidrIpv6()

Parameters:

cidrIpv6 - The IPv6 address range, in CIDR format. You must specify exactly one of the following: CidrIp , CidrIpv6 , SourcePrefixListId , or SourceSecurityGroupId .

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

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder description(String description)

Sets the value of CfnSecurityGroupIngressProps.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

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder fromPort(Number fromPort)

Sets the value of CfnSecurityGroupIngressProps.getFromPort()

Parameters:

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.

Returns:

this

groupId

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder groupId(String groupId)

Sets the value of CfnSecurityGroupIngressProps.getGroupId()

Parameters:

groupId - The ID of the security group.

Returns:

this

groupName

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder groupName(String groupName)

Sets the value of CfnSecurityGroupIngressProps.getGroupName()

Parameters:

groupName - [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.

Returns:

this

sourcePrefixListId

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder sourcePrefixListId(String sourcePrefixListId)

Sets the value of CfnSecurityGroupIngressProps.getSourcePrefixListId()

Parameters:

sourcePrefixListId - The ID of a prefix list.

Returns:

this

sourceSecurityGroupId

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder sourceSecurityGroupId(String sourceSecurityGroupId)

Sets the value of CfnSecurityGroupIngressProps.getSourceSecurityGroupId()

Parameters:

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.

Returns:

this

sourceSecurityGroupName

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder sourceSecurityGroupName(String sourceSecurityGroupName)

Sets the value of CfnSecurityGroupIngressProps.getSourceSecurityGroupName()

Parameters:

sourceSecurityGroupName - [Default VPC] The name of the source security group. You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.

For security groups in a nondefault VPC, you must specify the group ID.

Returns:

this

sourceSecurityGroupOwnerId

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder sourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

Sets the value of CfnSecurityGroupIngressProps.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 SourceSecurityGroupOwnerId ; otherwise, this property is optional.

Returns:

this

toPort

@Stability(Stable)
public CfnSecurityGroupIngressProps.Builder toPort(Number toPort)

Sets the value of CfnSecurityGroupIngressProps.getToPort()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnSecurityGroupIngressProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnSecurityGroupIngressProps>

Returns:

a new instance of CfnSecurityGroupIngressProps

Throws:

NullPointerException - if any required attribute was not provided