Interface CfnGatewayProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGatewayProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-11T18:01:17.437Z")
@Stability(Stable)
public interface CfnGatewayProps
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.iotsitewise.*; CfnGatewayProps cfnGatewayProps = CfnGatewayProps.builder() .gatewayName("gatewayName") .gatewayPlatform(GatewayPlatformProperty.builder() .greengrass(GreengrassProperty.builder() .groupArn("groupArn") .build()) .greengrassV2(GreengrassV2Property.builder() .coreDeviceThingName("coreDeviceThingName") .build()) .build()) // the properties below are optional .gatewayCapabilitySummaries(List.of(GatewayCapabilitySummaryProperty.builder() .capabilityNamespace("capabilityNamespace") // the properties below are optional .capabilityConfiguration("capabilityConfiguration") .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGatewayProps
static final class
An implementation forCfnGatewayProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnGatewayProps.Builder
builder()
default Object
A list of gateway capability summaries that each contain a namespace and status.A unique name for the gateway.The gateway's platform.getTags()
A list of key-value pairs that contain metadata for the gateway.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getGatewayName
A unique name for the gateway.- See Also:
-
getGatewayPlatform
The gateway's platform.You can only specify one platform in a gateway.
- See Also:
-
getGatewayCapabilitySummaries
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 .
- See Also:
-
getTags
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 .
- See Also:
-
builder
- Returns:
- a
CfnGatewayProps.Builder
ofCfnGatewayProps
-