network_telemetries

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

Overview

Name	network_telemetries
Type	Resource
Id	aws.networkmanager.network_telemetries

Fields

The following fields are returned by SELECT queries:

get_network_telemetry

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID. (pattern: <code>[\s\S]*</code>)
address	string	The address. (pattern: <code>[\s\S]*</code>)
aws_region	string	The Amazon Web Services Region. (pattern: <code>[\s\S]*</code>)
core_network_id	string	The ID of a core network. (pattern: <code>^core-network-([0-9a-f]{8,17})$</code>)
health	object	The connection health.
registered_gateway_arn	string	The ARN of the gateway. (pattern: <code>[\s\S]*</code>)
resource_arn	string	The ARN of the resource. (pattern: <code>[\s\S]*</code>)
resource_id	string	The ID of the resource. (pattern: <code>[\s\S]*</code>)
resource_type	string	The resource type. (pattern: <code>[\s\S]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_telemetry	select	global_network_id, region	coreNetworkId, registeredGatewayArn, awsRegion, accountId, resourceType, resourceArn, maxResults, nextToken	Gets the network telemetry of 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 gateway.
resourceArn	string	The ARN of the resource.
resourceType	string	The resource type. The following are the supported resource types: connect-peer transit-gateway-connect-peer vpn-connection

SELECT examples

get_network_telemetry

Gets the network telemetry of the specified global network.

SELECT
account_id,
address,
aws_region,
core_network_id,
health,
registered_gateway_arn,
resource_arn,
resource_id,
resource_type
FROM aws.networkmanager.network_telemetries
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 }}'
;