gateways

Creates, updates, deletes or gets a gateway resource or lists gateways in a region

Overview

Name	gateways
Type	Resource
Description	Resource schema for AWS::IoTSiteWise::Gateway
Id	aws.iotsitewise.gateways

Fields

Name	Datatype	Description
gateway_name	string	A unique, friendly name for the gateway.
gateway_platform	object	The gateway's platform. You can only specify one platform in a gateway.
tags	array	A list of key-value pairs that contain metadata for the gateway.
gateway_id	string	The ID of the gateway device.
gateway_capability_summaries	array	A list of gateway capability summaries that each contain a namespace and status.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GatewayName, GatewayPlatform, 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 gateways in a region.

SELECT
region,
gateway_name,
gateway_platform,
tags,
gateway_id,
gateway_capability_summaries
FROM aws.iotsitewise.gateways
WHERE region = 'us-east-1';

Gets all properties from an individual gateway.

SELECT
region,
gateway_name,
gateway_platform,
tags,
gateway_id,
gateway_capability_summaries
FROM aws.iotsitewise.gateways
WHERE region = 'us-east-1' AND data__Identifier = '<GatewayId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iotsitewise.gateways (
 GatewayName,
 GatewayPlatform,
 region
)
SELECT 
'{{ GatewayName }}',
 '{{ GatewayPlatform }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotsitewise.gateways (
 GatewayName,
 GatewayPlatform,
 Tags,
 GatewayCapabilitySummaries,
 region
)
SELECT 
 '{{ GatewayName }}',
 '{{ GatewayPlatform }}',
 '{{ Tags }}',
 '{{ GatewayCapabilitySummaries }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: gateway
    props:
      - name: GatewayName
        value: '{{ GatewayName }}'
      - name: GatewayPlatform
        value:
          Greengrass:
            GroupArn: '{{ GroupArn }}'
          GreengrassV2:
            CoreDeviceThingName: '{{ CoreDeviceThingName }}'
          SiemensIE:
            IotCoreThingName: '{{ IotCoreThingName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: GatewayCapabilitySummaries
        value:
          - CapabilityNamespace: '{{ CapabilityNamespace }}'
            CapabilityConfiguration: '{{ CapabilityConfiguration }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotsitewise.gateways
WHERE data__Identifier = '<GatewayId>'
AND region = 'us-east-1';

Permissions

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

Create

iotsitewise:CreateGateway,
iotsitewise:DescribeGateway,
iotsitewise:DescribeGatewayCapabilityConfiguration,
iotsitewise:UpdateGatewayCapabilityConfiguration,
iam:PassRole,
iam:GetRole,
greengrass:GetCoreDevice,
iotsitewise:ListTagsForResource,
iotsitewise:TagResource,
iot:DescribeThing

Read

iotsitewise:DescribeGateway,
iotsitewise:DescribeGatewayCapabilityConfiguration,
iotsitewise:ListTagsForResource

Update

iotsitewise:UpdateGateway,
iotsitewise:UpdateGatewayCapabilityConfiguration,
iotsitewise:TagResource,
iotsitewise:UntagResource,
iotsitewise:DescribeGateway,
iotsitewise:DescribeGatewayCapabilityConfiguration,
iotsitewise:ListTagsForResource

Delete

iotsitewise:DescribeGateway,
iotsitewise:DescribeGatewayCapabilityConfiguration,
iotsitewise:DeleteGateway

List

iotsitewise:ListGateways