Interface CfnGateway.GatewayPlatformProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGateway.GatewayPlatformProperty.Jsii$Proxy
- Enclosing class:
CfnGateway
@Stability(Stable)
public static interface CfnGateway.GatewayPlatformProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.iotsitewise.*;
GatewayPlatformProperty gatewayPlatformProperty = GatewayPlatformProperty.builder()
.greengrass(GreengrassProperty.builder()
.groupArn("groupArn")
.build())
.greengrassV2(GreengrassV2Property.builder()
.coreDeviceThingName("coreDeviceThingName")
// the properties below are optional
.coreDeviceOperatingSystem("coreDeviceOperatingSystem")
.build())
.siemensIe(SiemensIEProperty.builder()
.iotCoreThingName("iotCoreThingName")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnGateway.GatewayPlatformPropertystatic final classAn implementation forCfnGateway.GatewayPlatformProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectReturns union: eitherIResolvableorCfnGateway.GreengrassPropertydefault ObjectA gateway that runs on AWS IoT Greengrass V2 .default ObjectAn AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getGreengrass
Returns union: eitherIResolvableorCfnGateway.GreengrassProperty- See Also:
-
getGreengrassV2
A gateway that runs on AWS IoT Greengrass V2 .Returns union: either
IResolvableorCfnGateway.GreengrassV2Property- See Also:
-
getSiemensIe
An AWS IoT SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.Returns union: either
IResolvableorCfnGateway.SiemensIEProperty- See Also:
-
builder
-