Class: AWS::DirectConnect::Client

Inherits:
Core::JSONClient show all
Defined in:
lib/aws/direct_connect/client.rb

Overview

Client class for AWS Direct Connect.

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#create_connection(options = {}) ⇒ Core::Response

Calls the CreateConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :offering_id - required - (String)
    • :connection_name - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :connection_id - (String)
    • :connection_name - (String)
    • :connection_state - (String)
    • :region - (String)
    • :location - (String)



# File 'lib/aws/direct_connect/client.rb', line 25

#create_private_virtual_interface(options = {}) ⇒ Core::Response

Calls the CreatePrivateVirtualInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - (String)
    • :new_private_virtual_interface - (Hash) Detailed information of the private virtual interface to be created. Default: None
      • :virtual_interface_name - (String)
      • :vlan - (Integer)
      • :asn - (Integer)
      • :auth_key - (String)
      • :amazon_address - (String)
      • :customer_address - (String)
      • :virtual_gateway_id - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :virtual_interface_id - (String)
    • :location - (String)
    • :connection_id - (String)
    • :virtual_interface_type - (String)
    • :virtual_interface_name - (String)
    • :vlan - (Integer)
    • :asn - (Integer)
    • :auth_key - (String)
    • :amazon_address - (String)
    • :customer_address - (String)
    • :virtual_interface_state - (String)
    • :customer_router_config - (String)
    • :virtual_gateway_id - (String)
    • :route_filter_prefixes - (Array)
      • :cidr - (String)



# File 'lib/aws/direct_connect/client.rb', line 39

#create_public_virtual_interface(options = {}) ⇒ Core::Response

Calls the CreatePublicVirtualInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - (String)
    • :new_public_virtual_interface - (Hash) Detailed information of the public virtual interface to be created. Default: None
      • :virtual_interface_name - (String)
      • :vlan - (Integer)
      • :asn - (Integer)
      • :auth_key - (String)
      • :amazon_address - (String)
      • :customer_address - (String)
      • :route_filter_prefixes - (Array)
      • :cidr - (String) CIDR notation for the advertised route. Multiple routes are separated by commas Example: 10.10.10.0/24,10.10.11.0/24

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :virtual_interface_id - (String)
    • :location - (String)
    • :connection_id - (String)
    • :virtual_interface_type - (String)
    • :virtual_interface_name - (String)
    • :vlan - (Integer)
    • :asn - (Integer)
    • :auth_key - (String)
    • :amazon_address - (String)
    • :customer_address - (String)
    • :virtual_interface_state - (String)
    • :customer_router_config - (String)
    • :virtual_gateway_id - (String)
    • :route_filter_prefixes - (Array)
      • :cidr - (String)



# File 'lib/aws/direct_connect/client.rb', line 71

#delete_connection(options = {}) ⇒ Core::Response

Calls the DeleteConnection API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :connection_id - (String)
    • :connection_name - (String)
    • :connection_state - (String)
    • :region - (String)
    • :location - (String)



# File 'lib/aws/direct_connect/client.rb', line 106

#delete_virtual_interface(options = {}) ⇒ Core::Response

Calls the DeleteVirtualInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :virtual_interface_id - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :virtual_interface_state - (String)



# File 'lib/aws/direct_connect/client.rb', line 119

#describe_connection_detail(options = {}) ⇒ Core::Response

Calls the DescribeConnectionDetail API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :connection_id - (String)
    • :connection_name - (String)
    • :connection_state - (String)
    • :region - (String)
    • :location - (String)
    • :bandwidth - (String)
    • :connection_costs - (Array)
      • :name - (String)
      • :unit - (String)
      • :currency_code - (String)
      • :amount - (String)
    • :order_steps - (Array)
      • :number - (String)
      • :name - (String)
      • :description - (String)
      • :owner - (String)
      • :sla - (Integer)
      • :step_state - (String)



# File 'lib/aws/direct_connect/client.rb', line 128

#describe_connections(options = {}) ⇒ Core::Response

Calls the DescribeConnections API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :connections - (Array)
      • :connection_id - (String)
      • :connection_name - (String)
      • :connection_state - (String)
      • :region - (String)
      • :location - (String)



# File 'lib/aws/direct_connect/client.rb', line 154

#describe_offering_detail(options = {}) ⇒ Core::Response

Calls the DescribeOfferingDetail API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :offering_id - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :offering_id - (String)
    • :region - (String)
    • :location - (String)
    • :offering_name - (String)
    • :description - (String)
    • :bandwidth - (String)
    • :connection_costs - (Array)
      • :name - (String)
      • :unit - (String)
      • :currency_code - (String)
      • :amount - (String)
    • :order_steps - (Array)
      • :number - (String)
      • :name - (String)
      • :description - (String)
      • :owner - (String)
      • :sla - (Integer)



# File 'lib/aws/direct_connect/client.rb', line 168

#describe_offerings(options = {}) ⇒ Core::Response

Calls the DescribeOfferings API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :offerings - (Array)
      • :offering_id - (String)
      • :region - (String)
      • :location - (String)
      • :offering_name - (String)
      • :description - (String)
      • :bandwidth - (String)
      • :connection_costs - (Array)
      • :name - (String)
      • :unit - (String)
      • :currency_code - (String)
      • :amount - (String)



# File 'lib/aws/direct_connect/client.rb', line 193

#describe_virtual_gateways(options = {}) ⇒ Core::Response

Calls the DescribeVirtualGateways API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :virtual_gateways - (Array)
      • :virtual_gateway_id - (String)
      • :virtual_gateway_state - (String)



# File 'lib/aws/direct_connect/client.rb', line 212

#describe_virtual_interfaces(options = {}) ⇒ Core::Response

Calls the DescribeVirtualInterfaces API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - (String)
    • :virtual_interface_id - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :virtual_interfaces - (Array)
      • :virtual_interface_id - (String)
      • :location - (String)
      • :connection_id - (String)
      • :virtual_interface_type - (String)
      • :virtual_interface_name - (String)
      • :vlan - (Integer)
      • :asn - (Integer)
      • :auth_key - (String)
      • :amazon_address - (String)
      • :customer_address - (String)
      • :virtual_interface_state - (String)
      • :customer_router_config - (String)
      • :virtual_gateway_id - (String)
      • :route_filter_prefixes - (Array)
      • :cidr - (String)



# File 'lib/aws/direct_connect/client.rb', line 222