aws-cdk-lib.aws_iotsitewise.CfnGateway.GatewayPlatformProperty

GatewayPlatformProperty Struct

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.

Source

Generated code

Type last changed

v2.159.0 · 19 Sep 2024

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

greengrassIResolvable | CfnGateway.GreengrassPropertygreengrasstyping.Union[IResolvable, GreengrassProperty]greengrassIResolvableGreengrassIResolvableGreengrassinterface{}#

greengrassV2IResolvable | CfnGateway.GreengrassV2Propertygreengrass_v2typing.Union[IResolvable, GreengrassV2Property]greengrassV2IResolvableGreengrassV2IResolvableGreengrassV2interface{}#

A gateway that runs on AWS IoT Greengrass V2 .

siemensIeIResolvable | CfnGateway.SiemensIEPropertysiemens_ietyping.Union[IResolvable, SiemensIEProperty]siemensIeIResolvableSiemensIeIResolvableSiemensIeinterface{}#

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