Show / Hide Table of Contents

Class CfnGateway.GatewayPlatformProperty

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

Inheritance
object
CfnGateway.GatewayPlatformProperty
Implements
CfnGateway.IGatewayPlatformProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGateway.GatewayPlatformProperty : CfnGateway.IGatewayPlatformProperty
Syntax (vb)
Public Class CfnGateway.GatewayPlatformProperty Implements CfnGateway.IGatewayPlatformProperty
Remarks

(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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var gatewayPlatformProperty = new GatewayPlatformProperty {
                 Greengrass = new GreengrassProperty {
                     GroupArn = "groupArn"
                 },
                 GreengrassV2 = new GreengrassV2Property {
                     CoreDeviceThingName = "coreDeviceThingName",

                     // the properties below are optional
                     CoreDeviceOperatingSystem = "coreDeviceOperatingSystem"
                 },
                 SiemensIe = new SiemensIEProperty {
                     IotCoreThingName = "iotCoreThingName"
                 }
             };

Synopsis

Constructors

GatewayPlatformProperty()

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

Properties

Greengrass

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

GreengrassV2

A gateway that runs on AWS IoT Greengrass V2 .

SiemensIe

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

Constructors

GatewayPlatformProperty()

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

public GatewayPlatformProperty()
Remarks

(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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var gatewayPlatformProperty = new GatewayPlatformProperty {
                 Greengrass = new GreengrassProperty {
                     GroupArn = "groupArn"
                 },
                 GreengrassV2 = new GreengrassV2Property {
                     CoreDeviceThingName = "coreDeviceThingName",

                     // the properties below are optional
                     CoreDeviceOperatingSystem = "coreDeviceOperatingSystem"
                 },
                 SiemensIe = new SiemensIEProperty {
                     IotCoreThingName = "iotCoreThingName"
                 }
             };

Properties

Greengrass

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

public object? Greengrass { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-greengrass

Type union: either IResolvable or CfnGateway.IGreengrassProperty

GreengrassV2

A gateway that runs on AWS IoT Greengrass V2 .

public object? GreengrassV2 { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-greengrassv2

Type union: either IResolvable or CfnGateway.IGreengrassV2Property

SiemensIe

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

public object? SiemensIe { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-siemensie

Type union: either IResolvable or CfnGateway.ISiemensIEProperty

Implements

CfnGateway.IGatewayPlatformProperty
Back to top Generated by DocFX