Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnSecurityGroupIngressMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnSecurityGroupIngressMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSecurityGroupIngressMixinProps>

Enclosing interface:

CfnSecurityGroupIngressMixinProps

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

A builder for CfnSecurityGroupIngressMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnSecurityGroupIngressMixinProps	build()	Builds the configured instance.
CfnSecurityGroupIngressMixinProps.Builder	cidrIp(String cidrIp)	Sets the value of CfnSecurityGroupIngressMixinProps.getCidrIp()
CfnSecurityGroupIngressMixinProps.Builder	cidrIpv6(String cidrIpv6)	Sets the value of CfnSecurityGroupIngressMixinProps.getCidrIpv6()
CfnSecurityGroupIngressMixinProps.Builder	description(String description)	Sets the value of CfnSecurityGroupIngressMixinProps.getDescription()
CfnSecurityGroupIngressMixinProps.Builder	fromPort(Number fromPort)	Sets the value of CfnSecurityGroupIngressMixinProps.getFromPort()
CfnSecurityGroupIngressMixinProps.Builder	groupId(String groupId)	Sets the value of CfnSecurityGroupIngressMixinProps.getGroupId()
CfnSecurityGroupIngressMixinProps.Builder	groupId(ISecurityGroupRef groupId)	Sets the value of CfnSecurityGroupIngressMixinProps.getGroupId()
CfnSecurityGroupIngressMixinProps.Builder	groupName(String groupName)	Sets the value of CfnSecurityGroupIngressMixinProps.getGroupName()
CfnSecurityGroupIngressMixinProps.Builder	groupName(ISecurityGroupRef groupName)	Sets the value of CfnSecurityGroupIngressMixinProps.getGroupName()
CfnSecurityGroupIngressMixinProps.Builder	ipProtocol(String ipProtocol)	Sets the value of CfnSecurityGroupIngressMixinProps.getIpProtocol()
CfnSecurityGroupIngressMixinProps.Builder	sourcePrefixListId(String sourcePrefixListId)	Sets the value of CfnSecurityGroupIngressMixinProps.getSourcePrefixListId()
CfnSecurityGroupIngressMixinProps.Builder	sourcePrefixListId(IPrefixListRef sourcePrefixListId)	Sets the value of CfnSecurityGroupIngressMixinProps.getSourcePrefixListId()
CfnSecurityGroupIngressMixinProps.Builder	sourceSecurityGroupId(String sourceSecurityGroupId)	Sets the value of CfnSecurityGroupIngressMixinProps.getSourceSecurityGroupId()
CfnSecurityGroupIngressMixinProps.Builder	sourceSecurityGroupId(ISecurityGroupRef sourceSecurityGroupId)	Sets the value of CfnSecurityGroupIngressMixinProps.getSourceSecurityGroupId()
CfnSecurityGroupIngressMixinProps.Builder	sourceSecurityGroupName(String sourceSecurityGroupName)	Sets the value of CfnSecurityGroupIngressMixinProps.getSourceSecurityGroupName()
CfnSecurityGroupIngressMixinProps.Builder	sourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)	Sets the value of CfnSecurityGroupIngressMixinProps.getSourceSecurityGroupOwnerId()
CfnSecurityGroupIngressMixinProps.Builder	toPort(Number toPort)	Sets the value of CfnSecurityGroupIngressMixinProps.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

cidrIp

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

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps.Builder cidrIpv6(String cidrIpv6)

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps.Builder description(String description)

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps.Builder fromPort(Number fromPort)

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps.Builder groupId(String groupId)

Sets the value of CfnSecurityGroupIngressMixinProps.getGroupId()

Parameters:

groupId - The ID of the security group.

Returns:

this

groupId

@Stability(Stable)
public CfnSecurityGroupIngressMixinProps.Builder groupId(ISecurityGroupRef groupId)

Sets the value of CfnSecurityGroupIngressMixinProps.getGroupId()

Parameters:

groupId - The ID of the security group.

Returns:

this

groupName

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

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

groupName

@Stability(Stable)
public CfnSecurityGroupIngressMixinProps.Builder groupName(ISecurityGroupRef groupName)

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

ipProtocol

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

Sets the value of CfnSecurityGroupIngressMixinProps.getIpProtocol()

Parameters:

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

sourcePrefixListId

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

Sets the value of CfnSecurityGroupIngressMixinProps.getSourcePrefixListId()

Parameters:

sourcePrefixListId - The ID of a prefix list.

Returns:

this

sourcePrefixListId

@Stability(Stable)
public CfnSecurityGroupIngressMixinProps.Builder sourcePrefixListId(IPrefixListRef sourcePrefixListId)

Sets the value of CfnSecurityGroupIngressMixinProps.getSourcePrefixListId()

Parameters:

sourcePrefixListId - The ID of a prefix list.

Returns:

this

sourceSecurityGroupId

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

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

sourceSecurityGroupId

@Stability(Stable)
public CfnSecurityGroupIngressMixinProps.Builder sourceSecurityGroupId(ISecurityGroupRef sourceSecurityGroupId)

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps.Builder sourceSecurityGroupName(String sourceSecurityGroupName)

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps.Builder sourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps.Builder toPort(Number toPort)

Sets the value of CfnSecurityGroupIngressMixinProps.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 CfnSecurityGroupIngressMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnSecurityGroupIngressMixinProps

Throws:

NullPointerException - if any required attribute was not provided