AWS Fundamentals Logo
AWS Fundamentals
AWS::IoTSiteWise::Gateway

IoTSiteWise Gateway

Resource schema for AWS::IoTSiteWise::Gateway

Properties

5 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
GatewayName
string
Required
GatewayPlatform
GatewayPlatform
RequiredCreate-only
GatewayCapabilitySummaries
Array<GatewayCapabilitySummary>
GatewayVersion
string
Create-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
GatewayIdstringThe ID of the gateway device.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoTSiteWise::Gateway

Resources:
  MyResource:
    Type: AWS::IoTSiteWise::Gateway
    Properties:
      GatewayName: "my-gatewayname"
      GatewayPlatform: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iotsitewise:CreateGatewayiotsitewise:DescribeGatewayiotsitewise:DescribeGatewayCapabilityConfigurationiotsitewise:UpdateGatewayCapabilityConfigurationiam:PassRoleiam:GetRoleiotsitewise:ListTagsForResourceiotsitewise:TagResource

read

iotsitewise:DescribeGatewayiotsitewise:DescribeGatewayCapabilityConfigurationiotsitewise:ListTagsForResource

update

iotsitewise:UpdateGatewayiotsitewise:UpdateGatewayCapabilityConfigurationiotsitewise:TagResourceiotsitewise:UntagResourceiotsitewise:DescribeGatewayiotsitewise:DescribeGatewayCapabilityConfigurationiotsitewise:ListTagsForResource

delete

iotsitewise:DescribeGatewayiotsitewise:DescribeGatewayCapabilityConfigurationiotsitewise:DeleteGateway

list

iotsitewise:ListGatewaysiotsitewise:ListTagsForResource

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceIoTSiteWise
Properties6
Required2
TaggingSupported
Primary IDGatewayId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

GatewayPlatformGatewayVersion

Related Resources

External Links