You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DirectConnect::Types::NewPrivateVirtualInterfaceAllocation

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb

Overview

Note:

When making an API call, you may pass NewPrivateVirtualInterfaceAllocation data as a hash:

{
  virtual_interface_name: "VirtualInterfaceName", # required
  vlan: 1, # required
  asn: 1, # required
  auth_key: "BGPAuthKey",
  amazon_address: "AmazonAddress",
  address_family: "ipv4", # accepts ipv4, ipv6
  customer_address: "CustomerAddress",
}

A structure containing information about a private virtual interface that will be provisioned on a connection.

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

Indicates the address family for the BGP peer.

  • ipv4: IPv4 address family

  • ipv6: IPv6 address family

Returns:

  • (String)


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2214

class NewPrivateVirtualInterfaceAllocation < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :auth_key,
  :amazon_address,
  :address_family,
  :customer_address)
  include Aws::Structure
end

#amazon_addressString

IP address assigned to the Amazon interface.

Example: 192.168.1.1/30 or 2001:db8::1/125

Returns:

  • (String)


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2214

class NewPrivateVirtualInterfaceAllocation < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :auth_key,
  :amazon_address,
  :address_family,
  :customer_address)
  include Aws::Structure
end

#asnInteger

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Example: 65000

Returns:

  • (Integer)


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2214

class NewPrivateVirtualInterfaceAllocation < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :auth_key,
  :amazon_address,
  :address_family,
  :customer_address)
  include Aws::Structure
end

#auth_keyString

The authentication key for BGP configuration.

Example: asdf34example

Returns:

  • (String)


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2214

class NewPrivateVirtualInterfaceAllocation < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :auth_key,
  :amazon_address,
  :address_family,
  :customer_address)
  include Aws::Structure
end

#customer_addressString

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

Returns:

  • (String)


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2214

class NewPrivateVirtualInterfaceAllocation < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :auth_key,
  :amazon_address,
  :address_family,
  :customer_address)
  include Aws::Structure
end

#virtual_interface_nameString

The name of the virtual interface assigned by the customer.

Example: "My VPC"

Returns:

  • (String)


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2214

class NewPrivateVirtualInterfaceAllocation < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :auth_key,
  :amazon_address,
  :address_family,
  :customer_address)
  include Aws::Structure
end

#vlanInteger

The VLAN ID.

Example: 101

Returns:

  • (Integer)


2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2214

class NewPrivateVirtualInterfaceAllocation < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :auth_key,
  :amazon_address,
  :address_family,
  :customer_address)
  include Aws::Structure
end