InstanceNetworkInterfaceSpecification.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>, SdkBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>, SdkPojo

Enclosing class:

InstanceNetworkInterfaceSpecification
```
public static interface InstanceNetworkInterfaceSpecification.Builder
extends SdkPojo, CopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`InstanceNetworkInterfaceSpecification.Builder`	`associateCarrierIpAddress(Boolean associateCarrierIpAddress)` Indicates whether to assign a carrier IP address to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`associatePublicIpAddress(Boolean associatePublicIpAddress)` Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.
`InstanceNetworkInterfaceSpecification.Builder`	`deleteOnTermination(Boolean deleteOnTermination)` If set to `true`, the interface is deleted when the instance is terminated.
`InstanceNetworkInterfaceSpecification.Builder`	`description(String description)` The description of the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`deviceIndex(Integer deviceIndex)` The position of the network interface in the attachment order.
`InstanceNetworkInterfaceSpecification.Builder`	`groups(Collection<String> groups)` The IDs of the security groups for the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`groups(String... groups)` The IDs of the security groups for the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`interfaceType(String interfaceType)` The type of network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`ipv6AddressCount(Integer ipv6AddressCount)` A number of IPv6 addresses to assign to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`ipv6Addresses(Collection<InstanceIpv6Address> ipv6Addresses)` One or more IPv6 addresses to assign to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`ipv6Addresses(Consumer<InstanceIpv6Address.Builder>... ipv6Addresses)` One or more IPv6 addresses to assign to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`ipv6Addresses(InstanceIpv6Address... ipv6Addresses)` One or more IPv6 addresses to assign to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`networkCardIndex(Integer networkCardIndex)` The index of the network card.
`InstanceNetworkInterfaceSpecification.Builder`	`networkInterfaceId(String networkInterfaceId)` The ID of the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`privateIpAddress(String privateIpAddress)` The private IPv4 address of the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`privateIpAddresses(Collection<PrivateIpAddressSpecification> privateIpAddresses)` One or more private IPv4 addresses to assign to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`privateIpAddresses(Consumer<PrivateIpAddressSpecification.Builder>... privateIpAddresses)` One or more private IPv4 addresses to assign to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`privateIpAddresses(PrivateIpAddressSpecification... privateIpAddresses)` One or more private IPv4 addresses to assign to the network interface.
`InstanceNetworkInterfaceSpecification.Builder`	`secondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)` The number of secondary private IPv4 addresses.
`InstanceNetworkInterfaceSpecification.Builder`	`subnetId(String subnetId)` The ID of the subnet associated with the network interface.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - associatePublicIpAddress
```
InstanceNetworkInterfaceSpecification.Builder associatePublicIpAddress(Boolean associatePublicIpAddress)
```
    Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.
    
    Parameters:
    
    associatePublicIpAddress - Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deleteOnTermination
```
InstanceNetworkInterfaceSpecification.Builder deleteOnTermination(Boolean deleteOnTermination)
```
    If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
    
    Parameters:
    
    deleteOnTermination - If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
InstanceNetworkInterfaceSpecification.Builder description(String description)
```
    The description of the network interface. Applies only if creating a network interface when launching an instance.
    
    Parameters:
    
    description - The description of the network interface. Applies only if creating a network interface when launching an instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deviceIndex
```
InstanceNetworkInterfaceSpecification.Builder deviceIndex(Integer deviceIndex)
```
    The position of the network interface in the attachment order. A primary network interface has a device index of 0.
    
    If you specify a network interface when launching an instance, you must specify the device index.
    
    Parameters:
    
    deviceIndex - The position of the network interface in the attachment order. A primary network interface has a device index of 0.
    
    If you specify a network interface when launching an instance, you must specify the device index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - groups
```
InstanceNetworkInterfaceSpecification.Builder groups(Collection<String> groups)
```
    The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
    
    Parameters:
    
    groups - The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - groups
```
InstanceNetworkInterfaceSpecification.Builder groups(String... groups)
```
    The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
    
    Parameters:
    
    groups - The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ipv6AddressCount
```
InstanceNetworkInterfaceSpecification.Builder ipv6AddressCount(Integer ipv6AddressCount)
```
    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.
    
    Parameters:
    
    ipv6AddressCount - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ipv6Addresses
```
InstanceNetworkInterfaceSpecification.Builder ipv6Addresses(Collection<InstanceIpv6Address> ipv6Addresses)
```
    One or more 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.
    
    Parameters:
    
    ipv6Addresses - One or more 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - ipv6Addresses
```
InstanceNetworkInterfaceSpecification.Builder ipv6Addresses(InstanceIpv6Address... ipv6Addresses)
```
    One or more 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.
    
    Parameters:
    
    ipv6Addresses - One or more 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - ipv6Addresses
```
InstanceNetworkInterfaceSpecification.Builder ipv6Addresses(Consumer<InstanceIpv6Address.Builder>... ipv6Addresses)
```
    One or more 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.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #ipv6Addresses(List).
    
    Parameters:
    
    ipv6Addresses - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #ipv6Addresses(List)
  - networkInterfaceId
```
InstanceNetworkInterfaceSpecification.Builder networkInterfaceId(String networkInterfaceId)
```
    The ID of the network interface.
    
    If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
    
    Parameters:
    
    networkInterfaceId - The ID of the network interface.
    
    If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - privateIpAddress
```
InstanceNetworkInterfaceSpecification.Builder privateIpAddress(String privateIpAddress)
```
    The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Parameters:
    
    privateIpAddress - The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - privateIpAddresses
```
InstanceNetworkInterfaceSpecification.Builder privateIpAddresses(Collection<PrivateIpAddressSpecification> privateIpAddresses)
```
    One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Parameters:
    
    privateIpAddresses - One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - privateIpAddresses
```
InstanceNetworkInterfaceSpecification.Builder privateIpAddresses(PrivateIpAddressSpecification... privateIpAddresses)
```
    One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Parameters:
    
    privateIpAddresses - One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - privateIpAddresses
```
InstanceNetworkInterfaceSpecification.Builder privateIpAddresses(Consumer<PrivateIpAddressSpecification.Builder>... privateIpAddresses)
```
    One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #privateIpAddresses(List).
    
    Parameters:
    
    privateIpAddresses - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #privateIpAddresses(List)
  - secondaryPrivateIpAddressCount
```
InstanceNetworkInterfaceSpecification.Builder secondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)
```
    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. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Parameters:
    
    secondaryPrivateIpAddressCount - 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. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - subnetId
```
InstanceNetworkInterfaceSpecification.Builder subnetId(String subnetId)
```
    The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
    
    Parameters:
    
    subnetId - The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - associateCarrierIpAddress
```
InstanceNetworkInterfaceSpecification.Builder associateCarrierIpAddress(Boolean associateCarrierIpAddress)
```
    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 addresses in the AWS Wavelength Developer Guide.
    
    Parameters:
    
    associateCarrierIpAddress - 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 addresses in the AWS Wavelength Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - interfaceType
```
InstanceNetworkInterfaceSpecification.Builder interfaceType(String interfaceType)
```
    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
    
    Parameters:
    
    interfaceType - 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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - networkCardIndex
```
InstanceNetworkInterfaceSpecification.Builder networkCardIndex(Integer networkCardIndex)
```
    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.
    
    Parameters:
    
    networkCardIndex - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface InstanceNetworkInterfaceSpecification.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

associatePublicIpAddress

deleteOnTermination

description

deviceIndex

groups

groups

ipv6AddressCount

ipv6Addresses

ipv6Addresses

ipv6Addresses

networkInterfaceId

privateIpAddress

privateIpAddresses

privateIpAddresses

privateIpAddresses

secondaryPrivateIpAddressCount

subnetId

associateCarrierIpAddress

interfaceType

networkCardIndex