Package software.amazon.awscdk.services.iotsitewise

Class CfnGateway.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnGateway.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGateway>

Enclosing class:

CfnGateway

@Stability(Stable)
public static final class CfnGateway.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGateway>

A fluent builder for CfnGateway.

Method Summary

Modifier and Type	Method	Description
CfnGateway	build()
static CfnGateway.Builder	create(software.constructs.Construct scope, String id)
CfnGateway.Builder	gatewayCapabilitySummaries(List<? extends Object> gatewayCapabilitySummaries)	A list of gateway capability summaries that each contain a namespace and status.
CfnGateway.Builder	gatewayCapabilitySummaries(IResolvable gatewayCapabilitySummaries)	A list of gateway capability summaries that each contain a namespace and status.
CfnGateway.Builder	gatewayName(String gatewayName)	A unique name for the gateway.
CfnGateway.Builder	gatewayPlatform(IResolvable gatewayPlatform)	The gateway's platform.
CfnGateway.Builder	gatewayPlatform(CfnGateway.GatewayPlatformProperty gatewayPlatform)	The gateway's platform.
CfnGateway.Builder	gatewayVersion(String gatewayVersion)	The version of the gateway.
CfnGateway.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that contain metadata for the gateway.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnGateway.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGateway.Builder.

gatewayName

@Stability(Stable)
public CfnGateway.Builder gatewayName(String gatewayName)

A unique name for the gateway.

Parameters:

gatewayName - A unique name for the gateway. This parameter is required.

Returns:

this

See Also:

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

gatewayPlatform

@Stability(Stable)
public CfnGateway.Builder gatewayPlatform(IResolvable gatewayPlatform)

The gateway's platform.

You can only specify one platform in a gateway.

Parameters:

gatewayPlatform - The gateway's platform. This parameter is required.

Returns:

this

See Also:

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

gatewayPlatform

@Stability(Stable)
public CfnGateway.Builder gatewayPlatform(CfnGateway.GatewayPlatformProperty gatewayPlatform)

The gateway's platform.

You can only specify one platform in a gateway.

Parameters:

gatewayPlatform - The gateway's platform. This parameter is required.

Returns:

this

See Also:

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

gatewayCapabilitySummaries

@Stability(Stable)
public CfnGateway.Builder gatewayCapabilitySummaries(IResolvable gatewayCapabilitySummaries)

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 .

Parameters:

gatewayCapabilitySummaries - A list of gateway capability summaries that each contain a namespace and status. This parameter is required.

Returns:

this

See Also:

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

gatewayCapabilitySummaries

@Stability(Stable)
public CfnGateway.Builder gatewayCapabilitySummaries(List<? extends Object> gatewayCapabilitySummaries)

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 .

Parameters:

gatewayCapabilitySummaries - A list of gateway capability summaries that each contain a namespace and status. This parameter is required.

Returns:

this

See Also:

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

gatewayVersion

@Stability(Stable)
public CfnGateway.Builder gatewayVersion(String gatewayVersion)

The version of the gateway.

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

Parameters:

gatewayVersion - The version of the gateway. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnGateway.Builder tags(List<? extends CfnTag> tags)

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 .

Parameters:

tags - A list of key-value pairs that contain metadata for the gateway. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGateway build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGateway>

Returns:

a newly built instance of CfnGateway.