Class: Aws::DirectConnect::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb

Overview

An API client for DirectConnect. To construct a client, you need to configure a :region and :credentials.

client = Aws::DirectConnect::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



334
335
336
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#accept_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::AcceptDirectConnectGatewayAssociationProposalResult

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

Examples:

Request syntax with placeholder values


resp = client.accept_direct_connect_gateway_association_proposal({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
  proposal_id: "DirectConnectGatewayAssociationProposalId", # required
  associated_gateway_owner_account: "OwnerAccount", # required
  override_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association. #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway. #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_id (required, String)

    The ID of the Direct Connect gateway.

  • :proposal_id (required, String)

    The ID of the request proposal.

  • :associated_gateway_owner_account (required, String)

    The ID of the AWS account that owns the virtual private gateway or transit gateway.

  • :override_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>)

    Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

    For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

Returns:

See Also:



402
403
404
405
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 402

def accept_direct_connect_gateway_association_proposal(params = {}, options = {})
  req = build_request(:accept_direct_connect_gateway_association_proposal, params)
  req.send_request(options)
end

#allocate_connection_on_interconnect(params = {}) ⇒ Types::Connection

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.allocate_connection_on_interconnect({
  bandwidth: "Bandwidth", # required
  connection_name: "ConnectionName", # required
  owner_account: "OwnerAccount", # required
  interconnect_id: "InterconnectId", # required
  vlan: 1, # required
})

Response structure


resp. #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :bandwidth (required, String)

    The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

  • :connection_name (required, String)

    The name of the provisioned connection.

  • :owner_account (required, String)

    The ID of the AWS account of the customer for whom the connection will be provisioned.

  • :interconnect_id (required, String)

    The ID of the interconnect on which the connection will be provisioned.

  • :vlan (required, Integer)

    The dedicated VLAN provisioned to the connection.

Returns:

See Also:



495
496
497
498
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 495

def allocate_connection_on_interconnect(params = {}, options = {})
  req = build_request(:allocate_connection_on_interconnect, params)
  req.send_request(options)
end

#allocate_hosted_connection(params = {}) ⇒ Types::Connection

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.allocate_hosted_connection({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  bandwidth: "Bandwidth", # required
  connection_name: "ConnectionName", # required
  vlan: 1, # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp. #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the interconnect or LAG.

  • :owner_account (required, String)

    The ID of the AWS account ID of the customer for the connection.

  • :bandwidth (required, String)

    The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

  • :connection_name (required, String)

    The name of the hosted connection.

  • :vlan (required, Integer)

    The dedicated VLAN provisioned to the hosted connection.

  • :tags (Array<Types::Tag>)

    The tags associated with the connection.

Returns:

See Also:



597
598
599
600
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 597

def allocate_hosted_connection(params = {}, options = {})
  req = build_request(:allocate_hosted_connection, params)
  req.send_request(options)
end

#allocate_private_virtual_interface(params = {}) ⇒ Types::VirtualInterface

Provisions a private virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

Examples:

Request syntax with placeholder values


resp = client.allocate_private_virtual_interface({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  new_private_virtual_interface_allocation: { # required
    virtual_interface_name: "VirtualInterfaceName", # required
    vlan: 1, # required
    asn: 1, # required
    mtu: 1,
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    customer_address: "CustomerAddress",
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp. #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> Boolean
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection on which the private virtual interface is provisioned.

  • :owner_account (required, String)

    The ID of the AWS account that owns the virtual private interface.

  • :new_private_virtual_interface_allocation (required, Types::NewPrivateVirtualInterfaceAllocation)

    Information about the private virtual interface.

Returns:

See Also:



713
714
715
716
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 713

def allocate_private_virtual_interface(params = {}, options = {})
  req = build_request(:allocate_private_virtual_interface, params)
  req.send_request(options)
end

#allocate_public_virtual_interface(params = {}) ⇒ Types::VirtualInterface

Provisions a public virtual interface to be owned by the specified AWS account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

Examples:

Request syntax with placeholder values


resp = client.allocate_public_virtual_interface({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  new_public_virtual_interface_allocation: { # required
    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
    route_filter_prefixes: [
      {
        cidr: "CIDR",
      },
    ],
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp. #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> Boolean
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection on which the public virtual interface is provisioned.

  • :owner_account (required, String)

    The ID of the AWS account that owns the public virtual interface.

  • :new_public_virtual_interface_allocation (required, Types::NewPublicVirtualInterfaceAllocation)

    Information about the public virtual interface.

Returns:

See Also:



841
842
843
844
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 841

def allocate_public_virtual_interface(params = {}, options = {})
  req = build_request(:allocate_public_virtual_interface, params)
  req.send_request(options)
end

#allocate_transit_virtual_interface(params = {}) ⇒ Types::AllocateTransitVirtualInterfaceResult

Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

Examples:

Request syntax with placeholder values


resp = client.allocate_transit_virtual_interface({
  connection_id: "ConnectionId", # required
  owner_account: "OwnerAccount", # required
  new_transit_virtual_interface_allocation: { # required
    virtual_interface_name: "VirtualInterfaceName",
    vlan: 1,
    asn: 1,
    mtu: 1,
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.virtual_interface. #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> Boolean
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection on which the transit virtual interface is provisioned.

  • :owner_account (required, String)

    The ID of the AWS account that owns the transit virtual interface.

  • :new_transit_virtual_interface_allocation (required, Types::NewTransitVirtualInterfaceAllocation)

    Information about the transit virtual interface.

Returns:

See Also:



938
939
940
941
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 938

def allocate_transit_virtual_interface(params = {}, options = {})
  req = build_request(:allocate_transit_virtual_interface, params)
  req.send_request(options)
end

#associate_connection_with_lag(params = {}) ⇒ Types::Connection

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

Examples:

Request syntax with placeholder values


resp = client.associate_connection_with_lag({
  connection_id: "ConnectionId", # required
  lag_id: "LagId", # required
})

Response structure


resp. #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection.

  • :lag_id (required, String)

    The ID of the LAG with which to associate the connection.

Returns:

See Also:



1022
1023
1024
1025
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1022

def associate_connection_with_lag(params = {}, options = {})
  req = build_request(:associate_connection_with_lag, params)
  req.send_request(options)
end

#associate_hosted_connection(params = {}) ⇒ Types::Connection

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.associate_hosted_connection({
  connection_id: "ConnectionId", # required
  parent_connection_id: "ConnectionId", # required
})

Response structure


resp. #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the hosted connection.

  • :parent_connection_id (required, String)

    The ID of the interconnect or the LAG.

Returns:

See Also:



1096
1097
1098
1099
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1096

def associate_hosted_connection(params = {}, options = {})
  req = build_request(:associate_hosted_connection, params)
  req.send_request(options)
end

#associate_virtual_interface(params = {}) ⇒ Types::VirtualInterface

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.

Examples:

Request syntax with placeholder values


resp = client.associate_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
  connection_id: "ConnectionId", # required
})

Response structure


resp. #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> Boolean
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual interface.

  • :connection_id (required, String)

    The ID of the LAG or connection.

Returns:

See Also:



1200
1201
1202
1203
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1200

def associate_virtual_interface(params = {}, options = {})
  req = build_request(:associate_virtual_interface, params)
  req.send_request(options)
end

#confirm_connection(params = {}) ⇒ Types::ConfirmConnectionResponse

Confirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.

Examples:

Request syntax with placeholder values


resp = client.confirm_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the hosted connection.

Returns:

See Also:



1233
1234
1235
1236
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1233

def confirm_connection(params = {}, options = {})
  req = build_request(:confirm_connection, params)
  req.send_request(options)
end

#confirm_private_virtual_interface(params = {}) ⇒ Types::ConfirmPrivateVirtualInterfaceResponse

Accepts ownership of a private virtual interface created by another AWS account.

After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.

Examples:

Request syntax with placeholder values


resp = client.confirm_private_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
  virtual_gateway_id: "VirtualGatewayId",
  direct_connect_gateway_id: "DirectConnectGatewayId",
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual interface.

  • :virtual_gateway_id (String)

    The ID of the virtual private gateway.

  • :direct_connect_gateway_id (String)

    The ID of the Direct Connect gateway.

Returns:

See Also:



1275
1276
1277
1278
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1275

def confirm_private_virtual_interface(params = {}, options = {})
  req = build_request(:confirm_private_virtual_interface, params)
  req.send_request(options)
end

#confirm_public_virtual_interface(params = {}) ⇒ Types::ConfirmPublicVirtualInterfaceResponse

Accepts ownership of a public virtual interface created by another AWS account.

After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.

Examples:

Request syntax with placeholder values


resp = client.confirm_public_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual interface.

Returns:

See Also:



1307
1308
1309
1310
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1307

def confirm_public_virtual_interface(params = {}, options = {})
  req = build_request(:confirm_public_virtual_interface, params)
  req.send_request(options)
end

#confirm_transit_virtual_interface(params = {}) ⇒ Types::ConfirmTransitVirtualInterfaceResponse

Accepts ownership of a transit virtual interface created by another AWS account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

Examples:

Request syntax with placeholder values


resp = client.confirm_transit_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual interface.

  • :direct_connect_gateway_id (required, String)

    The ID of the Direct Connect gateway.

Returns:

See Also:



1344
1345
1346
1347
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1344

def confirm_transit_virtual_interface(params = {}, options = {})
  req = build_request(:confirm_transit_virtual_interface, params)
  req.send_request(options)
end

#create_bgp_peer(params = {}) ⇒ Types::CreateBGPPeerResponse

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.

Examples:

Request syntax with placeholder values


resp = client.create_bgp_peer({
  virtual_interface_id: "VirtualInterfaceId",
  new_bgp_peer: {
    asn: 1,
    auth_key: "BGPAuthKey",
    address_family: "ipv4", # accepts ipv4, ipv6
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
  },
})

Response structure


resp.virtual_interface. #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> Boolean
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (String)

    The ID of the virtual interface.

  • :new_bgp_peer (Types::NewBGPPeer)

    Information about the BGP peer.

Returns:

See Also:



1432
1433
1434
1435
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1432

def create_bgp_peer(params = {}, options = {})
  req = build_request(:create_bgp_peer, params)
  req.send_request(options)
end

#create_connection(params = {}) ⇒ Types::Connection

Creates a connection between a customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.

To find the locations for your Region, use DescribeLocations.

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  location: "LocationCode", # required
  bandwidth: "Bandwidth", # required
  connection_name: "ConnectionName", # required
  lag_id: "LagId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  provider_name: "ProviderName",
})

Response structure


resp. #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :location (required, String)

    The location of the connection.

  • :bandwidth (required, String)

    The bandwidth of the connection.

  • :connection_name (required, String)

    The name of the connection.

  • :lag_id (String)

    The ID of the LAG.

  • :tags (Array<Types::Tag>)

    The tags to associate with the lag.

  • :provider_name (String)

    The name of the service provider associated with the requested connection.

Returns:

See Also:



1534
1535
1536
1537
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1534

def create_connection(params = {}, options = {})
  req = build_request(:create_connection, params)
  req.send_request(options)
end

#create_direct_connect_gateway(params = {}) ⇒ Types::CreateDirectConnectGatewayResult

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.

Examples:

Request syntax with placeholder values


resp = client.create_direct_connect_gateway({
  direct_connect_gateway_name: "DirectConnectGatewayName", # required
  amazon_side_asn: 1,
})

Response structure


resp.direct_connect_gateway.direct_connect_gateway_id #=> String
resp.direct_connect_gateway.direct_connect_gateway_name #=> String
resp.direct_connect_gateway.amazon_side_asn #=> Integer
resp.direct_connect_gateway. #=> String
resp.direct_connect_gateway.direct_connect_gateway_state #=> String, one of "pending", "available", "deleting", "deleted"
resp.direct_connect_gateway.state_change_error #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_name (required, String)

    The name of the Direct Connect gateway.

  • :amazon_side_asn (Integer)

    The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

Returns:

See Also:



1581
1582
1583
1584
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1581

def create_direct_connect_gateway(params = {}, options = {})
  req = build_request(:create_direct_connect_gateway, params)
  req.send_request(options)
end

#create_direct_connect_gateway_association(params = {}) ⇒ Types::CreateDirectConnectGatewayAssociationResult

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

Examples:

Request syntax with placeholder values


resp = client.create_direct_connect_gateway_association({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
  gateway_id: "GatewayIdToAssociate",
  add_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
  virtual_gateway_id: "VirtualGatewayId",
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association. #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway. #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_id (required, String)

    The ID of the Direct Connect gateway.

  • :gateway_id (String)

    The ID of the virtual private gateway or transit gateway.

  • :add_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>)

    The Amazon VPC prefixes to advertise to the Direct Connect gateway

    This parameter is required when you create an association to a transit gateway.

    For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

  • :virtual_gateway_id (String)

    The ID of the virtual private gateway.

Returns:

See Also:



1650
1651
1652
1653
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1650

def create_direct_connect_gateway_association(params = {}, options = {})
  req = build_request(:create_direct_connect_gateway_association, params)
  req.send_request(options)
end

#create_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::CreateDirectConnectGatewayAssociationProposalResult

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any AWS account.

Examples:

Request syntax with placeholder values


resp = client.create_direct_connect_gateway_association_proposal({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
  direct_connect_gateway_owner_account: "OwnerAccount", # required
  gateway_id: "GatewayIdToAssociate", # required
  add_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
  remove_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
})

Response structure


resp.direct_connect_gateway_association_proposal.proposal_id #=> String
resp.direct_connect_gateway_association_proposal.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association_proposal. #=> String
resp.direct_connect_gateway_association_proposal.proposal_state #=> String, one of "requested", "accepted", "deleted"
resp.direct_connect_gateway_association_proposal.associated_gateway.id #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association_proposal.associated_gateway. #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.region #=> String
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_id (required, String)

    The ID of the Direct Connect gateway.

  • :direct_connect_gateway_owner_account (required, String)

    The ID of the AWS account that owns the Direct Connect gateway.

  • :gateway_id (required, String)

    The ID of the virtual private gateway or transit gateway.

  • :add_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>)

    The Amazon VPC prefixes to advertise to the Direct Connect gateway.

  • :remove_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>)

    The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

Returns:

See Also:



1718
1719
1720
1721
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1718

def create_direct_connect_gateway_association_proposal(params = {}, options = {})
  req = build_request(:create_direct_connect_gateway_association_proposal, params)
  req.send_request(options)
end

#create_interconnect(params = {}) ⇒ Types::Interconnect

Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.create_interconnect({
  interconnect_name: "InterconnectName", # required
  bandwidth: "Bandwidth", # required
  location: "LocationCode", # required
  lag_id: "LagId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  provider_name: "ProviderName",
})

Response structure


resp.interconnect_id #=> String
resp.interconnect_name #=> String
resp.interconnect_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :interconnect_name (required, String)

    The name of the interconnect.

  • :bandwidth (required, String)

    The port bandwidth, in Gbps. The possible values are 1 and 10.

  • :location (required, String)

    The location of the interconnect.

  • :lag_id (String)

    The ID of the LAG.

  • :tags (Array<Types::Tag>)

    The tags to associate with the interconnect.

  • :provider_name (String)

    The name of the service provider associated with the interconnect.

Returns:

See Also:



1825
1826
1827
1828
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1825

def create_interconnect(params = {}, options = {})
  req = build_request(:create_interconnect, params)
  req.send_request(options)
end

#create_lag(params = {}) ⇒ Types::Lag

Creates a link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

Examples:

Request syntax with placeholder values


resp = client.create_lag({
  number_of_connections: 1, # required
  location: "LocationCode", # required
  connections_bandwidth: "Bandwidth", # required
  lag_name: "LagName", # required
  connection_id: "ConnectionId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  child_connection_tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  provider_name: "ProviderName",
})

Response structure


resp.connections_bandwidth #=> String
resp.number_of_connections #=> Integer
resp.lag_id #=> String
resp. #=> String
resp.lag_name #=> String
resp.lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.location #=> String
resp.region #=> String
resp.minimum_links #=> Integer
resp.aws_device #=> String
resp.aws_device_v2 #=> String
resp.connections #=> Array
resp.connections[0]. #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> Boolean
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String
resp.allows_hosted_connections #=> Boolean
resp.jumbo_frame_capable #=> Boolean
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :number_of_connections (required, Integer)

    The number of physical connections initially provisioned and bundled by the LAG.

  • :location (required, String)

    The location for the LAG.

  • :connections_bandwidth (required, String)

    The bandwidth of the individual physical connections bundled by the LAG. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps.

  • :lag_name (required, String)

    The name of the LAG.

  • :connection_id (String)

    The ID of an existing connection to migrate to the LAG.

  • :tags (Array<Types::Tag>)

    The tags to associate with the LAG.

  • :child_connection_tags (Array<Types::Tag>)

    The tags to associate with the automtically created LAGs.

  • :provider_name (String)

    The name of the service provider associated with the LAG.

Returns:

See Also:



1972
1973
1974
1975
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 1972

def create_lag(params = {}, options = {})
  req = build_request(:create_lag, params)
  req.send_request(options)
end

#create_private_virtual_interface(params = {}) ⇒ Types::VirtualInterface

Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Examples:

Request syntax with placeholder values


resp = client.create_private_virtual_interface({
  connection_id: "ConnectionId", # required
  new_private_virtual_interface: { # required
    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",
      },
    ],
  },
})

Response structure


resp. #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> Boolean
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection.

  • :new_private_virtual_interface (required, Types::NewPrivateVirtualInterface)

    Information about the private virtual interface.

Returns:

See Also:



2095
2096
2097
2098
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2095

def create_private_virtual_interface(params = {}, options = {})
  req = build_request(:create_private_virtual_interface, params)
  req.send_request(options)
end

#create_public_virtual_interface(params = {}) ⇒ Types::VirtualInterface

Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

Examples:

Request syntax with placeholder values


resp = client.create_public_virtual_interface({
  connection_id: "ConnectionId", # required
  new_public_virtual_interface: { # required
    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
    route_filter_prefixes: [
      {
        cidr: "CIDR",
      },
    ],
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp. #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> Boolean
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection.

  • :new_public_virtual_interface (required, Types::NewPublicVirtualInterface)

    Information about the public virtual interface.

Returns:

See Also:



2210
2211
2212
2213
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2210

def create_public_virtual_interface(params = {}, options = {})
  req = build_request(:create_public_virtual_interface, params)
  req.send_request(options)
end

#create_transit_virtual_interface(params = {}) ⇒ Types::CreateTransitVirtualInterfaceResult

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Examples:

Request syntax with placeholder values


resp = client.create_transit_virtual_interface({
  connection_id: "ConnectionId", # required
  new_transit_virtual_interface: { # required
    virtual_interface_name: "VirtualInterfaceName",
    vlan: 1,
    asn: 1,
    mtu: 1,
    auth_key: "BGPAuthKey",
    amazon_address: "AmazonAddress",
    customer_address: "CustomerAddress",
    address_family: "ipv4", # accepts ipv4, ipv6
    direct_connect_gateway_id: "DirectConnectGatewayId",
    tags: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.virtual_interface. #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> Boolean
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection.

  • :new_transit_virtual_interface (required, Types::NewTransitVirtualInterface)

    Information about the transit virtual interface.

Returns:

See Also:



2312
2313
2314
2315
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2312

def create_transit_virtual_interface(params = {}, options = {})
  req = build_request(:create_transit_virtual_interface, params)
  req.send_request(options)
end

#delete_bgp_peer(params = {}) ⇒ Types::DeleteBGPPeerResponse

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

Examples:

Request syntax with placeholder values


resp = client.delete_bgp_peer({
  virtual_interface_id: "VirtualInterfaceId",
  asn: 1,
  customer_address: "CustomerAddress",
  bgp_peer_id: "BGPPeerId",
})

Response structure


resp.virtual_interface. #=> String
resp.virtual_interface.virtual_interface_id #=> String
resp.virtual_interface.location #=> String
resp.virtual_interface.connection_id #=> String
resp.virtual_interface.virtual_interface_type #=> String
resp.virtual_interface.virtual_interface_name #=> String
resp.virtual_interface.vlan #=> Integer
resp.virtual_interface.asn #=> Integer
resp.virtual_interface.amazon_side_asn #=> Integer
resp.virtual_interface.auth_key #=> String
resp.virtual_interface.amazon_address #=> String
resp.virtual_interface.customer_address #=> String
resp.virtual_interface.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interface.customer_router_config #=> String
resp.virtual_interface.mtu #=> Integer
resp.virtual_interface.jumbo_frame_capable #=> Boolean
resp.virtual_interface.virtual_gateway_id #=> String
resp.virtual_interface.direct_connect_gateway_id #=> String
resp.virtual_interface.route_filter_prefixes #=> Array
resp.virtual_interface.route_filter_prefixes[0].cidr #=> String
resp.virtual_interface.bgp_peers #=> Array
resp.virtual_interface.bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interface.bgp_peers[0].asn #=> Integer
resp.virtual_interface.bgp_peers[0].auth_key #=> String
resp.virtual_interface.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface.bgp_peers[0].amazon_address #=> String
resp.virtual_interface.bgp_peers[0].customer_address #=> String
resp.virtual_interface.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interface.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interface.bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interface.region #=> String
resp.virtual_interface.aws_device_v2 #=> String
resp.virtual_interface.tags #=> Array
resp.virtual_interface.tags[0].key #=> String
resp.virtual_interface.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (String)

    The ID of the virtual interface.

  • :asn (Integer)

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

  • :customer_address (String)

    The IP address assigned to the customer interface.

  • :bgp_peer_id (String)

    The ID of the BGP peer.

Returns:

See Also:



2391
2392
2393
2394
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2391

def delete_bgp_peer(params = {}, options = {})
  req = build_request(:delete_bgp_peer, params)
  req.send_request(options)
end

#delete_connection(params = {}) ⇒ Types::Connection

Deletes the specified connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp. #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection.

Returns:

See Also:



2458
2459
2460
2461
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2458

def delete_connection(params = {}, options = {})
  req = build_request(:delete_connection, params)
  req.send_request(options)
end

#delete_direct_connect_gateway(params = {}) ⇒ Types::DeleteDirectConnectGatewayResult

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.

Examples:

Request syntax with placeholder values


resp = client.delete_direct_connect_gateway({
  direct_connect_gateway_id: "DirectConnectGatewayId", # required
})

Response structure


resp.direct_connect_gateway.direct_connect_gateway_id #=> String
resp.direct_connect_gateway.direct_connect_gateway_name #=> String
resp.direct_connect_gateway.amazon_side_asn #=> Integer
resp.direct_connect_gateway. #=> String
resp.direct_connect_gateway.direct_connect_gateway_state #=> String, one of "pending", "available", "deleting", "deleted"
resp.direct_connect_gateway.state_change_error #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_id (required, String)

    The ID of the Direct Connect gateway.

Returns:

See Also:



2494
2495
2496
2497
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2494

def delete_direct_connect_gateway(params = {}, options = {})
  req = build_request(:delete_direct_connect_gateway, params)
  req.send_request(options)
end

#delete_direct_connect_gateway_association(params = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationResult

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

Examples:

Request syntax with placeholder values


resp = client.delete_direct_connect_gateway_association({
  association_id: "DirectConnectGatewayAssociationId",
  direct_connect_gateway_id: "DirectConnectGatewayId",
  virtual_gateway_id: "VirtualGatewayId",
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association. #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway. #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :association_id (String)

    The ID of the Direct Connect gateway association.

  • :direct_connect_gateway_id (String)

    The ID of the Direct Connect gateway.

  • :virtual_gateway_id (String)

    The ID of the virtual private gateway.

Returns:

See Also:



2549
2550
2551
2552
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2549

def delete_direct_connect_gateway_association(params = {}, options = {})
  req = build_request(:delete_direct_connect_gateway_association, params)
  req.send_request(options)
end

#delete_direct_connect_gateway_association_proposal(params = {}) ⇒ Types::DeleteDirectConnectGatewayAssociationProposalResult

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

Examples:

Request syntax with placeholder values


resp = client.delete_direct_connect_gateway_association_proposal({
  proposal_id: "DirectConnectGatewayAssociationProposalId", # required
})

Response structure


resp.direct_connect_gateway_association_proposal.proposal_id #=> String
resp.direct_connect_gateway_association_proposal.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association_proposal. #=> String
resp.direct_connect_gateway_association_proposal.proposal_state #=> String, one of "requested", "accepted", "deleted"
resp.direct_connect_gateway_association_proposal.associated_gateway.id #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association_proposal.associated_gateway. #=> String
resp.direct_connect_gateway_association_proposal.associated_gateway.region #=> String
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.existing_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposal.requested_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :proposal_id (required, String)

    The ID of the proposal.

Returns:

See Also:



2589
2590
2591
2592
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2589

def delete_direct_connect_gateway_association_proposal(params = {}, options = {})
  req = build_request(:delete_direct_connect_gateway_association_proposal, params)
  req.send_request(options)
end

#delete_interconnect(params = {}) ⇒ Types::DeleteInterconnectResponse

Deletes the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.delete_interconnect({
  interconnect_id: "InterconnectId", # required
})

Response structure


resp.interconnect_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"

Parameters:

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

    ({})

Options Hash (params):

  • :interconnect_id (required, String)

    The ID of the interconnect.

Returns:

See Also:



2621
2622
2623
2624
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2621

def delete_interconnect(params = {}, options = {})
  req = build_request(:delete_interconnect, params)
  req.send_request(options)
end

#delete_lag(params = {}) ⇒ Types::Lag

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

Examples:

Request syntax with placeholder values


resp = client.delete_lag({
  lag_id: "LagId", # required
})

Response structure


resp.connections_bandwidth #=> String
resp.number_of_connections #=> Integer
resp.lag_id #=> String
resp. #=> String
resp.lag_name #=> String
resp.lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.location #=> String
resp.region #=> String
resp.minimum_links #=> Integer
resp.aws_device #=> String
resp.aws_device_v2 #=> String
resp.connections #=> Array
resp.connections[0]. #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> Boolean
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String
resp.allows_hosted_connections #=> Boolean
resp.jumbo_frame_capable #=> Boolean
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :lag_id (required, String)

    The ID of the LAG.

Returns:

See Also:



2703
2704
2705
2706
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2703

def delete_lag(params = {}, options = {})
  req = build_request(:delete_lag, params)
  req.send_request(options)
end

#delete_virtual_interface(params = {}) ⇒ Types::DeleteVirtualInterfaceResponse

Deletes a virtual interface.

Examples:

Request syntax with placeholder values


resp = client.delete_virtual_interface({
  virtual_interface_id: "VirtualInterfaceId", # required
})

Response structure


resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual interface.

Returns:

See Also:



2731
2732
2733
2734
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2731

def delete_virtual_interface(params = {}, options = {})
  req = build_request(:delete_virtual_interface, params)
  req.send_request(options)
end

#describe_connection_loa(params = {}) ⇒ Types::DescribeConnectionLoaResponse

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for a connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_connection_loa({
  connection_id: "ConnectionId", # required
  provider_name: "ProviderName",
  loa_content_type: "application/pdf", # accepts application/pdf
})

Response structure


resp.loa.loa_content #=> String
resp.loa.loa_content_type #=> String, one of "application/pdf"

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection.

  • :provider_name (String)

    The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

  • :loa_content_type (String)

    The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Returns:

See Also:



2784
2785
2786
2787
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2784

def describe_connection_loa(params = {}, options = {})
  req = build_request(:describe_connection_loa, params)
  req.send_request(options)
end

#describe_connections(params = {}) ⇒ Types::Connections

Displays the specified connection or all connections in this Region.

Examples:

Request syntax with placeholder values


resp = client.describe_connections({
  connection_id: "ConnectionId",
})

Response structure


resp.connections #=> Array
resp.connections[0]. #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> Boolean
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (String)

    The ID of the connection.

Returns:

See Also:



2831
2832
2833
2834
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2831

def describe_connections(params = {}, options = {})
  req = build_request(:describe_connections, params)
  req.send_request(options)
end

#describe_connections_on_interconnect(params = {}) ⇒ Types::Connections

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.describe_connections_on_interconnect({
  interconnect_id: "InterconnectId", # required
})

Response structure


resp.connections #=> Array
resp.connections[0]. #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> Boolean
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :interconnect_id (required, String)

    The ID of the interconnect.

Returns:

See Also:



2885
2886
2887
2888
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2885

def describe_connections_on_interconnect(params = {}, options = {})
  req = build_request(:describe_connections_on_interconnect, params)
  req.send_request(options)
end

#describe_direct_connect_gateway_association_proposals(params = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationProposalsResult

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateway_association_proposals({
  direct_connect_gateway_id: "DirectConnectGatewayId",
  proposal_id: "DirectConnectGatewayAssociationProposalId",
  associated_gateway_id: "AssociatedGatewayId",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.direct_connect_gateway_association_proposals #=> Array
resp.direct_connect_gateway_association_proposals[0].proposal_id #=> String
resp.direct_connect_gateway_association_proposals[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association_proposals[0]. #=> String
resp.direct_connect_gateway_association_proposals[0].proposal_state #=> String, one of "requested", "accepted", "deleted"
resp.direct_connect_gateway_association_proposals[0].associated_gateway.id #=> String
resp.direct_connect_gateway_association_proposals[0].associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association_proposals[0].associated_gateway. #=> String
resp.direct_connect_gateway_association_proposals[0].associated_gateway.region #=> String
resp.direct_connect_gateway_association_proposals[0].existing_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposals[0].existing_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association_proposals[0].requested_allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association_proposals[0].requested_allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_id (String)

    The ID of the Direct Connect gateway.

  • :proposal_id (String)

    The ID of the proposal.

  • :associated_gateway_id (String)

    The ID of the associated gateway.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:



2950
2951
2952
2953
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 2950

def describe_direct_connect_gateway_association_proposals(params = {}, options = {})
  req = build_request(:describe_direct_connect_gateway_association_proposals, params)
  req.send_request(options)
end

#describe_direct_connect_gateway_associations(params = {}) ⇒ Types::DescribeDirectConnectGatewayAssociationsResult

Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateway_associations({
  association_id: "DirectConnectGatewayAssociationId",
  associated_gateway_id: "AssociatedGatewayId",
  direct_connect_gateway_id: "DirectConnectGatewayId",
  max_results: 1,
  next_token: "PaginationToken",
  virtual_gateway_id: "VirtualGatewayId",
})

Response structure


resp.direct_connect_gateway_associations #=> Array
resp.direct_connect_gateway_associations[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateway_associations[0]. #=> String
resp.direct_connect_gateway_associations[0].association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_associations[0].state_change_error #=> String
resp.direct_connect_gateway_associations[0].associated_gateway.id #=> String
resp.direct_connect_gateway_associations[0].associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_associations[0].associated_gateway. #=> String
resp.direct_connect_gateway_associations[0].associated_gateway.region #=> String
resp.direct_connect_gateway_associations[0].association_id #=> String
resp.direct_connect_gateway_associations[0].allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_associations[0].allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_associations[0].virtual_gateway_id #=> String
resp.direct_connect_gateway_associations[0].virtual_gateway_region #=> String
resp.direct_connect_gateway_associations[0]. #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :association_id (String)

    The ID of the Direct Connect gateway association.

  • :associated_gateway_id (String)

    The ID of the associated gateway.

  • :direct_connect_gateway_id (String)

    The ID of the Direct Connect gateway.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • :next_token (String)

    The token provided in the previous call to retrieve the next page.

  • :virtual_gateway_id (String)

    The ID of the virtual private gateway.

Returns:

See Also:



3027
3028
3029
3030
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3027

def describe_direct_connect_gateway_associations(params = {}, options = {})
  req = build_request(:describe_direct_connect_gateway_associations, params)
  req.send_request(options)
end

#describe_direct_connect_gateway_attachments(params = {}) ⇒ Types::DescribeDirectConnectGatewayAttachmentsResult

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateway_attachments({
  direct_connect_gateway_id: "DirectConnectGatewayId",
  virtual_interface_id: "VirtualInterfaceId",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.direct_connect_gateway_attachments #=> Array
resp.direct_connect_gateway_attachments[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateway_attachments[0].virtual_interface_id #=> String
resp.direct_connect_gateway_attachments[0].virtual_interface_region #=> String
resp.direct_connect_gateway_attachments[0]. #=> String
resp.direct_connect_gateway_attachments[0].attachment_state #=> String, one of "attaching", "attached", "detaching", "detached"
resp.direct_connect_gateway_attachments[0].attachment_type #=> String, one of "TransitVirtualInterface", "PrivateVirtualInterface"
resp.direct_connect_gateway_attachments[0].state_change_error #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_id (String)

    The ID of the Direct Connect gateway.

  • :virtual_interface_id (String)

    The ID of the virtual interface.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • :next_token (String)

    The token provided in the previous call to retrieve the next page.

Returns:

See Also:



3088
3089
3090
3091
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3088

def describe_direct_connect_gateway_attachments(params = {}, options = {})
  req = build_request(:describe_direct_connect_gateway_attachments, params)
  req.send_request(options)
end

#describe_direct_connect_gateways(params = {}) ⇒ Types::DescribeDirectConnectGatewaysResult

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

Examples:

Request syntax with placeholder values


resp = client.describe_direct_connect_gateways({
  direct_connect_gateway_id: "DirectConnectGatewayId",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.direct_connect_gateways #=> Array
resp.direct_connect_gateways[0].direct_connect_gateway_id #=> String
resp.direct_connect_gateways[0].direct_connect_gateway_name #=> String
resp.direct_connect_gateways[0].amazon_side_asn #=> Integer
resp.direct_connect_gateways[0]. #=> String
resp.direct_connect_gateways[0].direct_connect_gateway_state #=> String, one of "pending", "available", "deleting", "deleted"
resp.direct_connect_gateways[0].state_change_error #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :direct_connect_gateway_id (String)

    The ID of the Direct Connect gateway.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • :next_token (String)

    The token provided in the previous call to retrieve the next page.

Returns:

See Also:



3138
3139
3140
3141
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3138

def describe_direct_connect_gateways(params = {}, options = {})
  req = build_request(:describe_direct_connect_gateways, params)
  req.send_request(options)
end

#describe_hosted_connections(params = {}) ⇒ Types::Connections

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by AWS Direct Connect Partners only.

Examples:

Request syntax with placeholder values


resp = client.describe_hosted_connections({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connections #=> Array
resp.connections[0]. #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> Boolean
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the interconnect or LAG.

Returns:

See Also:



3190
3191
3192
3193
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3190

def describe_hosted_connections(params = {}, options = {})
  req = build_request(:describe_hosted_connections, params)
  req.send_request(options)
end

#describe_interconnect_loa(params = {}) ⇒ Types::DescribeInterconnectLoaResponse

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for the specified interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_interconnect_loa({
  interconnect_id: "InterconnectId", # required
  provider_name: "ProviderName",
  loa_content_type: "application/pdf", # accepts application/pdf
})

Response structure


resp.loa.loa_content #=> String
resp.loa.loa_content_type #=> String, one of "application/pdf"

Parameters:

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

    ({})

Options Hash (params):

  • :interconnect_id (required, String)

    The ID of the interconnect.

  • :provider_name (String)

    The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

  • :loa_content_type (String)

    The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Returns:

See Also:



3243
3244
3245
3246
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3243

def describe_interconnect_loa(params = {}, options = {})
  req = build_request(:describe_interconnect_loa, params)
  req.send_request(options)
end

#describe_interconnects(params = {}) ⇒ Types::Interconnects

Lists the interconnects owned by the AWS account or only the specified interconnect.

Examples:

Request syntax with placeholder values


resp = client.describe_interconnects({
  interconnect_id: "InterconnectId",
})

Response structure


resp.interconnects #=> Array
resp.interconnects[0].interconnect_id #=> String
resp.interconnects[0].interconnect_name #=> String
resp.interconnects[0].interconnect_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.interconnects[0].region #=> String
resp.interconnects[0].location #=> String
resp.interconnects[0].bandwidth #=> String
resp.interconnects[0].loa_issue_time #=> Time
resp.interconnects[0].lag_id #=> String
resp.interconnects[0].aws_device #=> String
resp.interconnects[0].jumbo_frame_capable #=> Boolean
resp.interconnects[0].aws_device_v2 #=> String
resp.interconnects[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.interconnects[0].tags #=> Array
resp.interconnects[0].tags[0].key #=> String
resp.interconnects[0].tags[0].value #=> String
resp.interconnects[0].provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :interconnect_id (String)

    The ID of the interconnect.

Returns:

See Also:



3288
3289
3290
3291
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3288

def describe_interconnects(params = {}, options = {})
  req = build_request(:describe_interconnects, params)
  req.send_request(options)
end

#describe_lags(params = {}) ⇒ Types::Lags

Describes all your link aggregation groups (LAG) or the specified LAG.

Examples:

Request syntax with placeholder values


resp = client.describe_lags({
  lag_id: "LagId",
})

Response structure


resp.lags #=> Array
resp.lags[0].connections_bandwidth #=> String
resp.lags[0].number_of_connections #=> Integer
resp.lags[0].lag_id #=> String
resp.lags[0]. #=> String
resp.lags[0].lag_name #=> String
resp.lags[0].lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.lags[0].location #=> String
resp.lags[0].region #=> String
resp.lags[0].minimum_links #=> Integer
resp.lags[0].aws_device #=> String
resp.lags[0].aws_device_v2 #=> String
resp.lags[0].connections #=> Array
resp.lags[0].connections[0]. #=> String
resp.lags[0].connections[0].connection_id #=> String
resp.lags[0].connections[0].connection_name #=> String
resp.lags[0].connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.lags[0].connections[0].region #=> String
resp.lags[0].connections[0].location #=> String
resp.lags[0].connections[0].bandwidth #=> String
resp.lags[0].connections[0].vlan #=> Integer
resp.lags[0].connections[0].partner_name #=> String
resp.lags[0].connections[0].loa_issue_time #=> Time
resp.lags[0].connections[0].lag_id #=> String
resp.lags[0].connections[0].aws_device #=> String
resp.lags[0].connections[0].jumbo_frame_capable #=> Boolean
resp.lags[0].connections[0].aws_device_v2 #=> String
resp.lags[0].connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.lags[0].connections[0].tags #=> Array
resp.lags[0].connections[0].tags[0].key #=> String
resp.lags[0].connections[0].tags[0].value #=> String
resp.lags[0].connections[0].provider_name #=> String
resp.lags[0].allows_hosted_connections #=> Boolean
resp.lags[0].jumbo_frame_capable #=> Boolean
resp.lags[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.lags[0].tags #=> Array
resp.lags[0].tags[0].key #=> String
resp.lags[0].tags[0].value #=> String
resp.lags[0].provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :lag_id (String)

    The ID of the LAG.

Returns:

See Also:



3354
3355
3356
3357
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3354

def describe_lags(params = {}, options = {})
  req = build_request(:describe_lags, params)
  req.send_request(options)
end

#describe_loa(params = {}) ⇒ Types::Loa

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_loa({
  connection_id: "ConnectionId", # required
  provider_name: "ProviderName",
  loa_content_type: "application/pdf", # accepts application/pdf
})

Response structure


resp.loa_content #=> String
resp.loa_content_type #=> String, one of "application/pdf"

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of a connection, LAG, or interconnect.

  • :provider_name (String)

    The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

  • :loa_content_type (String)

    The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Returns:

See Also:



3407
3408
3409
3410
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3407

def describe_loa(params = {}, options = {})
  req = build_request(:describe_loa, params)
  req.send_request(options)
end

#describe_locations(params = {}) ⇒ Types::Locations

Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.

Examples:

Response structure


resp.locations #=> Array
resp.locations[0].location_code #=> String
resp.locations[0].location_name #=> String
resp.locations[0].region #=> String
resp.locations[0].available_port_speeds #=> Array
resp.locations[0].available_port_speeds[0] #=> String
resp.locations[0].available_providers #=> Array
resp.locations[0].available_providers[0] #=> String

Parameters:

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

    ({})

Returns:

See Also:



3435
3436
3437
3438
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3435

def describe_locations(params = {}, options = {})
  req = build_request(:describe_locations, params)
  req.send_request(options)
end

#describe_tags(params = {}) ⇒ Types::DescribeTagsResponse

Describes the tags associated with the specified AWS Direct Connect resources.

Examples:

Request syntax with placeholder values


resp = client.describe_tags({
  resource_arns: ["ResourceArn"], # required
})

Response structure


resp.resource_tags #=> Array
resp.resource_tags[0].resource_arn #=> String
resp.resource_tags[0].tags #=> Array
resp.resource_tags[0].tags[0].key #=> String
resp.resource_tags[0].tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arns (required, Array<String>)

    The Amazon Resource Names (ARNs) of the resources.

Returns:

See Also:



3468
3469
3470
3471
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3468

def describe_tags(params = {}, options = {})
  req = build_request(:describe_tags, params)
  req.send_request(options)
end

#describe_virtual_gateways(params = {}) ⇒ Types::VirtualGateways

Lists the virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.

Examples:

Response structure


resp.virtual_gateways #=> Array
resp.virtual_gateways[0].virtual_gateway_id #=> String
resp.virtual_gateways[0].virtual_gateway_state #=> String

Parameters:

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

    ({})

Returns:

See Also:



3492
3493
3494
3495
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3492

def describe_virtual_gateways(params = {}, options = {})
  req = build_request(:describe_virtual_gateways, params)
  req.send_request(options)
end

#describe_virtual_interfaces(params = {}) ⇒ Types::VirtualInterfaces

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network.

Examples:

Request syntax with placeholder values


resp = client.describe_virtual_interfaces({
  connection_id: "ConnectionId",
  virtual_interface_id: "VirtualInterfaceId",
})

Response structure


resp.virtual_interfaces #=> Array
resp.virtual_interfaces[0]. #=> String
resp.virtual_interfaces[0].virtual_interface_id #=> String
resp.virtual_interfaces[0].location #=> String
resp.virtual_interfaces[0].connection_id #=> String
resp.virtual_interfaces[0].virtual_interface_type #=> String
resp.virtual_interfaces[0].virtual_interface_name #=> String
resp.virtual_interfaces[0].vlan #=> Integer
resp.virtual_interfaces[0].asn #=> Integer
resp.virtual_interfaces[0].amazon_side_asn #=> Integer
resp.virtual_interfaces[0].auth_key #=> String
resp.virtual_interfaces[0].amazon_address #=> String
resp.virtual_interfaces[0].customer_address #=> String
resp.virtual_interfaces[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interfaces[0].virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.virtual_interfaces[0].customer_router_config #=> String
resp.virtual_interfaces[0].mtu #=> Integer
resp.virtual_interfaces[0].jumbo_frame_capable #=> Boolean
resp.virtual_interfaces[0].virtual_gateway_id #=> String
resp.virtual_interfaces[0].direct_connect_gateway_id #=> String
resp.virtual_interfaces[0].route_filter_prefixes #=> Array
resp.virtual_interfaces[0].route_filter_prefixes[0].cidr #=> String
resp.virtual_interfaces[0].bgp_peers #=> Array
resp.virtual_interfaces[0].bgp_peers[0].bgp_peer_id #=> String
resp.virtual_interfaces[0].bgp_peers[0].asn #=> Integer
resp.virtual_interfaces[0].bgp_peers[0].auth_key #=> String
resp.virtual_interfaces[0].bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interfaces[0].bgp_peers[0].amazon_address #=> String
resp.virtual_interfaces[0].bgp_peers[0].customer_address #=> String
resp.virtual_interfaces[0].bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.virtual_interfaces[0].bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.virtual_interfaces[0].bgp_peers[0].aws_device_v2 #=> String
resp.virtual_interfaces[0].region #=> String
resp.virtual_interfaces[0].aws_device_v2 #=> String
resp.virtual_interfaces[0].tags #=> Array
resp.virtual_interfaces[0].tags[0].key #=> String
resp.virtual_interfaces[0].tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (String)

    The ID of the connection.

  • :virtual_interface_id (String)

    The ID of the virtual interface.

Returns:

See Also:



3567
3568
3569
3570
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3567

def describe_virtual_interfaces(params = {}, options = {})
  req = build_request(:describe_virtual_interfaces, params)
  req.send_request(options)
end

#disassociate_connection_from_lag(params = {}) ⇒ Types::Connection

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

Examples:

Request syntax with placeholder values


resp = client.disassociate_connection_from_lag({
  connection_id: "ConnectionId", # required
  lag_id: "LagId", # required
})

Response structure


resp. #=> String
resp.connection_id #=> String
resp.connection_name #=> String
resp.connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.region #=> String
resp.location #=> String
resp.bandwidth #=> String
resp.vlan #=> Integer
resp.partner_name #=> String
resp.loa_issue_time #=> Time
resp.lag_id #=> String
resp.aws_device #=> String
resp.jumbo_frame_capable #=> Boolean
resp.aws_device_v2 #=> String
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String)

    The ID of the connection.

  • :lag_id (required, String)

    The ID of the LAG.

Returns:

See Also:



3645
3646
3647
3648
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3645

def disassociate_connection_from_lag(params = {}, options = {})
  req = build_request(:disassociate_connection_from_lag, params)
  req.send_request(options)
end

#list_virtual_interface_test_history(params = {}) ⇒ Types::ListVirtualInterfaceTestHistoryResponse

Lists the virtual interface failover test history.

Examples:

Request syntax with placeholder values


resp = client.list_virtual_interface_test_history({
  test_id: "TestId",
  virtual_interface_id: "VirtualInterfaceId",
  bgp_peers: ["BGPPeerId"],
  status: "FailureTestHistoryStatus",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.virtual_interface_test_history #=> Array
resp.virtual_interface_test_history[0].test_id #=> String
resp.virtual_interface_test_history[0].virtual_interface_id #=> String
resp.virtual_interface_test_history[0].bgp_peers #=> Array
resp.virtual_interface_test_history[0].bgp_peers[0] #=> String
resp.virtual_interface_test_history[0].status #=> String
resp.virtual_interface_test_history[0]. #=> String
resp.virtual_interface_test_history[0].test_duration_in_minutes #=> Integer
resp.virtual_interface_test_history[0].start_time #=> Time
resp.virtual_interface_test_history[0].end_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :test_id (String)

    The ID of the virtual interface failover test.

  • :virtual_interface_id (String)

    The ID of the virtual interface that was tested.

  • :bgp_peers (Array<String>)

    The BGP peers that were placed in the DOWN state during the virtual interface failover test.

  • :status (String)

    The status of the virtual interface failover test.

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:



3710
3711
3712
3713
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3710

def list_virtual_interface_test_history(params = {}, options = {})
  req = build_request(:list_virtual_interface_test_history, params)
  req.send_request(options)
end

#start_bgp_failover_test(params = {}) ⇒ Types::StartBgpFailoverTestResponse

Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

Examples:

Request syntax with placeholder values


resp = client.start_bgp_failover_test({
  virtual_interface_id: "VirtualInterfaceId", # required
  bgp_peers: ["BGPPeerId"],
  test_duration_in_minutes: 1,
})

Response structure


resp.virtual_interface_test.test_id #=> String
resp.virtual_interface_test.virtual_interface_id #=> String
resp.virtual_interface_test.bgp_peers #=> Array
resp.virtual_interface_test.bgp_peers[0] #=> String
resp.virtual_interface_test.status #=> String
resp.virtual_interface_test. #=> String
resp.virtual_interface_test.test_duration_in_minutes #=> Integer
resp.virtual_interface_test.start_time #=> Time
resp.virtual_interface_test.end_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual interface you want to test.

  • :bgp_peers (Array<String>)

    The BGP peers to place in the DOWN state.

  • :test_duration_in_minutes (Integer)

    The time in minutes that the virtual interface failover test will last.

    Maximum value: 180 minutes (3 hours).

    Default: 180 minutes (3 hours).

Returns:

See Also:



3776
3777
3778
3779
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3776

def start_bgp_failover_test(params = {}, options = {})
  req = build_request(:start_bgp_failover_test, params)
  req.send_request(options)
end

#stop_bgp_failover_test(params = {}) ⇒ Types::StopBgpFailoverTestResponse

Stops the virtual interface failover test.

Examples:

Request syntax with placeholder values


resp = client.stop_bgp_failover_test({
  virtual_interface_id: "VirtualInterfaceId", # required
})

Response structure


resp.virtual_interface_test.test_id #=> String
resp.virtual_interface_test.virtual_interface_id #=> String
resp.virtual_interface_test.bgp_peers #=> Array
resp.virtual_interface_test.bgp_peers[0] #=> String
resp.virtual_interface_test.status #=> String
resp.virtual_interface_test. #=> String
resp.virtual_interface_test.test_duration_in_minutes #=> Integer
resp.virtual_interface_test.start_time #=> Time
resp.virtual_interface_test.end_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual interface you no longer want to test.

Returns:

See Also:



3812
3813
3814
3815
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3812

def stop_bgp_failover_test(params = {}, options = {})
  req = build_request(:stop_bgp_failover_test, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified AWS Direct Connect resource. Each resource can have a maximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Array<Types::Tag>)

    The tags to add.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3848
3849
3850
3851
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3848

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified AWS Direct Connect resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>)

    The tag keys of the tags to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3875
3876
3877
3878
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3875

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_direct_connect_gateway_association(params = {}) ⇒ Types::UpdateDirectConnectGatewayAssociationResult

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

Examples:

Request syntax with placeholder values


resp = client.update_direct_connect_gateway_association({
  association_id: "DirectConnectGatewayAssociationId",
  add_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
  remove_allowed_prefixes_to_direct_connect_gateway: [
    {
      cidr: "CIDR",
    },
  ],
})

Response structure


resp.direct_connect_gateway_association.direct_connect_gateway_id #=> String
resp.direct_connect_gateway_association. #=> String
resp.direct_connect_gateway_association.association_state #=> String, one of "associating", "associated", "disassociating", "disassociated", "updating"
resp.direct_connect_gateway_association.state_change_error #=> String
resp.direct_connect_gateway_association.associated_gateway.id #=> String
resp.direct_connect_gateway_association.associated_gateway.type #=> String, one of "virtualPrivateGateway", "transitGateway"
resp.direct_connect_gateway_association.associated_gateway. #=> String
resp.direct_connect_gateway_association.associated_gateway.region #=> String
resp.direct_connect_gateway_association.association_id #=> String
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway #=> Array
resp.direct_connect_gateway_association.allowed_prefixes_to_direct_connect_gateway[0].cidr #=> String
resp.direct_connect_gateway_association.virtual_gateway_id #=> String
resp.direct_connect_gateway_association.virtual_gateway_region #=> String
resp.direct_connect_gateway_association. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :association_id (String)

    The ID of the Direct Connect gateway association.

  • :add_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>)

    The Amazon VPC prefixes to advertise to the Direct Connect gateway.

  • :remove_allowed_prefixes_to_direct_connect_gateway (Array<Types::RouteFilterPrefix>)

    The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

Returns:

See Also:



3936
3937
3938
3939
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 3936

def update_direct_connect_gateway_association(params = {}, options = {})
  req = build_request(:update_direct_connect_gateway_association, params)
  req.send_request(options)
end

#update_lag(params = {}) ⇒ Types::Lag

Updates the attributes of the specified link aggregation group (LAG).

You can update the following attributes:

  • The name of the LAG.

  • The value for the minimum number of connections that must be operational for the LAG itself to be operational.

When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections.

Examples:

Request syntax with placeholder values


resp = client.update_lag({
  lag_id: "LagId", # required
  lag_name: "LagName",
  minimum_links: 1,
})

Response structure


resp.connections_bandwidth #=> String
resp.number_of_connections #=> Integer
resp.lag_id #=> String
resp. #=> String
resp.lag_name #=> String
resp.lag_state #=> String, one of "requested", "pending", "available", "down", "deleting", "deleted", "unknown"
resp.location #=> String
resp.region #=> String
resp.minimum_links #=> Integer
resp.aws_device #=> String
resp.aws_device_v2 #=> String
resp.connections #=> Array
resp.connections[0]. #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_name #=> String
resp.connections[0].connection_state #=> String, one of "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.connections[0].region #=> String
resp.connections[0].location #=> String
resp.connections[0].bandwidth #=> String
resp.connections[0].vlan #=> Integer
resp.connections[0].partner_name #=> String
resp.connections[0].loa_issue_time #=> Time
resp.connections[0].lag_id #=> String
resp.connections[0].aws_device #=> String
resp.connections[0].jumbo_frame_capable #=> Boolean
resp.connections[0].aws_device_v2 #=> String
resp.connections[0].has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[0].tags[0].value #=> String
resp.connections[0].provider_name #=> String
resp.allows_hosted_connections #=> Boolean
resp.jumbo_frame_capable #=> Boolean
resp.has_logical_redundancy #=> String, one of "unknown", "yes", "no"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.provider_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :lag_id (required, String)

    The ID of the LAG.

  • :lag_name (String)

    The name of the LAG.

  • :minimum_links (Integer)

    The minimum number of physical connections that must be operational for the LAG itself to be operational.

Returns:

See Also:



4041
4042
4043
4044
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 4041

def update_lag(params = {}, options = {})
  req = build_request(:update_lag, params)
  req.send_request(options)
end

#update_virtual_interface_attributes(params = {}) ⇒ Types::VirtualInterface

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces.

Examples:

Request syntax with placeholder values


resp = client.update_virtual_interface_attributes({
  virtual_interface_id: "VirtualInterfaceId", # required
  mtu: 1,
})

Response structure


resp. #=> String
resp.virtual_interface_id #=> String
resp.location #=> String
resp.connection_id #=> String
resp.virtual_interface_type #=> String
resp.virtual_interface_name #=> String
resp.vlan #=> Integer
resp.asn #=> Integer
resp.amazon_side_asn #=> Integer
resp.auth_key #=> String
resp.amazon_address #=> String
resp.customer_address #=> String
resp.address_family #=> String, one of "ipv4", "ipv6"
resp.virtual_interface_state #=> String, one of "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected", "unknown"
resp.customer_router_config #=> String
resp.mtu #=> Integer
resp.jumbo_frame_capable #=> Boolean
resp.virtual_gateway_id #=> String
resp.direct_connect_gateway_id #=> String
resp.route_filter_prefixes #=> Array
resp.route_filter_prefixes[0].cidr #=> String
resp.bgp_peers #=> Array
resp.bgp_peers[0].bgp_peer_id #=> String
resp.bgp_peers[0].asn #=> Integer
resp.bgp_peers[0].auth_key #=> String
resp.bgp_peers[0].address_family #=> String, one of "ipv4", "ipv6"
resp.bgp_peers[0].amazon_address #=> String
resp.bgp_peers[0].customer_address #=> String
resp.bgp_peers[0].bgp_peer_state #=> String, one of "verifying", "pending", "available", "deleting", "deleted"
resp.bgp_peers[0].bgp_status #=> String, one of "up", "down", "unknown"
resp.bgp_peers[0].aws_device_v2 #=> String
resp.region #=> String
resp.aws_device_v2 #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :virtual_interface_id (required, String)

    The ID of the virtual private interface.

  • :mtu (Integer)

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

Returns:

See Also:



4142
4143
4144
4145
# File 'gems/aws-sdk-directconnect/lib/aws-sdk-directconnect/client.rb', line 4142

def update_virtual_interface_attributes(params = {}, options = {})
  req = build_request(:update_virtual_interface_attributes, params)
  req.send_request(options)
end