Package software.amazon.awscdk.services.ec2

Class CfnNetworkInterface.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnNetworkInterface.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNetworkInterface>

Enclosing class:

CfnNetworkInterface

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

A fluent builder for CfnNetworkInterface.

Method Summary

Modifier and Type	Method	Description
CfnNetworkInterface	build()
static CfnNetworkInterface.Builder	create(software.constructs.Construct scope, String id)
CfnNetworkInterface.Builder	description(String description)	A description for the network interface.
CfnNetworkInterface.Builder	groupSet(List<String> groupSet)	The security group IDs associated with this network interface.
CfnNetworkInterface.Builder	interfaceType(String interfaceType)	The type of network interface.
CfnNetworkInterface.Builder	ipv4PrefixCount(Number ipv4PrefixCount)	The number of IPv4 prefixes to be automatically assigned to the network interface.
CfnNetworkInterface.Builder	ipv4Prefixes(List<? extends Object> ipv4Prefixes)	The IPv4 delegated prefixes that are assigned to the network interface.
CfnNetworkInterface.Builder	ipv4Prefixes(IResolvable ipv4Prefixes)	The IPv4 delegated prefixes that are assigned to the network interface.
CfnNetworkInterface.Builder	ipv6AddressCount(Number ipv6AddressCount)	The number of IPv6 addresses to assign to a network interface.
CfnNetworkInterface.Builder	ipv6Addresses(List<? extends Object> ipv6Addresses)	One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
CfnNetworkInterface.Builder	ipv6Addresses(IResolvable ipv6Addresses)	One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
CfnNetworkInterface.Builder	ipv6PrefixCount(Number ipv6PrefixCount)	The number of IPv6 prefixes to be automatically assigned to the network interface.
CfnNetworkInterface.Builder	ipv6Prefixes(List<? extends Object> ipv6Prefixes)	The IPv6 delegated prefixes that are assigned to the network interface.
CfnNetworkInterface.Builder	ipv6Prefixes(IResolvable ipv6Prefixes)	The IPv6 delegated prefixes that are assigned to the network interface.
CfnNetworkInterface.Builder	privateIpAddress(String privateIpAddress)	Assigns a single private IP address to the network interface, which is used as the primary private IP address.
CfnNetworkInterface.Builder	privateIpAddresses(List<? extends Object> privateIpAddresses)	Assigns private IP addresses to the network interface.
CfnNetworkInterface.Builder	privateIpAddresses(IResolvable privateIpAddresses)	Assigns private IP addresses to the network interface.
CfnNetworkInterface.Builder	secondaryPrivateIpAddressCount(Number secondaryPrivateIpAddressCount)	The number of secondary private IPv4 addresses to assign to a network interface.
CfnNetworkInterface.Builder	sourceDestCheck(Boolean sourceDestCheck)	Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
CfnNetworkInterface.Builder	sourceDestCheck(IResolvable sourceDestCheck)	Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
CfnNetworkInterface.Builder	subnetId(String subnetId)	The ID of the subnet to associate with the network interface.
CfnNetworkInterface.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key-value pairs) for this network interface.

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 CfnNetworkInterface.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnNetworkInterface.Builder.

subnetId

@Stability(Stable)
public CfnNetworkInterface.Builder subnetId(String subnetId)

The ID of the subnet to associate with the network interface.

Parameters:

subnetId - The ID of the subnet to associate with the network interface. This parameter is required.

Returns:

this

See Also:

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

description

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

A description for the network interface.

Parameters:

description - A description for the network interface. This parameter is required.

Returns:

this

See Also:

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

groupSet

@Stability(Stable)
public CfnNetworkInterface.Builder groupSet(List<String> groupSet)

The security group IDs associated with this network interface.

Parameters:

groupSet - The security group IDs associated with this network interface. This parameter is required.

Returns:

this

See Also:

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

interfaceType

@Stability(Stable)
public CfnNetworkInterface.Builder interfaceType(String interfaceType)

The type of network interface.

The default is interface . The supported values are efa and trunk .

Parameters:

interfaceType - The type of network interface. This parameter is required.

Returns:

this

See Also:

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

ipv4PrefixCount

@Stability(Stable)
public CfnNetworkInterface.Builder ipv4PrefixCount(Number ipv4PrefixCount)

The number of IPv4 prefixes to be automatically assigned to the network interface.

When creating a network interface, you can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

Parameters:

ipv4PrefixCount - The number of IPv4 prefixes to be automatically assigned to the network interface. This parameter is required.

Returns:

this

See Also:

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

ipv4Prefixes

@Stability(Stable)
public CfnNetworkInterface.Builder ipv4Prefixes(IResolvable ipv4Prefixes)

The IPv4 delegated prefixes that are assigned to the network interface.

When creating a network interface, you can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

Parameters:

ipv4Prefixes - The IPv4 delegated prefixes that are assigned to the network interface. This parameter is required.

Returns:

this

See Also:

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

ipv4Prefixes

@Stability(Stable)
public CfnNetworkInterface.Builder ipv4Prefixes(List<? extends Object> ipv4Prefixes)

The IPv4 delegated prefixes that are assigned to the network interface.

When creating a network interface, you can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

Parameters:

ipv4Prefixes - The IPv4 delegated prefixes that are assigned to the network interface. This parameter is required.

Returns:

this

See Also:

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

ipv6AddressCount

@Stability(Stable)
public CfnNetworkInterface.Builder ipv6AddressCount(Number ipv6AddressCount)

The number of IPv6 addresses to assign to a network interface.

Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.

When creating a network interface, you can't specify a count of IPv6 addresses if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

Parameters:

ipv6AddressCount - The number of IPv6 addresses to assign to a network interface. This parameter is required.

Returns:

this

See Also:

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

ipv6Addresses

@Stability(Stable)
public CfnNetworkInterface.Builder ipv6Addresses(IResolvable ipv6Addresses)

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.

If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.

When creating a network interface, you can't specify IPv6 addresses if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

Parameters:

ipv6Addresses - One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. This parameter is required.

Returns:

this

See Also:

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

ipv6Addresses

@Stability(Stable)
public CfnNetworkInterface.Builder ipv6Addresses(List<? extends Object> ipv6Addresses)

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.

If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.

When creating a network interface, you can't specify IPv6 addresses if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

Parameters:

ipv6Addresses - One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. This parameter is required.

Returns:

this

See Also:

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

ipv6PrefixCount

@Stability(Stable)
public CfnNetworkInterface.Builder ipv6PrefixCount(Number ipv6PrefixCount)

The number of IPv6 prefixes to be automatically assigned to the network interface.

When creating a network interface, you can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

Parameters:

ipv6PrefixCount - The number of IPv6 prefixes to be automatically assigned to the network interface. This parameter is required.

Returns:

this

See Also:

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

ipv6Prefixes

@Stability(Stable)
public CfnNetworkInterface.Builder ipv6Prefixes(IResolvable ipv6Prefixes)

The IPv6 delegated prefixes that are assigned to the network interface.

When creating a network interface, you can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

Parameters:

ipv6Prefixes - The IPv6 delegated prefixes that are assigned to the network interface. This parameter is required.

Returns:

this

See Also:

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

ipv6Prefixes

@Stability(Stable)
public CfnNetworkInterface.Builder ipv6Prefixes(List<? extends Object> ipv6Prefixes)

The IPv6 delegated prefixes that are assigned to the network interface.

When creating a network interface, you can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

Parameters:

ipv6Prefixes - The IPv6 delegated prefixes that are assigned to the network interface. This parameter is required.

Returns:

this

See Also:

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

privateIpAddress

@Stability(Stable)
public CfnNetworkInterface.Builder privateIpAddress(String privateIpAddress)

Assigns a single private IP address to the network interface, which is used as the primary private IP address.

If you want to specify multiple private IP address, use the PrivateIpAddresses property.

Parameters:

privateIpAddress - Assigns a single private IP address to the network interface, which is used as the primary private IP address. This parameter is required.

Returns:

this

See Also:

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

privateIpAddresses

@Stability(Stable)
public CfnNetworkInterface.Builder privateIpAddresses(IResolvable privateIpAddresses)

Assigns private IP addresses to the network interface.

You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.

When creating a network interface, you can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

Parameters:

privateIpAddresses - Assigns private IP addresses to the network interface. This parameter is required.

Returns:

this

See Also:

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

privateIpAddresses

@Stability(Stable)
public CfnNetworkInterface.Builder privateIpAddresses(List<? extends Object> privateIpAddresses)

Assigns private IP addresses to the network interface.

You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.

When creating a network interface, you can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

Parameters:

privateIpAddresses - Assigns private IP addresses to the network interface. This parameter is required.

Returns:

this

See Also:

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

secondaryPrivateIpAddressCount

@Stability(Stable)
public CfnNetworkInterface.Builder secondaryPrivateIpAddressCount(Number secondaryPrivateIpAddressCount)

The number of secondary private IPv4 addresses to assign to a network interface.

When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .

When creating a Network Interface, you can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

Parameters:

secondaryPrivateIpAddressCount - The number of secondary private IPv4 addresses to assign to a network interface. This parameter is required.

Returns:

this

See Also:

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

sourceDestCheck

@Stability(Stable)
public CfnNetworkInterface.Builder sourceDestCheck(Boolean sourceDestCheck)

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Parameters:

sourceDestCheck - Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. This parameter is required.

Returns:

this

See Also:

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

sourceDestCheck

@Stability(Stable)
public CfnNetworkInterface.Builder sourceDestCheck(IResolvable sourceDestCheck)

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Parameters:

sourceDestCheck - Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnNetworkInterface.Builder tags(List<? extends CfnTag> tags)

An arbitrary set of tags (key-value pairs) for this network interface.

Parameters:

tags - An arbitrary set of tags (key-value pairs) for this network interface. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnNetworkInterface build()

Specified by:

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

Returns:

a newly built instance of CfnNetworkInterface.