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)
         .deleteOnTermination(false)
         .description("description")
         .deviceIndex(123)
         .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")
         .privateIpAddress("privateIpAddress")
         .privateIpAddresses(List.of(PrivateIpAddProperty.builder()
                 .primary(false)
                 .privateIpAddress("privateIpAddress")
                 .build()))
         .secondaryPrivateIpAddressCount(123)
         .subnetId("subnetId")
         .build();

  • Method Details

    • getAssociateCarrierIpAddress

      @Stability(Stable) @Nullable default Object getAssociateCarrierIpAddress()
      Indicates whether to associate 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 .

    • getAssociatePublicIpAddress

      @Stability(Stable) @Nullable default Object getAssociatePublicIpAddress()
      Associates a public IPv4 address with eth0 for a new network interface.

    • getDeleteOnTermination

      @Stability(Stable) @Nullable default Object getDeleteOnTermination()
      Indicates whether the network interface is deleted when the instance is terminated.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description for the network interface.

    • getDeviceIndex

      @Stability(Stable) @Nullable default Number getDeviceIndex()
      The device index for the network interface attachment.

    • getGroups

      @Stability(Stable) @Nullable default List<String> getGroups()
      The IDs of one or more security groups.

    • getInterfaceType

      @Stability(Stable) @Nullable default String getInterfaceType()
      The type of network interface.

      To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .

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

      Valid values: interface | efa

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • getNetworkInterfaceId

      @Stability(Stable) @Nullable default String getNetworkInterfaceId()
      The ID of the network interface.

    • getPrivateIpAddress

      @Stability(Stable) @Nullable default String getPrivateIpAddress()
      The primary private IPv4 address of the network interface.

    • getPrivateIpAddresses

      @Stability(Stable) @Nullable default Object getPrivateIpAddresses()
      One or more private IPv4 addresses.

    • getSecondaryPrivateIpAddressCount

      @Stability(Stable) @Nullable default Number getSecondaryPrivateIpAddressCount()
      The number of secondary private IPv4 addresses to assign to a network interface.

    • getSubnetId

      @Stability(Stable) @Nullable default String getSubnetId()
      The ID of the subnet for the network interface.

    • builder

      @Stability(Stable) static CfnLaunchTemplate.NetworkInterfaceProperty.Builder builder()
      Returns:
      a CfnLaunchTemplate.NetworkInterfaceProperty.Builder of CfnLaunchTemplate.NetworkInterfaceProperty