network_resource_relationships

Creates, updates, deletes, gets or lists a network_resource_relationships resource.

Overview

Name	network_resource_relationships
Type	Resource
Id	aws.networkmanager.network_resource_relationships

Fields

The following fields are returned by SELECT queries:

get_network_resource_relationships

Name	Datatype	Description
from	string	The ARN of the resource. (pattern: <code>[\s\S]*</code>)
to	string	The ARN of the resource. (pattern: <code>[\s\S]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_resource_relationships	select	global_network_id, region	coreNetworkId, registeredGatewayArn, awsRegion, accountId, resourceType, resourceArn, maxResults, nextToken	Gets the network resource relationships for the specified global network.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
global_network_id	string	The ID of the global network.
region	string	AWS region (default: us-east-1)
accountId	string	The Amazon Web Services account ID.
awsRegion	string	The Amazon Web Services Region.
coreNetworkId	string	The ID of a core network.
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.
registeredGatewayArn	string	The ARN of the registered gateway.
resourceArn	string	The ARN of the gateway.
resourceType	string	The resource type. The following are the supported resource types for Direct Connect: dxcon dx-gateway dx-vif The following are the supported resource types for Network Manager: attachment connect-peer connection core-network device link peering site The following are the supported resource types for Amazon VPC: customer-gateway transit-gateway transit-gateway-attachment transit-gateway-connect-peer transit-gateway-route-table vpn-connection

SELECT examples

get_network_resource_relationships

Gets the network resource relationships for the specified global network.

SELECT
from,
to
FROM aws.networkmanager.network_resource_relationships
WHERE global_network_id = '{{ global_network_id }}' -- required
AND region = '{{ region }}' -- required
AND coreNetworkId = '{{ coreNetworkId }}'
AND registeredGatewayArn = '{{ registeredGatewayArn }}'
AND awsRegion = '{{ awsRegion }}'
AND accountId = '{{ accountId }}'
AND resourceType = '{{ resourceType }}'
AND resourceArn = '{{ resourceArn }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;