network_analyzer_configurations

Creates, updates, deletes or gets a network_analyzer_configuration resource or lists network_analyzer_configurations in a region

Overview

Name	network_analyzer_configurations
Type	Resource
Description	Create and manage NetworkAnalyzerConfiguration resource.
Id	aws.iotwireless.network_analyzer_configurations

Fields

Name	Datatype	Description
name	string	Name of the network analyzer configuration
description	string	The description of the new resource
trace_content	object	Trace content for your wireless gateway and wireless device resources
wireless_devices	array	List of wireless gateway resources that have been added to the network analyzer configuration
wireless_gateways	array	List of wireless gateway resources that have been added to the network analyzer configuration
arn	string	Arn for network analyzer configuration, Returned upon successful create.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all network_analyzer_configurations in a region.

SELECT
region,
name,
description,
trace_content,
wireless_devices,
wireless_gateways,
arn,
tags
FROM aws.iotwireless.network_analyzer_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual network_analyzer_configuration.

SELECT
region,
name,
description,
trace_content,
wireless_devices,
wireless_gateways,
arn,
tags
FROM aws.iotwireless.network_analyzer_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new network_analyzer_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iotwireless.network_analyzer_configurations (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotwireless.network_analyzer_configurations (
 Name,
 Description,
 TraceContent,
 WirelessDevices,
 WirelessGateways,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ TraceContent }}',
 '{{ WirelessDevices }}',
 '{{ WirelessGateways }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: network_analyzer_configuration
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: TraceContent
        value:
          WirelessDeviceFrameInfo: '{{ WirelessDeviceFrameInfo }}'
          LogLevel: '{{ LogLevel }}'
      - name: WirelessDevices
        value:
          - '{{ WirelessDevices[0] }}'
      - name: WirelessGateways
        value:
          - '{{ WirelessGateways[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotwireless.network_analyzer_configurations
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the network_analyzer_configurations resource, the following permissions are required:

Create

iotwireless:CreateNetworkAnalyzerConfiguration,
iotwireless:TagResource,
iotwireless:ListTagsForResource

Read

iotwireless:GetNetworkAnalyzerConfiguration,
iotwireless:ListTagsForResource

Update

iotwireless:UpdateNetworkAnalyzerConfiguration,
iotwireless:UntagResource,
iotwireless:ListTagsForResource

Delete

iotwireless:DeleteNetworkAnalyzerConfiguration

List

iotwireless:ListNetworkAnalyzerConfigurations,
iotwireless:ListTagsForResource