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	awscc.iotwireless.network_analyzer_configurations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string	Name of the network analyzer configuration
region	string	AWS region.

For more information, see AWS::IoTWireless::NetworkAnalyzerConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	network_analyzer_configurations	INSERT	Name, region
delete_resource	network_analyzer_configurations	DELETE	Identifier, region
update_resource	network_analyzer_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	network_analyzer_configurations_list_only	SELECT	region
get_resource	network_analyzer_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual network_analyzer_configuration.

SELECT
  region,
  name,
  description,
  trace_content,
  wireless_devices,
  wireless_gateways,
  arn,
  tags
FROM awscc.iotwireless.network_analyzer_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all network_analyzer_configurations in a region.

SELECT
  region,
  name
FROM awscc.iotwireless.network_analyzer_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.iotwireless.network_analyzer_configurations (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iotwireless.network_analyzer_configurations (
  Name,
  Description,
  TraceContent,
  WirelessDevices,
  WirelessGateways,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ trace_content }}',
  '{{ wireless_devices }}',
  '{{ wireless_gateways }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: trace_content
      value:
        wireless_device_frame_info: '{{ wireless_device_frame_info }}'
        log_level: '{{ log_level }}'
    - name: wireless_devices
      value:
        - '{{ wireless_devices[0] }}'
    - name: wireless_gateways
      value:
        - '{{ wireless_gateways[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotwireless.network_analyzer_configurations
SET PatchDocument = string('{{ {
    "Description": description,
    "TraceContent": trace_content,
    "WirelessDevices": wireless_devices,
    "WirelessGateways": wireless_gateways,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iotwireless.network_analyzer_configurations
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

iotwireless:CreateNetworkAnalyzerConfiguration,
iotwireless:TagResource

Read

iotwireless:GetNetworkAnalyzerConfiguration,
iotwireless:ListTagsForResource

Update

iotwireless:UpdateNetworkAnalyzerConfiguration,
iotwireless:GetNetworkAnalyzerConfiguration,
iotwireless:TagResource,
iotwireless:UntagResource

Delete

iotwireless:DeleteNetworkAnalyzerConfiguration

List

iotwireless:ListNetworkAnalyzerConfigurations,
iotwireless:ListTagsForResource