AWS::IoTSiteWise::Gateway - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to Amazon IoT SiteWise. For more information, see Ingesting data using a gateway in the Amazon IoT SiteWise User Guide.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::IoTSiteWise::Gateway", "Properties" : { "GatewayCapabilitySummaries" : [ GatewayCapabilitySummary, ... ], "GatewayName" : String, "GatewayPlatform" : GatewayPlatform, "Tags" : [ Tag, ... ] } }


Type: AWS::IoTSiteWise::Gateway Properties: GatewayCapabilitySummaries: - GatewayCapabilitySummary GatewayName: String GatewayPlatform: GatewayPlatform Tags: - Tag



A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

Required: No

Type: Array of GatewayCapabilitySummary

Update requires: No interruption


A unique name for the gateway.

Required: Yes

Type: String

Update requires: No interruption


The gateway's platform. You can only specify one platform in a gateway.

Required: Yes

Type: GatewayPlatform

Update requires: Replacement


A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your Amazon IoT SiteWise resources in the Amazon IoT SiteWise User Guide.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the GatewayId.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


The ID for the gateway.

For more information about using the Ref function, see Ref.