Package software.amazon.awssdk.services.ec2.model

Interface CreateNetworkInterfaceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateNetworkInterfaceRequest.Builder,CreateNetworkInterfaceRequest>, Ec2Request.Builder, SdkBuilder<CreateNetworkInterfaceRequest.Builder,CreateNetworkInterfaceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateNetworkInterfaceRequest
public static interface CreateNetworkInterfaceRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateNetworkInterfaceRequest.Builder,CreateNetworkInterfaceRequest>

  • Method Details

    • description

      CreateNetworkInterfaceRequest.Builder description(String description)

      A description for the network interface.

      Parameters:
      description - A description for the network interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      CreateNetworkInterfaceRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groups

      CreateNetworkInterfaceRequest.Builder groups(Collection<String> groups)

      The IDs of one or more security groups.

      Parameters:
      groups - The IDs of one or more security groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groups

      CreateNetworkInterfaceRequest.Builder groups(String... groups)

      The IDs of one or more security groups.

      Parameters:
      groups - The IDs of one or more security groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6AddressCount

      CreateNetworkInterfaceRequest.Builder ipv6AddressCount(Integer ipv6AddressCount)

      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 specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

      If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.

      Parameters:
      ipv6AddressCount - 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 specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

      If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Addresses

      CreateNetworkInterfaceRequest.Builder ipv6Addresses(Collection<InstanceIpv6Address> ipv6Addresses)

      The IPv6 addresses from the IPv6 CIDR block range of your subnet.

      You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

      Parameters:
      ipv6Addresses - The IPv6 addresses from the IPv6 CIDR block range of your subnet.

      You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Addresses

      CreateNetworkInterfaceRequest.Builder ipv6Addresses(InstanceIpv6Address... ipv6Addresses)

      The IPv6 addresses from the IPv6 CIDR block range of your subnet.

      You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

      Parameters:
      ipv6Addresses - The IPv6 addresses from the IPv6 CIDR block range of your subnet.

      You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Addresses

      CreateNetworkInterfaceRequest.Builder ipv6Addresses(Consumer<InstanceIpv6Address.Builder>... ipv6Addresses)

      The IPv6 addresses from the IPv6 CIDR block range of your subnet.

      You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

      This is a convenience method that creates an instance of the InstanceIpv6Address.Builder avoiding the need to create one manually via InstanceIpv6Address.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ipv6Addresses(List<InstanceIpv6Address>).

      Parameters:
      ipv6Addresses - a consumer that will call methods on InstanceIpv6Address.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • privateIpAddress

      CreateNetworkInterfaceRequest.Builder privateIpAddress(String privateIpAddress)

      The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

      Parameters:
      privateIpAddress - The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privateIpAddresses

      CreateNetworkInterfaceRequest.Builder privateIpAddresses(Collection<PrivateIpAddressSpecification> privateIpAddresses)

      The private IPv4 addresses.

      You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

      Parameters:
      privateIpAddresses - The private IPv4 addresses.

      You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privateIpAddresses

      CreateNetworkInterfaceRequest.Builder privateIpAddresses(PrivateIpAddressSpecification... privateIpAddresses)

      The private IPv4 addresses.

      You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

      Parameters:
      privateIpAddresses - The private IPv4 addresses.

      You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privateIpAddresses

      CreateNetworkInterfaceRequest.Builder privateIpAddresses(Consumer<PrivateIpAddressSpecification.Builder>... privateIpAddresses)

      The private IPv4 addresses.

      You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

      This is a convenience method that creates an instance of the PrivateIpAddressSpecification.Builder avoiding the need to create one manually via PrivateIpAddressSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to privateIpAddresses(List<PrivateIpAddressSpecification>).

      Parameters:
      privateIpAddresses - a consumer that will call methods on PrivateIpAddressSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondaryPrivateIpAddressCount

      CreateNetworkInterfaceRequest.Builder secondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)

      The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

      You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

      Parameters:
      secondaryPrivateIpAddressCount - The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

      You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv4Prefixes

      CreateNetworkInterfaceRequest.Builder ipv4Prefixes(Collection<Ipv4PrefixSpecificationRequest> ipv4Prefixes)

      The IPv4 prefixes assigned to the network interface.

      You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

      Parameters:
      ipv4Prefixes - The IPv4 prefixes assigned to the network interface.

      You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv4Prefixes

      CreateNetworkInterfaceRequest.Builder ipv4Prefixes(Ipv4PrefixSpecificationRequest... ipv4Prefixes)

      The IPv4 prefixes assigned to the network interface.

      You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

      Parameters:
      ipv4Prefixes - The IPv4 prefixes assigned to the network interface.

      You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv4Prefixes

      CreateNetworkInterfaceRequest.Builder ipv4Prefixes(Consumer<Ipv4PrefixSpecificationRequest.Builder>... ipv4Prefixes)

      The IPv4 prefixes assigned to the network interface.

      You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

      This is a convenience method that creates an instance of the Ipv4PrefixSpecificationRequest.Builder avoiding the need to create one manually via Ipv4PrefixSpecificationRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ipv4Prefixes(List<Ipv4PrefixSpecificationRequest>).

      Parameters:
      ipv4Prefixes - a consumer that will call methods on Ipv4PrefixSpecificationRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipv4PrefixCount

      CreateNetworkInterfaceRequest.Builder ipv4PrefixCount(Integer ipv4PrefixCount)

      The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

      You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

      Parameters:
      ipv4PrefixCount - The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

      You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Prefixes

      CreateNetworkInterfaceRequest.Builder ipv6Prefixes(Collection<Ipv6PrefixSpecificationRequest> ipv6Prefixes)

      The IPv6 prefixes assigned to the network interface.

      You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

      Parameters:
      ipv6Prefixes - The IPv6 prefixes assigned to the network interface.

      You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Prefixes

      CreateNetworkInterfaceRequest.Builder ipv6Prefixes(Ipv6PrefixSpecificationRequest... ipv6Prefixes)

      The IPv6 prefixes assigned to the network interface.

      You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

      Parameters:
      ipv6Prefixes - The IPv6 prefixes assigned to the network interface.

      You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Prefixes

      CreateNetworkInterfaceRequest.Builder ipv6Prefixes(Consumer<Ipv6PrefixSpecificationRequest.Builder>... ipv6Prefixes)

      The IPv6 prefixes assigned to the network interface.

      You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

      This is a convenience method that creates an instance of the Ipv6PrefixSpecificationRequest.Builder avoiding the need to create one manually via Ipv6PrefixSpecificationRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ipv6Prefixes(List<Ipv6PrefixSpecificationRequest>).

      Parameters:
      ipv6Prefixes - a consumer that will call methods on Ipv6PrefixSpecificationRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipv6PrefixCount

      CreateNetworkInterfaceRequest.Builder ipv6PrefixCount(Integer ipv6PrefixCount)

      The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

      You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

      Parameters:
      ipv6PrefixCount - The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

      You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interfaceType

      CreateNetworkInterfaceRequest.Builder interfaceType(String interfaceType)

      The type of network interface. The default is interface.

      The only supported values are interface, efa, and trunk.

      Parameters:
      interfaceType - The type of network interface. The default is interface.

      The only supported values are interface, efa, and trunk.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • interfaceType

      CreateNetworkInterfaceRequest.Builder interfaceType(NetworkInterfaceCreationType interfaceType)

      The type of network interface. The default is interface.

      The only supported values are interface, efa, and trunk.

      Parameters:
      interfaceType - The type of network interface. The default is interface.

      The only supported values are interface, efa, and trunk.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subnetId

      CreateNetworkInterfaceRequest.Builder subnetId(String subnetId)

      The ID of the subnet to associate with the network interface.

      Parameters:
      subnetId - The ID of the subnet to associate with the network interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateNetworkInterfaceRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to apply to the new network interface.

      Parameters:
      tagSpecifications - The tags to apply to the new network interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateNetworkInterfaceRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to apply to the new network interface.

      Parameters:
      tagSpecifications - The tags to apply to the new network interface.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateNetworkInterfaceRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to apply to the new network interface.

      This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateNetworkInterfaceRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

      Parameters:
      clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enablePrimaryIpv6

      CreateNetworkInterfaceRequest.Builder enablePrimaryIpv6(Boolean enablePrimaryIpv6)

      If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. 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. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

      Parameters:
      enablePrimaryIpv6 - If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. 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. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateNetworkInterfaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateNetworkInterfaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.