AWS::IoTSiteWise::Gateway

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

Syntax

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

JSON

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

YAML

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

Properties

GatewayCapabilitySummaries

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

GatewayName

A unique, friendly name for the gateway.

Required: Yes

Type: String

Update requires: No interruption

GatewayPlatform

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

Required: Yes

Type: GatewayPlatform

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

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

Fn::GetAtt

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.

GatewayId

The ID for the gateway.

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