aws-cdk-lib.aws_iotsitewise.CfnGateway.GatewayCapabilitySummaryProperty

interface GatewayCapabilitySummaryProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTSiteWise.CfnGateway.GatewayCapabilitySummaryProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnGateway_GatewayCapabilitySummaryProperty
Javasoftware.amazon.awscdk.services.iotsitewise.CfnGateway.GatewayCapabilitySummaryProperty
Pythonaws_cdk.aws_iotsitewise.CfnGateway.GatewayCapabilitySummaryProperty
TypeScript aws-cdk-lib » aws_iotsitewise » CfnGateway » GatewayCapabilitySummaryProperty

Contains a summary of a gateway capability configuration.

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 gatewayCapabilitySummaryProperty: iotsitewise.CfnGateway.GatewayCapabilitySummaryProperty = {
  capabilityNamespace: 'capabilityNamespace',

  // the properties below are optional
  capabilityConfiguration: 'capabilityConfiguration',
};

Properties

NameTypeDescription
capabilityNamespacestringThe namespace of the capability configuration.
capabilityConfiguration?stringThe JSON document that defines the configuration for the gateway capability.

capabilityNamespace

Type: string

The namespace of the capability configuration.

For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .

The maximum length is 512 characters with the pattern ^[a-zA-Z]+:[a-zA-Z]+:[0-9]+$ .


capabilityConfiguration?

Type: string (optional)

The JSON document that defines the configuration for the gateway capability.

For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .