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")
         .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();

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

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

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

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

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the network interface.

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

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

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

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

    • getNetworkInterfaceId

      @Stability(Stable) @Nullable default String getNetworkInterfaceId()
      The ID of the network interface, when attaching an existing network interface.

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

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

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

    • getSubnetId

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

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

    • builder

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