Package software.amazon.awscdk.services.iotsitewise

Interface CfnGateway.GatewayCapabilitySummaryProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGateway.GatewayCapabilitySummaryProperty.Jsii$Proxy

Enclosing class:

CfnGateway

@Stability(Stable)
public static interface CfnGateway.GatewayCapabilitySummaryProperty
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	CfnGateway.GatewayCapabilitySummaryProperty.Builder	A builder for CfnGateway.GatewayCapabilitySummaryProperty
static final class	CfnGateway.GatewayCapabilitySummaryProperty.Jsii$Proxy	An implementation for CfnGateway.GatewayCapabilitySummaryProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapabilityNamespace

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
static CfnGateway.GatewayCapabilitySummaryProperty.Builder builder()

Returns:

a CfnGateway.GatewayCapabilitySummaryProperty.Builder of CfnGateway.GatewayCapabilitySummaryProperty