interface CfnGatewayMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTSiteWise.Mixins.CfnGatewayMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotsitewise/mixins#CfnGatewayMixinProps
Java	software.amazon.awscdk.mixins.preview.services.iotsitewise.mixins.CfnGatewayMixinProps
Python	aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnGatewayMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_iotsitewise » mixins » CfnGatewayMixinProps

Properties for CfnGatewayPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iotsitewise_mixins } from '@aws-cdk/mixins-preview/aws-iotsitewise';
const cfnGatewayMixinProps: iotsitewise_mixins.CfnGatewayMixinProps = {
  gatewayCapabilitySummaries: [{
    capabilityConfiguration: 'capabilityConfiguration',
    capabilityNamespace: 'capabilityNamespace',
  }],
  gatewayName: 'gatewayName',
  gatewayPlatform: {
    greengrass: {
      groupArn: 'groupArn',
    },
    greengrassV2: {
      coreDeviceOperatingSystem: 'coreDeviceOperatingSystem',
      coreDeviceThingName: 'coreDeviceThingName',
    },
    siemensIe: {
      iotCoreThingName: 'iotCoreThingName',
    },
  },
  gatewayVersion: 'gatewayVersion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
gatewayCapabilitySummaries?	IResolvable | (IResolvable | GatewayCapabilitySummaryProperty)[]	A list of gateway capability summaries that each contain a namespace and status.
gatewayName?	string	A unique name for the gateway.
gatewayPlatform?	IResolvable | GatewayPlatformProperty	The gateway's platform.
gatewayVersion?	string	The version of the gateway.
tags?	CfnTag[]	A list of key-value pairs that contain metadata for the gateway.

---

gatewayCapabilitySummaries?

Type: IResolvable | (IResolvable | GatewayCapabilitySummaryProperty)[] (optional)

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

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

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

---

gatewayName?

Type: string (optional)

A unique name for the gateway.

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

---

gatewayPlatform?

Type: IResolvable | GatewayPlatformProperty (optional)

The gateway's platform.

You can only specify one platform in a gateway.

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

---

gatewayVersion?

Type: string (optional)

The version of the gateway.

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

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

---

tags?

Type: CfnTag[] (optional)

A list of key-value pairs that contain metadata for the gateway.

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

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