Class CfnGatewayProps

Properties for defining a CfnGateway.

Inheritance

object

CfnGatewayProps

Implements

ICfnGatewayProps

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 CfnGatewayProps : ICfnGatewayProps

Syntax (vb)

Public Class CfnGatewayProps Implements ICfnGatewayProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.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 cfnGatewayProps = new CfnGatewayProps {
                 GatewayName = "gatewayName",
                 GatewayPlatform = new GatewayPlatformProperty {
                     Greengrass = new GreengrassProperty {
                         GroupArn = "groupArn"
                     },
                     GreengrassV2 = new GreengrassV2Property {
                         CoreDeviceThingName = "coreDeviceThingName",

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

                 // the properties below are optional
                 GatewayCapabilitySummaries = new [] { new GatewayCapabilitySummaryProperty {
                     CapabilityNamespace = "capabilityNamespace",

                     // the properties below are optional
                     CapabilityConfiguration = "capabilityConfiguration"
                 } },
                 GatewayVersion = "gatewayVersion",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnGatewayProps()

Properties for defining a CfnGateway.

Properties

GatewayCapabilitySummaries	A list of gateway capability summaries that each contain a namespace and status.
GatewayName	A unique name for the gateway.
GatewayPlatform	The gateway's platform.
GatewayVersion	The version of the gateway.
Tags	A list of key-value pairs that contain metadata for the gateway.

Constructors

CfnGatewayProps()

Properties for defining a CfnGateway.

public CfnGatewayProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.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 cfnGatewayProps = new CfnGatewayProps {
                 GatewayName = "gatewayName",
                 GatewayPlatform = new GatewayPlatformProperty {
                     Greengrass = new GreengrassProperty {
                         GroupArn = "groupArn"
                     },
                     GreengrassV2 = new GreengrassV2Property {
                         CoreDeviceThingName = "coreDeviceThingName",

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

                 // the properties below are optional
                 GatewayCapabilitySummaries = new [] { new GatewayCapabilitySummaryProperty {
                     CapabilityNamespace = "capabilityNamespace",

                     // the properties below are optional
                     CapabilityConfiguration = "capabilityConfiguration"
                 } },
                 GatewayVersion = "gatewayVersion",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

GatewayCapabilitySummaries

A list of gateway capability summaries that each contain a namespace and status.

public object? GatewayCapabilitySummaries { get; set; }

Property Value

object

Remarks

Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewaycapabilitysummaries

Type union: either IResolvable or (either IResolvable or CfnGateway.IGatewayCapabilitySummaryProperty)[]

GatewayName

A unique name for the gateway.

public string GatewayName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayname

GatewayPlatform

The gateway's platform.

public object GatewayPlatform { get; set; }

Property Value

object

Remarks

You can only specify one platform in a gateway.

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

Type union: either IResolvable or CfnGateway.IGatewayPlatformProperty

GatewayVersion

The version of the gateway.

public string? GatewayVersion { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayversion

Implements

ICfnGatewayProps