Package software.amazon.awscdk.services.iotsitewise

Class CfnGateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotsitewise.CfnGateway
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.921Z") @Stability(Stable) public class CfnGateway extends CfnResource implements IInspectable
A CloudFormation AWS::IoTSiteWise::Gateway.

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise . For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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.*;
 CfnGateway cfnGateway = CfnGateway.Builder.create(this, "MyCfnGateway")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGateway

      protected CfnGateway(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnGateway

      protected CfnGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnGateway

      @Stability(Stable) public CfnGateway(@NotNull Construct scope, @NotNull String id, @NotNull CfnGatewayProps props)
      Create a new AWS::IoTSiteWise::Gateway.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrGatewayId

      @Stability(Stable) @NotNull public String getAttrGatewayId()
      The ID for the gateway.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

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

    • getGatewayName

      @Stability(Stable) @NotNull public String getGatewayName()
      A unique, friendly name for the gateway.

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

    • setGatewayName

      @Stability(Stable) public void setGatewayName(@NotNull String value)
      A unique, friendly name for the gateway.

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

    • getGatewayPlatform

      @Stability(Stable) @NotNull public Object getGatewayPlatform()
      The gateway's platform.

      You can only specify one platform in a gateway.

    • setGatewayPlatform

      @Stability(Stable) public void setGatewayPlatform(@NotNull IResolvable value)
      The gateway's platform.

      You can only specify one platform in a gateway.

    • setGatewayPlatform

      @Stability(Stable) public void setGatewayPlatform(@NotNull CfnGateway.GatewayPlatformProperty value)
      The gateway's platform.

      You can only specify one platform in a gateway.

    • getGatewayCapabilitySummaries

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

    • setGatewayCapabilitySummaries

      @Stability(Stable) public void setGatewayCapabilitySummaries(@Nullable IResolvable value)
      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 .

    • setGatewayCapabilitySummaries

      @Stability(Stable) public void setGatewayCapabilitySummaries(@Nullable List<Object> value)
      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 .