software.amazon.awscdk.services.iotsitewise

Interface CfnGateway.GatewayCapabilitySummaryProperty

All Known Implementing Classes:

CfnGateway.GatewayCapabilitySummaryProperty.Jsii$Proxy

Enclosing class:

CfnGateway

public static interface 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 software.amazon.awscdk.services.iotsitewise.*;
 GatewayCapabilitySummaryProperty gatewayCapabilitySummaryProperty = GatewayCapabilitySummaryProperty.builder()
         .capabilityNamespace("capabilityNamespace")
         // the properties below are optional
         .capabilityConfiguration("capabilityConfiguration")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnGateway.GatewayCapabilitySummaryProperty.Builder A builder for CfnGateway.GatewayCapabilitySummaryProperty
static class	CfnGateway.GatewayCapabilitySummaryProperty.Jsii$Proxy An implementation for CfnGateway.GatewayCapabilitySummaryProperty

Method Summary

Modifier and Type	Method and Description
static CfnGateway.GatewayCapabilitySummaryProperty.Builder	builder()
default java.lang.String	getCapabilityConfiguration() The JSON document that defines the configuration for the gateway capability.
java.lang.String	getCapabilityNamespace() The namespace of the capability configuration.

Method Detail

getCapabilityNamespace

java.lang.String getCapabilityNamespace()

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]+$ .

getCapabilityConfiguration

default java.lang.String getCapabilityConfiguration()

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 .

builder

static CfnGateway.GatewayCapabilitySummaryProperty.Builder builder()

Returns:

a CfnGateway.GatewayCapabilitySummaryProperty.Builder of CfnGateway.GatewayCapabilitySummaryProperty