Package software.amazon.awscdk.services.iotsitewise

Interface CfnGatewayProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:07.759Z")
@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")
                         // the properties below are optional
                         .coreDeviceOperatingSystem("coreDeviceOperatingSystem")
                         .build())
                 .siemensIe(SiemensIEProperty.builder()
                         .iotCoreThingName("iotCoreThingName")
                         .build())
                 .build())
         // the properties below are optional
         .gatewayCapabilitySummaries(List.of(GatewayCapabilitySummaryProperty.builder()
                 .capabilityNamespace("capabilityNamespace")
                 // the properties below are optional
                 .capabilityConfiguration("capabilityConfiguration")
                 .build()))
         .gatewayVersion("gatewayVersion")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGatewayProps.Builder	builder()
default Object	getGatewayCapabilitySummaries()	A list of gateway capability summaries that each contain a namespace and status.
String	getGatewayName()	A unique name for the gateway.
Object	getGatewayPlatform()	The gateway's platform.
default String	getGatewayVersion()	The version of the gateway.
default List<CfnTag>	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

@Stability(Stable)
@NotNull
String getGatewayName()

A unique name for the gateway.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayname

getGatewayPlatform

@Stability(Stable)
@NotNull
Object getGatewayPlatform()

The gateway's platform.

You can only specify one platform in a gateway.

Returns union: either IResolvable or CfnGateway.GatewayPlatformProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayplatform

getGatewayCapabilitySummaries

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGateway.GatewayCapabilitySummaryProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewaycapabilitysummaries

getGatewayVersion

@Stability(Stable)
@Nullable
default String getGatewayVersion()

The version of the gateway.

A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-gatewayversion

getTags

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

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-gateway.html#cfn-iotsitewise-gateway-tags

builder

@Stability(Stable)
static CfnGatewayProps.Builder builder()

Returns:

a CfnGatewayProps.Builder of CfnGatewayProps