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

Class CfnSecurityGroupEgressPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSecurityGroupEgressPropsMixin>

Enclosing class:

CfnSecurityGroupEgressPropsMixin

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

A fluent builder for CfnSecurityGroupEgressPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnSecurityGroupEgressPropsMixin	build()
CfnSecurityGroupEgressPropsMixin.Builder	cidrIp(String cidrIp)	The IPv4 address range, in CIDR format.
CfnSecurityGroupEgressPropsMixin.Builder	cidrIpv6(String cidrIpv6)	The IPv6 address range, in CIDR format.
static CfnSecurityGroupEgressPropsMixin.Builder	create()
static CfnSecurityGroupEgressPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnSecurityGroupEgressPropsMixin.Builder	description(String description)	The description of an egress (outbound) security group rule.
CfnSecurityGroupEgressPropsMixin.Builder	destinationPrefixListId(String destinationPrefixListId)	The prefix list IDs for an AWS service.
CfnSecurityGroupEgressPropsMixin.Builder	destinationSecurityGroupId(String destinationSecurityGroupId)	The ID of the security group.
CfnSecurityGroupEgressPropsMixin.Builder	destinationSecurityGroupId(ISecurityGroupRef destinationSecurityGroupId)	The ID of the security group.
CfnSecurityGroupEgressPropsMixin.Builder	fromPort(Number fromPort)	If the protocol is TCP or UDP, this is the start of the port range.
CfnSecurityGroupEgressPropsMixin.Builder	groupId(String groupId)	The ID of the security group.
CfnSecurityGroupEgressPropsMixin.Builder	groupId(ISecurityGroupRef groupId)	The ID of the security group.
CfnSecurityGroupEgressPropsMixin.Builder	ipProtocol(String ipProtocol)	The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ).
CfnSecurityGroupEgressPropsMixin.Builder	toPort(Number toPort)	If the protocol is TCP or UDP, this is the end of the port range.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnSecurityGroupEgressPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnSecurityGroupEgressPropsMixin.Builder.

create

@Stability(Stable)
public static CfnSecurityGroupEgressPropsMixin.Builder create()

Returns:

a new instance of CfnSecurityGroupEgressPropsMixin.Builder.

cidrIp

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

The IPv4 address range, in CIDR format.

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

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 .

Parameters:

cidrIp - The IPv4 address range, in CIDR format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-cidrip

cidrIpv6

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

The IPv6 address range, in CIDR format.

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

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 .

Parameters:

cidrIpv6 - The IPv6 address range, in CIDR format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-cidripv6

description

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

The description of an egress (outbound) security group rule.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

Parameters:

description - The description of an egress (outbound) security group rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-description

destinationPrefixListId

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder destinationPrefixListId(String destinationPrefixListId)

The prefix list IDs for an AWS service.

This is the AWS service to access through a VPC endpoint from instances associated with the security group.

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

Parameters:

destinationPrefixListId - The prefix list IDs for an AWS service. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationprefixlistid

destinationSecurityGroupId

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder destinationSecurityGroupId(String destinationSecurityGroupId)

The ID of the security group.

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

Parameters:

destinationSecurityGroupId - The ID of the security group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid

destinationSecurityGroupId

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder destinationSecurityGroupId(ISecurityGroupRef destinationSecurityGroupId)

The ID of the security group.

You must specify exactly one of the following: CidrIp , CidrIpv6 , DestinationPrefixListId , or DestinationSecurityGroupId .

Parameters:

destinationSecurityGroupId - The ID of the security group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-destinationsecuritygroupid

fromPort

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder fromPort(Number 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 ICMP type or -1 (all ICMP types).

Parameters:

fromPort - If the protocol is TCP or UDP, this is the start of the port range. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-fromport

groupId

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder groupId(String 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.

Parameters:

groupId - The ID of the security group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-groupid

groupId

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder groupId(ISecurityGroupRef 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.

Parameters:

groupId - The ID of the security group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-groupid

ipProtocol

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder ipProtocol(String 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.

Parameters:

ipProtocol - The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see Protocol Numbers ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-ipprotocol

toPort

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin.Builder toPort(Number 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 ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

Parameters:

toPort - If the protocol is TCP or UDP, this is the end of the port range. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html#cfn-ec2-securitygroupegress-toport

build

@Stability(Stable)
public CfnSecurityGroupEgressPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnSecurityGroupEgressPropsMixin.