wireless_gateways

Creates, updates, deletes or gets a wireless_gateway resource or lists wireless_gateways in a region

Overview

Name	wireless_gateways
Type	Resource
Description	Create and manage wireless gateways, including LoRa gateways.
Id	awscc.iotwireless.wireless_gateways

Fields

get (all properties)

Name	Datatype	Description
name	string	Name of Wireless Gateway.
description	string	Description of Wireless Gateway.
▶tags	array	A list of key-value pairs that contain metadata for the gateway.
▶lo_ra_wan	object	The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway.
arn	string	Arn for Wireless Gateway. Returned upon successful create.
id	string	Id for Wireless Gateway. Returned upon successful create.
thing_arn	string	Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway.
thing_name	string	Thing Name. If there is a Thing created, this can be returned with a Get call.
last_uplink_received_at	string	The date and time when the most recent uplink was received.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	Id for Wireless Gateway. Returned upon successful create.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	wireless_gateways	INSERT	LoRaWAN, region
delete_resource	wireless_gateways	DELETE	Identifier, region
update_resource	wireless_gateways	UPDATE	Identifier, PatchDocument, region
list_resources	wireless_gateways_list_only	SELECT	region
get_resource	wireless_gateways	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual wireless_gateway.

SELECT
  region,
  name,
  description,
  tags,
  lo_ra_wan,
  arn,
  id,
  thing_arn,
  thing_name,
  last_uplink_received_at
FROM awscc.iotwireless.wireless_gateways
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all wireless_gateways in a region.

SELECT
  region,
  id
FROM awscc.iotwireless.wireless_gateways_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iotwireless.wireless_gateways (
  LoRaWAN,
  region
)
SELECT
  '{{ lo_ra_wan }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iotwireless.wireless_gateways (
  Name,
  Description,
  Tags,
  LoRaWAN,
  ThingArn,
  ThingName,
  LastUplinkReceivedAt,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ lo_ra_wan }}',
  '{{ thing_arn }}',
  '{{ thing_name }}',
  '{{ last_uplink_received_at }}',
  '{{ 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: wireless_gateway
  props:
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: lo_ra_wan
      value:
        gateway_eui: '{{ gateway_eui }}'
        rf_region: '{{ rf_region }}'
    - name: thing_arn
      value: '{{ thing_arn }}'
    - name: thing_name
      value: '{{ thing_name }}'
    - name: last_uplink_received_at
      value: '{{ last_uplink_received_at }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotwireless.wireless_gateways
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "Tags": tags,
    "LoRaWAN": lo_ra_wan,
    "ThingArn": thing_arn,
    "ThingName": thing_name,
    "LastUplinkReceivedAt": last_uplink_received_at
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iotwireless.wireless_gateways
WHERE
  Identifier = '{{ id }}' 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 wireless_gateways resource, the following permissions are required:

Create

iotwireless:CreateWirelessGateway,
iotwireless:TagResource

Read

iotwireless:GetWirelessGateway,
iotwireless:ListTagsForResource

Update

iotwireless:GetWirelessGateway,
iotwireless:UpdateWirelessGateway,
iotwireless:AssociateWirelessGatewayWithThing,
iotwireless:TagResource,
iotwireless:UntagResource

Delete

iotwireless:DeleteWirelessGateway,
iotwireless:DisassociateWirelessGatewayFromThing

List

iotwireless:ListWirelessGateways,
iotwireless:ListTagsForResource