device_profiles

Creates, updates, deletes or gets a device_profile resource or lists device_profiles in a region

Overview

Name	device_profiles
Type	Resource
Description	Device Profile's resource schema demonstrating some basic constructs and validation rules.
Id	aws.iotwireless.device_profiles

Fields

Name	Datatype	Description
name	string	Name of service profile
lo_ra_wan	object	LoRaWANDeviceProfile supports all LoRa specific attributes for service profile for CreateDeviceProfile operation
tags	array	A list of key-value pairs that contain metadata for the device profile.
arn	string	Service profile Arn. Returned after successful create.
id	string	Service profile Id. Returned after successful create.
region	string	AWS region.

Methods

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

SELECT examples

Gets all device_profiles in a region.

SELECT
region,
name,
lo_ra_wan,
tags,
arn,
id
FROM aws.iotwireless.device_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual device_profile.

SELECT
region,
name,
lo_ra_wan,
tags,
arn,
id
FROM aws.iotwireless.device_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: device_profile
    props:
      - name: Name
        value: '{{ Name }}'
      - name: LoRaWAN
        value:
          SupportsClassB: '{{ SupportsClassB }}'
          ClassBTimeout: '{{ ClassBTimeout }}'
          PingSlotPeriod: '{{ PingSlotPeriod }}'
          PingSlotDr: '{{ PingSlotDr }}'
          PingSlotFreq: '{{ PingSlotFreq }}'
          SupportsClassC: '{{ SupportsClassC }}'
          ClassCTimeout: '{{ ClassCTimeout }}'
          MacVersion: '{{ MacVersion }}'
          RegParamsRevision: '{{ RegParamsRevision }}'
          RxDelay1: '{{ RxDelay1 }}'
          RxDrOffset1: '{{ RxDrOffset1 }}'
          RxFreq2: '{{ RxFreq2 }}'
          RxDataRate2: '{{ RxDataRate2 }}'
          FactoryPresetFreqsList:
            - '{{ FactoryPresetFreqsList[0] }}'
          MaxEirp: '{{ MaxEirp }}'
          MaxDutyCycle: '{{ MaxDutyCycle }}'
          SupportsJoin: '{{ SupportsJoin }}'
          RfRegion: '{{ RfRegion }}'
          Supports32BitFCnt: '{{ Supports32BitFCnt }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

iotwireless:CreateDeviceProfile,
iotwireless:TagResource,
iotwireless:ListTagsForResource

Read

iotwireless:GetDeviceProfile,
iotwireless:ListTagsForResource

Delete

iotwireless:DeleteDeviceProfile

List

iotwireless:ListDeviceProfiles,
iotwireless:ListTagsForResource