A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/NetworkManager/Client.html below:

Client — AWS SDK for Ruby V2

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

Class: Aws::NetworkManager::Client Overview

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

networkmanager = Aws::NetworkManager::Client.new(
  region: region_name,
  credentials: credentials,
  )

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

Region

You can configure a default region in the following locations:

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

creds = YAML.load(File.read('/path/to/secrets'))

Aws::NetworkManager::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse Instance Attribute Summary Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse API Operations collapse Instance Method Summary collapse Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Instance Method Details #associate_customer_gateway(options = {}) ⇒ Types::AssociateCustomerGatewayResponse

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

#associate_link(options = {}) ⇒ Types::AssociateLinkResponse

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

#create_device(options = {}) ⇒ Types::CreateDeviceResponse

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

#delete_device(options = {}) ⇒ Types::DeleteDeviceResponse

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

#delete_global_network(options = {}) ⇒ Types::DeleteGlobalNetworkResponse

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.

#delete_link(options = {}) ⇒ Types::DeleteLinkResponse

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

#delete_site(options = {}) ⇒ Types::DeleteSiteResponse

Deletes an existing site. The site cannot be associated with any device or link.

#deregister_transit_gateway(options = {}) ⇒ Types::DeregisterTransitGatewayResponse

Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

#describe_global_networks(options = {}) ⇒ Types::DescribeGlobalNetworksResponse

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

#disassociate_link(options = {}) ⇒ Types::DisassociateLinkResponse

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

#get_devices(options = {}) ⇒ Types::GetDevicesResponse

Gets information about one or more of your devices in a global network.

#get_link_associations(options = {}) ⇒ Types::GetLinkAssociationsResponse

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

#get_links(options = {}) ⇒ Types::GetLinksResponse

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

#get_sites(options = {}) ⇒ Types::GetSitesResponse

Gets information about one or more of your sites in a global network.

#register_transit_gateway(options = {}) ⇒ Types::RegisterTransitGatewayResponse

Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.

#tag_resource(options = {}) ⇒ Struct

Tags a specified resource.

#untag_resource(options = {}) ⇒ Struct

Removes tags from a specified resource.

#update_device(options = {}) ⇒ Types::UpdateDeviceResponse

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

#update_global_network(options = {}) ⇒ Types::UpdateGlobalNetworkResponse

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

#update_link(options = {}) ⇒ Types::UpdateLinkResponse

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

#update_site(options = {}) ⇒ Types::UpdateSiteResponse

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end
Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end
Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end
#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4