Skip to main content

aws_network_performance_datas

Creates, updates, deletes, gets or lists an aws_network_performance_datas resource.

Overview

Nameaws_network_performance_datas
TypeResource
Idaws.ec2.aws_network_performance_datas

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
destinationstringThe Region or Availability Zone that's the destination for the data query. For example, eu-west-1.
idstringThe ID passed in the DataQuery.
metricstringThe metric used for the network performance request.
metric_pointsstringA list of MetricPoint objects.
periodstringThe period used for the network performance request.
sourcestringThe Region or Availability Zone that's the source for the data query. For example, us-east-1.
statisticstringThe statistic used for the network performance request.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_aws_network_performance_dataselectregionDataQuery, StartTime, EndTime, MaxResults, NextToken, DryRunGets network performance data.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
DataQueryarrayA list of network performance data queries.
DryRunbooleanChecks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
EndTimestring (date-time)The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.
MaxResultsintegerThe maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextTokenstringThe token for the next page of results.
StartTimestring (date-time)The starting time for the performance data request. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.

SELECT examples

Gets network performance data.

SELECT
destination,
id,
metric,
metric_points,
period,
source,
statistic
FROM aws.ec2.aws_network_performance_datas
WHERE region = '{{ region }}' -- required
AND DataQuery = '{{ DataQuery }}'
AND StartTime = '{{ StartTime }}'
AND EndTime = '{{ EndTime }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;