Package software.amazon.awscdk.services.ec2

Interface CfnInstance.NetworkInterfaceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstance.NetworkInterfaceProperty.Jsii$Proxy

Enclosing class:

CfnInstance

@Stability(Stable)
public static interface CfnInstance.NetworkInterfaceProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a network interface that is to be attached to an instance.

You can create a network interface when launching an instance. For an example, see the AWS::EC2::Instance examples .

Alternatively, you can attach an existing network interface when launching an instance. For an example, see the AWS::EC2:NetworkInterface examples .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 NetworkInterfaceProperty networkInterfaceProperty = NetworkInterfaceProperty.builder()
         .deviceIndex("deviceIndex")
         // the properties below are optional
         .associateCarrierIpAddress(false)
         .associatePublicIpAddress(false)
         .deleteOnTermination(false)
         .description("description")
         .enaSrdSpecification(EnaSrdSpecificationProperty.builder()
                 .enaSrdEnabled(false)
                 .enaSrdUdpSpecification(EnaSrdUdpSpecificationProperty.builder()
                         .enaSrdUdpEnabled(false)
                         .build())
                 .build())
         .groupSet(List.of("groupSet"))
         .ipv6AddressCount(123)
         .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
                 .ipv6Address("ipv6Address")
                 .build()))
         .networkInterfaceId("networkInterfaceId")
         .privateIpAddress("privateIpAddress")
         .privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder()
                 .primary(false)
                 .privateIpAddress("privateIpAddress")
                 .build()))
         .secondaryPrivateIpAddressCount(123)
         .subnetId("subnetId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInstance.NetworkInterfaceProperty.Builder	A builder for CfnInstance.NetworkInterfaceProperty
static final class	CfnInstance.NetworkInterfaceProperty.Jsii$Proxy	An implementation for CfnInstance.NetworkInterfaceProperty

Method Summary

Modifier and Type	Method	Description
static CfnInstance.NetworkInterfaceProperty.Builder	builder()
default Object	getAssociateCarrierIpAddress()	Indicates whether to assign a carrier IP address to the network interface.
default Object	getAssociatePublicIpAddress()	Indicates whether to assign a public IPv4 address to an instance.
default Object	getDeleteOnTermination()	Indicates whether the network interface is deleted when the instance is terminated.
default String	getDescription()	The description of the network interface.
String	getDeviceIndex()	The position of the network interface in the attachment order.
default Object	getEnaSrdSpecification()	Configures ENA Express for UDP network traffic.
default List<String>	getGroupSet()	The IDs of the security groups for the network interface.
default Number	getIpv6AddressCount()	A number of IPv6 addresses to assign to the network interface.
default Object	getIpv6Addresses()	The IPv6 addresses to assign to the network interface.
default String	getNetworkInterfaceId()	The ID of the network interface, when attaching an existing network interface.
default String	getPrivateIpAddress()	The private IPv4 address of the network interface.
default Object	getPrivateIpAddresses()	One or more private IPv4 addresses to assign to the network interface.
default Number	getSecondaryPrivateIpAddressCount()	The number of secondary private IPv4 addresses.
default String	getSubnetId()	The ID of the subnet associated with the network interface.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeviceIndex

@Stability(Stable)
@NotNull
String getDeviceIndex()

The position of the network interface in the attachment order.

A primary network interface has a device index of 0.

If you create a network interface when launching an instance, you must specify the device index.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deviceindex

getAssociateCarrierIpAddress

@Stability(Stable)
@Nullable
default Object getAssociateCarrierIpAddress()

Indicates whether to assign a carrier IP address to the network interface.

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the AWS Wavelength Developer Guide .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatecarrieripaddress

getAssociatePublicIpAddress

@Stability(Stable)
@Nullable
default Object getAssociatePublicIpAddress()

Indicates whether to assign a public IPv4 address to an instance.

Applies only if creating a network interface when launching an instance. The network interface must be the primary network interface. If launching into a default subnet, the default value is true .

AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the VPC pricing page .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-associatepublicipaddress

getDeleteOnTermination

@Stability(Stable)
@Nullable
default Object getDeleteOnTermination()

Indicates whether the network interface is deleted when the instance is terminated.

Applies only if creating a network interface when launching an instance.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-deleteontermination

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the network interface.

Applies only if creating a network interface when launching an instance.

See Also:

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

getEnaSrdSpecification

@Stability(Stable)
@Nullable
default Object getEnaSrdSpecification()

Configures ENA Express for UDP network traffic.

Returns union: either IResolvable or CfnInstance.EnaSrdSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-enasrdspecification

getGroupSet

@Stability(Stable)
@Nullable
default List<String> getGroupSet()

The IDs of the security groups for the network interface.

Applies only if creating a network interface when launching an instance.

See Also:

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

getIpv6AddressCount

@Stability(Stable)
@Nullable
default Number getIpv6AddressCount()

A number of IPv6 addresses to assign to the network interface.

Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

See Also:

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

getIpv6Addresses

@Stability(Stable)
@Nullable
default Object getIpv6Addresses()

The IPv6 addresses to assign to the network interface.

You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInstance.InstanceIpv6AddressProperty>

See Also:

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

getNetworkInterfaceId

@Stability(Stable)
@Nullable
default String getNetworkInterfaceId()

The ID of the network interface, when attaching an existing network interface.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-networkinterface.html#cfn-ec2-instance-networkinterface-networkinterfaceid

getPrivateIpAddress

@Stability(Stable)
@Nullable
default String getPrivateIpAddress()

The private IPv4 address of the network interface.

Applies only if creating a network interface when launching an instance.

See Also:

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

getPrivateIpAddresses

@Stability(Stable)
@Nullable
default Object getPrivateIpAddresses()

One or more private IPv4 addresses to assign to the network interface.

Only one private IPv4 address can be designated as primary.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInstance.PrivateIpAddressSpecificationProperty>

See Also:

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

getSecondaryPrivateIpAddressCount

@Stability(Stable)
@Nullable
default Number getSecondaryPrivateIpAddressCount()

The number of secondary private IPv4 addresses.

You can't specify this option and specify more than one private IP address using the private IP addresses option.

See Also:

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

getSubnetId

@Stability(Stable)
@Nullable
default String getSubnetId()

The ID of the subnet associated with the network interface.

See Also:

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

builder

@Stability(Stable)
static CfnInstance.NetworkInterfaceProperty.Builder builder()

Returns:

a CfnInstance.NetworkInterfaceProperty.Builder of CfnInstance.NetworkInterfaceProperty