Interface ICfnGatewayProps

Properties for defining a CfnGateway.

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnGatewayProps

Syntax (vb)

Public Interface 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"
        },
        SiemensIe = new SiemensIEProperty {
            IotCoreThingName = "iotCoreThingName"
        }
    },

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

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

Synopsis

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.
Tags	A list of key-value pairs that contain metadata for the gateway.

Properties

GatewayCapabilitySummaries

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

virtual object GatewayCapabilitySummaries { get; }

Property Value

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

GatewayName

A unique name for the gateway.

string GatewayName { get; }

Property Value

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

object GatewayPlatform { get; }

Property Value

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