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

Class: AWS::DirectConnect::Client

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

Overview

Client class for AWS Direct Connect.

Direct Known Subclasses

V20121025

Defined Under Namespace

Classes: V20121025

Constant Summary

API_VERSION = 
'2012-10-25'

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

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

Constructor Details

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

Instance Method Details

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

Calls the AllocateConnectionOnInterconnect API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :bandwidth - required - (String)
    • :connection_name - required - (String) Name of the provisioned connection. Example: "500M Connection to AWS" Default: None
    • :owner_account - required - (String) Numeric account Id of the customer for whom the connection will be provisioned. Example: 123443215678 Default: None
    • :interconnect_id - required - (String) ID of the interconnect on which the connection will be provisioned. Example: dxcon-456abc78 Default: None
    • :vlan - required - (Integer) The dedicated VLAN provisioned to the connection. Example: 101 Default: None

Returns:

  • (Core::Response) —

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

    • :owner_account - (String)
    • :connection_id - (String)
    • :connection_name - (String)
    • :connection_state - (String)
    • :region - (String)
    • :location - (String)
    • :bandwidth - (String)
    • :vlan - (Integer)
    • :partner_name - (String)

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

Calls the AllocatePrivateVirtualInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - required - (String) The connection ID on which the private virtual interface is provisioned. Default: None
    • :owner_account - required - (String) The AWS account that will own the new private virtual interface. Default: None
    • :new_private_virtual_interface_allocation - required - (Hash) Detailed information for the private virtual interface to be provisioned. Default: None
      • :virtual_interface_name - required - (String)
      • :vlan - required - (Integer)
      • :asn - required - (Integer)
      • :auth_key - (String)
      • :amazon_address - (String)
      • :customer_address - (String)

Returns:

  • (Core::Response) —

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

    • :owner_account - (String)
    • :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)

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

Calls the AllocatePublicVirtualInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - required - (String) The connection ID on which the public virtual interface is provisioned. Default: None
    • :owner_account - required - (String) The AWS account that will own the new public virtual interface. Default: None
    • :new_public_virtual_interface_allocation - required - (Hash) Detailed information for the public virtual interface to be provisioned. Default: None
      • :virtual_interface_name - required - (String)
      • :vlan - required - (Integer)
      • :asn - required - (Integer)
      • :auth_key - (String)
      • :amazon_address - required - (String)
      • :customer_address - required - (String)
      • :route_filter_prefixes - required - (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:

    • :owner_account - (String)
    • :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)

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

Calls the ConfirmConnection 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_state - (String)

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

Calls the ConfirmPrivateVirtualInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :virtual_interface_id - required - (String)
    • :virtual_gateway_id - required - (String) ID of the virtual private gateway that will be attached to the virtual interface. A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action. Default: None

Returns:

  • (Core::Response) —

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

    • :virtual_interface_state - (String)

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

Calls the ConfirmPublicVirtualInterface API operation.

Parameters:

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

Returns:

  • (Core::Response) —

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

    • :virtual_interface_state - (String)

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

Calls the CreateConnection API operation.

Parameters:

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

Returns:

  • (Core::Response) —

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

    • :owner_account - (String)
    • :connection_id - (String)
    • :connection_name - (String)
    • :connection_state - (String)
    • :region - (String)
    • :location - (String)
    • :bandwidth - (String)
    • :vlan - (Integer)
    • :partner_name - (String)

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

Calls the CreateInterconnect API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :interconnect_name - required - (String) The name of the interconnect. Example: "1G Interconnect to AWS" Default: None
    • :bandwidth - required - (String) The port bandwidth Example: 1Gbps Default: None Available values: 1Gbps,10Gbps
    • :location - required - (String) Where the interconnect is located Example: EqSV5 Default: None

Returns:

  • (Core::Response) —

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

    • :interconnect_id - (String)
    • :interconnect_name - (String)
    • :interconnect_state - (String)
    • :region - (String)
    • :location - (String)
    • :bandwidth - (String)

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

Calls the CreatePrivateVirtualInterface API operation.

Parameters:

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

Returns:

  • (Core::Response) —

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

    • :owner_account - (String)
    • :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)

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

Calls the CreatePublicVirtualInterface API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :connection_id - required - (String)
    • :new_public_virtual_interface - required - (Hash) Detailed information for the public virtual interface to be created. Default: None
      • :virtual_interface_name - required - (String)
      • :vlan - required - (Integer)
      • :asn - required - (Integer)
      • :auth_key - (String)
      • :amazon_address - required - (String)
      • :customer_address - required - (String)
      • :route_filter_prefixes - required - (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:

    • :owner_account - (String)
    • :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)

#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:

    • :owner_account - (String)
    • :connection_id - (String)
    • :connection_name - (String)
    • :connection_state - (String)
    • :region - (String)
    • :location - (String)
    • :bandwidth - (String)
    • :vlan - (Integer)
    • :partner_name - (String)

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

Calls the DeleteInterconnect API operation.

Parameters:

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

Returns:

  • (Core::Response) —

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

    • :interconnect_state - (String)

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

Calls the DeleteVirtualInterface API operation.

Parameters:

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

Returns:

  • (Core::Response) —

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

    • :virtual_interface_state - (String)

#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)
      • :owner_account - (String)
      • :connection_id - (String)
      • :connection_name - (String)
      • :connection_state - (String)
      • :region - (String)
      • :location - (String)
      • :bandwidth - (String)
      • :vlan - (Integer)
      • :partner_name - (String)

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

Calls the DescribeConnectionsOnInterconnect API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :interconnect_id - required - (String) ID of the interconnect on which a list of connection is provisioned. Example: dxcon-abc123 Default: None

Returns:

  • (Core::Response) —

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

    • :connections - (Array)
      • :owner_account - (String)
      • :connection_id - (String)
      • :connection_name - (String)
      • :connection_state - (String)
      • :region - (String)
      • :location - (String)
      • :bandwidth - (String)
      • :vlan - (Integer)
      • :partner_name - (String)

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

Calls the DescribeInterconnects API operation.

Parameters:

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

Returns:

  • (Core::Response) —

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

    • :interconnects - (Array)
      • :interconnect_id - (String)
      • :interconnect_name - (String)
      • :interconnect_state - (String)
      • :region - (String)
      • :location - (String)
      • :bandwidth - (String)

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

Calls the DescribeLocations API operation.

Parameters:

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

Returns:

  • (Core::Response) —

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

    • :locations - (Array)
      • :location_code - (String)
      • :location_name - (String)

#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)

#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)
      • :owner_account - (String)
      • :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)