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

Class: Aws::DirectConnect::Types::NewPrivateVirtualInterface

Inherits:

Struct

• Object
• Struct
• Aws::DirectConnect::Types::NewPrivateVirtualInterface

Defined in:

gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb

Overview

Note:

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

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

A structure containing information about a new private virtual interface.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #address_family ⇒ String

  Indicates the address family for the BGP peer.

• #amazon_address ⇒ String

  IP address assigned to the Amazon interface.

• #asn ⇒ Integer

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

• #auth_key ⇒ String

  The authentication key for BGP configuration.

• #customer_address ⇒ String

  IP address assigned to the customer interface.

• #direct_connect_gateway_id ⇒ String

  The ID of the direct connect gateway.

• #virtual_gateway_id ⇒ String

  The ID of the virtual private gateway to a VPC.

• #virtual_interface_name ⇒ String

  The name of the virtual interface assigned by the customer.

• #vlan ⇒ Integer

  The VLAN ID.

Instance Attribute Details

#address_family ⇒ String

Indicates the address family for the BGP peer.

• ipv4: IPv4 address family

• ipv6: IPv6 address family

Returns:

• (String)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#amazon_address ⇒ String

IP address assigned to the Amazon interface.

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

Returns:

• (String)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#asn ⇒ Integer

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

Example: 65000

Returns:

• (Integer)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#auth_key ⇒ String

The authentication key for BGP configuration.

Example: asdf34example

Returns:

• (String)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#customer_address ⇒ String

IP address assigned to the customer interface.

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

Returns:

• (String)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#direct_connect_gateway_id ⇒ String

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

Returns:

• (String)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#virtual_gateway_id ⇒ String

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Example: vgw-123er56

Returns:

• (String)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#virtual_interface_name ⇒ String

The name of the virtual interface assigned by the customer.

Example: "My VPC"

Returns:

• (String)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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

#vlan ⇒ Integer

The VLAN ID.

Example: 101

Returns:

• (Integer)

# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 2780

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