Method: Aws::NetworkManager::Client#register_transit_gateway

Defined in:

lib/aws-sdk-networkmanager/client.rb

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

Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see [Region Availability] in the *Amazon Web Services Transit Gateways for Global Networks User Guide*. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.

[1]: docs.aws.amazon.com/network-manager/latest/tgwnm/what-are-global-networks.html#nm-available-regions

Examples:

Request syntax with placeholder values

resp = client.register_transit_gateway({
  global_network_id: "GlobalNetworkId", # required
  transit_gateway_arn: "TransitGatewayArn", # required
})

Response structure

resp.transit_gateway_registration.global_network_id #=> String
resp.transit_gateway_registration.transit_gateway_arn #=> String
resp.transit_gateway_registration.state.code #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED", "FAILED"
resp.transit_gateway_registration.state.message #=> String

Parameters:

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

  ({})

Options Hash (params):

• :global_network_id (required, String) —

  The ID of the global network.

• :transit_gateway_arn (required, String) —

  The Amazon Resource Name (ARN) of the transit gateway.

Returns:

• (Types::RegisterTransitGatewayResponse) —

  Returns a response object which responds to the following methods:

  • #transit_gateway_registration => Types::TransitGatewayRegistration

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-networkmanager/client.rb', line 4862

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