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 Details

    • create

      @Stability(Stable) public static CfnGateway.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnGateway.Builder.

    • gatewayName

      @Stability(Stable) public CfnGateway.Builder gatewayName(String gatewayName)
      A unique, friendly name for the gateway.

      The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .

      Parameters:
      gatewayName - A unique, friendly name for the gateway. This parameter is required.
      Returns:
      this

    • 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

    • 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

    • 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

    • 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

    • 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

    • build

      @Stability(Stable) public CfnGateway build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnGateway>
      Returns:
      a newly built instance of CfnGateway.