Package software.amazon.awscdk.services.ec2

Interface CfnLaunchTemplate.NetworkInterfaceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchTemplate.NetworkInterfaceProperty.Jsii$Proxy

Enclosing class:

CfnLaunchTemplate

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

Specifies the parameters for a network interface.

NetworkInterface is a property of AWS::EC2::LaunchTemplate LaunchTemplateData .

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()
         .associateCarrierIpAddress(false)
         .associatePublicIpAddress(false)
         .connectionTrackingSpecification(ConnectionTrackingSpecificationProperty.builder()
                 .tcpEstablishedTimeout(123)
                 .udpStreamTimeout(123)
                 .udpTimeout(123)
                 .build())
         .deleteOnTermination(false)
         .description("description")
         .deviceIndex(123)
         .enaQueueCount(123)
         .enaSrdSpecification(EnaSrdSpecificationProperty.builder()
                 .enaSrdEnabled(false)
                 .enaSrdUdpSpecification(EnaSrdUdpSpecificationProperty.builder()
                         .enaSrdUdpEnabled(false)
                         .build())
                 .build())
         .groups(List.of("groups"))
         .interfaceType("interfaceType")
         .ipv4PrefixCount(123)
         .ipv4Prefixes(List.of(Ipv4PrefixSpecificationProperty.builder()
                 .ipv4Prefix("ipv4Prefix")
                 .build()))
         .ipv6AddressCount(123)
         .ipv6Addresses(List.of(Ipv6AddProperty.builder()
                 .ipv6Address("ipv6Address")
                 .build()))
         .ipv6PrefixCount(123)
         .ipv6Prefixes(List.of(Ipv6PrefixSpecificationProperty.builder()
                 .ipv6Prefix("ipv6Prefix")
                 .build()))
         .networkCardIndex(123)
         .networkInterfaceId("networkInterfaceId")
         .primaryIpv6(false)
         .privateIpAddress("privateIpAddress")
         .privateIpAddresses(List.of(PrivateIpAddProperty.builder()
                 .primary(false)
                 .privateIpAddress("privateIpAddress")
                 .build()))
         .secondaryPrivateIpAddressCount(123)
         .subnetId("subnetId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLaunchTemplate.NetworkInterfaceProperty.Builder	builder()
default Object	getAssociateCarrierIpAddress()	Associates a Carrier IP address with eth0 for a new network interface.
default Object	getAssociatePublicIpAddress()	Associates a public IPv4 address with eth0 for a new network interface.
default Object	getConnectionTrackingSpecification()	A connection tracking specification for the network interface.
default Object	getDeleteOnTermination()	Indicates whether the network interface is deleted when the instance is terminated.
default String	getDescription()	A description for the network interface.
default Number	getDeviceIndex()	The device index for the network interface attachment.
default Number	getEnaQueueCount()	The number of ENA queues to be created with the instance.
default Object	getEnaSrdSpecification()	The ENA Express configuration for the network interface.
default List<String>	getGroups()	The IDs of one or more security groups.
default String	getInterfaceType()	The type of network interface.
default Number	getIpv4PrefixCount()	The number of IPv4 prefixes to be automatically assigned to the network interface.
default Object	getIpv4Prefixes()	One or more IPv4 prefixes to be assigned to the network interface.
default Number	getIpv6AddressCount()	The number of IPv6 addresses to assign to a network interface.
default Object	getIpv6Addresses()	One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.
default Number	getIpv6PrefixCount()	The number of IPv6 prefixes to be automatically assigned to the network interface.
default Object	getIpv6Prefixes()	One or more IPv6 prefixes to be assigned to the network interface.
default Number	getNetworkCardIndex()	The index of the network card.
default String	getNetworkInterfaceId()	The ID of the network interface.
default Object	getPrimaryIpv6()	The primary IPv6 address of the network interface.
default String	getPrivateIpAddress()	The primary private IPv4 address of the network interface.
default Object	getPrivateIpAddresses()	One or more private IPv4 addresses.
default Number	getSecondaryPrivateIpAddressCount()	The number of secondary private IPv4 addresses to assign to a network interface.
default String	getSubnetId()	The ID of the subnet for the network interface.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssociateCarrierIpAddress

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

Associates a Carrier IP address with eth0 for a new network interface.

Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses 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-launchtemplate-networkinterface.html#cfn-ec2-launchtemplate-networkinterface-associatecarrieripaddress

getAssociatePublicIpAddress

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

Associates a public IPv4 address with eth0 for a new network interface.

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 Amazon VPC pricing page .

Returns union: either Boolean or IResolvable

See Also:

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

getConnectionTrackingSpecification

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

A connection tracking specification for the network interface.

Returns union: either IResolvable or CfnLaunchTemplate.ConnectionTrackingSpecificationProperty

See Also:

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

getDeleteOnTermination

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

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

Returns union: either Boolean or IResolvable

See Also:

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

getDescription

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

A description for the network interface.

See Also:

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

getDeviceIndex

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

The device index for the network interface attachment.

The primary network interface has a device index of 0. If the network interface is of type interface , you must specify a device index.

If you create a launch template that includes secondary network interfaces but no primary network interface, and you specify it using the LaunchTemplate property of AWS::EC2::Instance , then you must include a primary network interface using the NetworkInterfaces property of AWS::EC2::Instance .

See Also:

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

getEnaQueueCount

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

The number of ENA queues to be created with the instance.

See Also:

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

getEnaSrdSpecification

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

The ENA Express configuration for the network interface.

Returns union: either IResolvable or CfnLaunchTemplate.EnaSrdSpecificationProperty

See Also:

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

getGroups

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

The IDs of one or more security groups.

See Also:

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

getInterfaceType

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

The type of network interface.

To create an Elastic Fabric Adapter (EFA), specify efa or efa . For more information, see Elastic Fabric Adapter for AI/ML and HPC workloads on Amazon EC2 in the Amazon EC2 User Guide .

If you are not creating an EFA, specify interface or omit this parameter.

If you specify efa-only , do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.

Valid values: interface | efa | efa-only

See Also:

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

getIpv4PrefixCount

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

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

You cannot use this option if you use the Ipv4Prefix option.

See Also:

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

getIpv4Prefixes

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

One or more IPv4 prefixes to be assigned to the network interface.

You cannot use this option if you use the Ipv4PrefixCount option.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLaunchTemplate.Ipv4PrefixSpecificationProperty>

See Also:

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

getIpv6AddressCount

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

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

Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

See Also:

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

getIpv6Addresses

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

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.

You can't use this option if you're specifying a number of IPv6 addresses.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLaunchTemplate.Ipv6AddProperty>

See Also:

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

getIpv6PrefixCount

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

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

You cannot use this option if you use the Ipv6Prefix option.

See Also:

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

getIpv6Prefixes

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

One or more IPv6 prefixes to be assigned to the network interface.

You cannot use this option if you use the Ipv6PrefixCount option.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLaunchTemplate.Ipv6PrefixSpecificationProperty>

See Also:

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

getNetworkCardIndex

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

The index of the network card.

Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

See Also:

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

getNetworkInterfaceId

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

The ID of the network interface.

See Also:

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

getPrimaryIpv6

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

The primary IPv6 address of the network interface.

When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances .

Returns union: either Boolean or IResolvable

See Also:

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

getPrivateIpAddress

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

The primary private IPv4 address of the network interface.

See Also:

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

getPrivateIpAddresses

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

One or more private IPv4 addresses.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLaunchTemplate.PrivateIpAddProperty>

See Also:

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

getSecondaryPrivateIpAddressCount

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

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

See Also:

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

getSubnetId

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

The ID of the subnet for the network interface.

See Also:

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

builder

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

Returns:

a CfnLaunchTemplate.NetworkInterfaceProperty.Builder of CfnLaunchTemplate.NetworkInterfaceProperty