interface CfnGatewayProps

Language	Type name
.NET	`Amazon.CDK.AWS.IoTSiteWise.CfnGatewayProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnGatewayProps`
Java	`software.amazon.awscdk.services.iotsitewise.CfnGatewayProps`
Python	`aws_cdk.aws_iotsitewise.CfnGatewayProps`
TypeScript	`aws-cdk-lib` » `aws_iotsitewise` » `CfnGatewayProps`

Properties for defining a CfnGateway.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const cfnGatewayProps: iotsitewise.CfnGatewayProps = {
  gatewayName: 'gatewayName',
  gatewayPlatform: {
    greengrass: {
      groupArn: 'groupArn',
    },
    greengrassV2: {
      coreDeviceThingName: 'coreDeviceThingName',
    },
    siemensIe: {
      iotCoreThingName: 'iotCoreThingName',
    },
  },

  // the properties below are optional
  gatewayCapabilitySummaries: [{
    capabilityNamespace: 'capabilityNamespace',

    // the properties below are optional
    capabilityConfiguration: 'capabilityConfiguration',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

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

gatewayName

Type: string

A unique name for the gateway.

gatewayPlatform

Type: IResolvable | GatewayPlatformProperty

The gateway's platform.

You can only specify one platform in a 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 .

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 .