software.amazon.awscdk.services.iotsitewise

Class CfnGateway

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotsitewise.CfnGateway

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.046Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGateway.Builder A fluent builder for CfnGateway.
static interface	CfnGateway.GatewayCapabilitySummaryProperty Contains a summary of a gateway capability configuration.
static interface	CfnGateway.GatewayPlatformProperty Contains a gateway's platform information.
static interface	CfnGateway.GreengrassProperty Contains details for a gateway that runs on AWS IoT Greengrass .
static interface	CfnGateway.GreengrassV2Property Contains details for a gateway that runs on AWS IoT Greengrass V2.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGateway(software.constructs.Construct scope, String id, CfnGatewayProps props) Create a new `AWS::IoTSiteWise::Gateway`.
protected	CfnGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGateway(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrGatewayId() The ID for the gateway.
protected Map<String,Object>	getCfnProperties()
Object	getGatewayCapabilitySummaries() A list of gateway capability summaries that each contain a namespace and status.
String	getGatewayName() A unique, friendly name for the gateway.
Object	getGatewayPlatform() The gateway's platform.
TagManager	getTags() A list of key-value pairs that contain metadata for the gateway.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setGatewayCapabilitySummaries(IResolvable value) A list of gateway capability summaries that each contain a namespace and status.
void	setGatewayCapabilitySummaries(List<Object> value) A list of gateway capability summaries that each contain a namespace and status.
void	setGatewayName(String value) A unique, friendly name for the gateway.
void	setGatewayPlatform(CfnGateway.GatewayPlatformProperty value) The gateway's platform.
void	setGatewayPlatform(IResolvable value) The gateway's platform.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGateway

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

CfnGateway

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

CfnGateway

@Stability(value=Stable)
public CfnGateway(@NotNull
                                           software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrGatewayId()

The ID for the gateway.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public Object getGatewayPlatform()

The gateway's platform.

You can only specify one platform in a gateway.

setGatewayPlatform

@Stability(value=Stable)
public void setGatewayPlatform(@NotNull
                                                        CfnGateway.GatewayPlatformProperty value)

The gateway's platform.

You can only specify one platform in a gateway.

setGatewayPlatform

@Stability(value=Stable)
public void setGatewayPlatform(@NotNull
                                                        IResolvable value)

The gateway's platform.

You can only specify one platform in a gateway.

getGatewayCapabilitySummaries

@Stability(value=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(value=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(value=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 .