AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTSiteWise::Gateway

CfnGateway

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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the *AWS IoT SiteWise User Guide* .

Import

import { CfnGateway } from 'aws-cdk-lib/aws-iotsitewise';

Or use the module namespace:

import * as iotsitewise from 'aws-cdk-lib/aws-iotsitewise';
// iotsitewise.CfnGateway

Properties

Configuration passed to the constructor as CfnGatewayProps.

gatewayNameRequired
string

A unique name for the gateway.

gatewayPlatformRequired
IResolvable | GatewayPlatformProperty

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

gatewayCapabilitySummariesOptional
IResolvable | IResolvable | GatewayCapabilitySummaryProperty[]

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](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html) .

gatewayVersionOptional
string

The version of the gateway. A value of `3` indicates an MQTT-enabled, V3 gateway, while `2` indicates a Classic streams, V2 gateway.

tagsOptional
CfnTag[]

A list of key-value pairs that contain metadata for the gateway. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide* .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

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

LevelL1 (CloudFormation)
Moduleaws-iotsitewise
CFN TypeAWS::IoTSiteWise::Gateway
Properties5

External Links