Class: Aws::EC2::Types::CreateNetworkInterfaceRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateNetworkInterfaceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #connection_tracking_specification ⇒ Types::ConnectionTrackingSpecificationRequest

  A connection tracking specification for the network interface.

• #description ⇒ String

  A description for the network interface.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #enable_primary_ipv_6 ⇒ Boolean

  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.

• #groups ⇒ Array<String>

  The IDs of one or more security groups.

• #interface_type ⇒ String

  The type of network interface.

• #ipv_4_prefix_count ⇒ Integer

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

• #ipv_4_prefixes ⇒ Array<Types::Ipv4PrefixSpecificationRequest>

  The IPv4 prefixes assigned to the network interface.

• #ipv_6_address_count ⇒ Integer

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

• #ipv_6_addresses ⇒ Array<Types::InstanceIpv6Address>

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

• #ipv_6_prefix_count ⇒ Integer

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

• #ipv_6_prefixes ⇒ Array<Types::Ipv6PrefixSpecificationRequest>

  The IPv6 prefixes assigned to the network interface.

• #private_ip_address ⇒ String

  The primary private IPv4 address of the network interface.

• #private_ip_addresses ⇒ Array<Types::PrivateIpAddressSpecification>

  The private IPv4 addresses.

• #secondary_private_ip_address_count ⇒ Integer

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

• #subnet_id ⇒ String

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

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to apply to the new network interface.

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#connection_tracking_specification ⇒ Types::ConnectionTrackingSpecificationRequest

A connection tracking specification for the network interface.

Returns:

• (Types::ConnectionTrackingSpecificationRequest)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the network interface.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#enable_primary_ipv_6 ⇒ Boolean

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:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#groups ⇒ Array<String>

The IDs of one or more security groups.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#interface_type ⇒ String

The type of network interface. The default is ‘interface`.

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_4_prefix_count ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_4_prefixes ⇒ Array<Types::Ipv4PrefixSpecificationRequest>

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:

• (Array<Types::Ipv4PrefixSpecificationRequest>)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_address_count ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_addresses ⇒ Array<Types::InstanceIpv6Address>

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:

• (Array<Types::InstanceIpv6Address>)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_prefix_count ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_prefixes ⇒ Array<Types::Ipv6PrefixSpecificationRequest>

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:

• (Array<Types::Ipv6PrefixSpecificationRequest>)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#private_ip_address ⇒ String

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:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#private_ip_addresses ⇒ Array<Types::PrivateIpAddressSpecification>

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:

• (Array<Types::PrivateIpAddressSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_private_ip_address_count ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the new network interface.

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 10115

class CreateNetworkInterfaceRequest < Struct.new(
  :description,
  :dry_run,
  :groups,
  :ipv_6_address_count,
  :ipv_6_addresses,
  :private_ip_address,
  :private_ip_addresses,
  :secondary_private_ip_address_count,
  :ipv_4_prefixes,
  :ipv_4_prefix_count,
  :ipv_6_prefixes,
  :ipv_6_prefix_count,
  :interface_type,
  :subnet_id,
  :tag_specifications,
  :client_token,
  :enable_primary_ipv_6,
  :connection_tracking_specification)
  SENSITIVE = []
  include Aws::Structure
end