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

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 NewPrivateVirtualInterface data as a hash:

{
  virtual_interface_name: "VirtualInterfaceName", # required
  vlan: 1, # required
  asn: 1, # required
  mtu: 1,
  auth_key: "BGPAuthKey",
  amazon_address: "AmazonAddress",
  customer_address: "CustomerAddress",
  address_family: "ipv4", # accepts ipv4, ipv6
  virtual_gateway_id: "VirtualGatewayId",
  direct_connect_gateway_id: "DirectConnectGatewayId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Information about a private virtual interface.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

The address family for the BGP peer.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#amazon_addressString

The IP address assigned to the Amazon interface.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#asnInteger

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

The valid values are 1-2147483647.

Returns:

  • (Integer)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#auth_keyString

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#customer_addressString

The IP address assigned to the customer interface.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#direct_connect_gateway_idString

The ID of the Direct Connect gateway.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#mtuInteger

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Returns:

  • (Integer)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags associated with the private virtual interface.

Returns:



3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_gateway_idString

The ID of the virtual private gateway.

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_interface_nameString

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

Returns:

  • (String)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vlanInteger

The ID of the VLAN.

Returns:

  • (Integer)


3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/types.rb', line 3100

class NewPrivateVirtualInterface < Struct.new(
  :virtual_interface_name,
  :vlan,
  :asn,
  :mtu,
  :auth_key,
  :amazon_address,
  :customer_address,
  :address_family,
  :virtual_gateway_id,
  :direct_connect_gateway_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end