AWS::IoTSiteWise::Gateway - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

AWS::IoTSiteWise::Gateway

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.

Syntax

To declare this entity in your Amazon 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: List of GatewayCapabilitySummary

Update requires: No interruption

GatewayName

A unique, friendly name for the gateway.

The maximum length is 256 characters with the pattern [^\u0000-\u001F\u007F]+.

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 Amazon IoT SiteWise resources in the Amazon IoT SiteWise User Guide.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the GatewayId.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

GatewayId

The ID for the gateway.

For more information about using the Reffunction, see Ref.