interface GatewayPlatformProperty

Language	Type name
.NET	`Amazon.CDK.AWS.IoTSiteWise.CfnGateway.GatewayPlatformProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnGateway_GatewayPlatformProperty`
Java	`software.amazon.awscdk.services.iotsitewise.CfnGateway.GatewayPlatformProperty`
Python	`aws_cdk.aws_iotsitewise.CfnGateway.GatewayPlatformProperty`
TypeScript	`aws-cdk-lib` » `aws_iotsitewise` » `CfnGateway` » `GatewayPlatformProperty`

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

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway ( gatewayVersion=3 ), you must also specify the coreDeviceOperatingSystem .

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const gatewayPlatformProperty: iotsitewise.CfnGateway.GatewayPlatformProperty = {
  greengrass: {
    groupArn: 'groupArn',
  },
  greengrassV2: {
    coreDeviceThingName: 'coreDeviceThingName',

    // the properties below are optional
    coreDeviceOperatingSystem: 'coreDeviceOperatingSystem',
  },
  siemensIe: {
    iotCoreThingName: 'iotCoreThingName',
  },
};

Properties

Name	Type	Description
greengrass?	`IResolvable` `\|` `GreengrassProperty`
greengrassV2?	`IResolvable` `\|` `GreengrassV2Property`	A gateway that runs on AWS IoT Greengrass V2 .
siemensIe?	`IResolvable` `\|` `SiemensIEProperty`	An AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

greengrass?

Type: IResolvable | GreengrassProperty (optional)

greengrassV2?

Type: IResolvable | GreengrassV2Property (optional)

A gateway that runs on AWS IoT Greengrass V2 .

siemensIe?

Type: IResolvable | SiemensIEProperty (optional)

An AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.