aws-cdk-lib.aws_iotsitewise.CfnGatewayProps

interface CfnGatewayProps

LanguageType name
.NETAmazon.CDK.AWS.IoTSiteWise.CfnGatewayProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnGatewayProps
Javasoftware.amazon.awscdk.services.iotsitewise.CfnGatewayProps
Pythonaws_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',
    },
  },

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

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

Properties

NameTypeDescription
gatewayNamestringA unique, friendly name for the gateway.
gatewayPlatformIResolvable | GatewayPlatformPropertyThe 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, friendly name for the gateway.

The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .


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 .