Class CfnGateway

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnGateway

Implements

IInspectable

IGatewayRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGateway : CfnResource, IInspectable, IGatewayRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnGateway Inherits CfnResource Implements IInspectable, IGatewayRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var cfnGateway = new CfnGateway(this, "MyCfnGateway", new CfnGatewayProps {
                 GatewayName = "gatewayName",
                 GatewayPlatform = new GatewayPlatformProperty {
                     Greengrass = new GreengrassProperty {
                         GroupArn = "groupArn"
                     },
                     GreengrassV2 = new GreengrassV2Property {
                         CoreDeviceThingName = "coreDeviceThingName",

                         // the properties below are optional
                         CoreDeviceOperatingSystem = "coreDeviceOperatingSystem"
                     },
                     SiemensIe = new SiemensIEProperty {
                         IotCoreThingName = "iotCoreThingName"
                     }
                 },

                 // the properties below are optional
                 GatewayCapabilitySummaries = new [] { new GatewayCapabilitySummaryProperty {
                     CapabilityNamespace = "capabilityNamespace",

                     // the properties below are optional
                     CapabilityConfiguration = "capabilityConfiguration"
                 } },
                 GatewayVersion = "gatewayVersion",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnGateway(Construct, string, ICfnGatewayProps)

Create a new AWS::IoTSiteWise::Gateway.

Properties

AttrGatewayId	The ID for the gateway.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .
GatewayCapabilitySummaries	A list of gateway capability summaries that each contain a namespace and status.
GatewayName	A unique name for the gateway.
GatewayPlatform	The gateway's platform.
GatewayRef	A reference to a Gateway resource.
GatewayVersion	The version of the gateway.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A list of key-value pairs that contain metadata for the gateway.

Methods

FromGatewayId(Construct, string, string)	Creates a new IGatewayRef from a gatewayId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .

Constructors

CfnGateway(Construct, string, ICfnGatewayProps)

Create a new AWS::IoTSiteWise::Gateway.

public CfnGateway(Construct scope, string id, ICfnGatewayProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnGatewayProps

Resource properties.

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

Properties

AttrGatewayId

The ID for the gateway.

public virtual string AttrGatewayId { get; }

Property Value

string

Remarks

CloudformationAttribute: GatewayId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

CfnProperties

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

GatewayCapabilitySummaries

A list of gateway capability summaries that each contain a namespace and status.

public virtual object? GatewayCapabilitySummaries { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnGateway.IGatewayCapabilitySummaryProperty)[]

GatewayName

A unique name for the gateway.

public virtual string GatewayName { get; set; }

Property Value

string

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

GatewayPlatform

The gateway's platform.

public virtual object GatewayPlatform { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnGateway.IGatewayPlatformProperty

GatewayRef

A reference to a Gateway resource.

public virtual IGatewayReference GatewayRef { get; }

Property Value

IGatewayReference

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

GatewayVersion

The version of the gateway.

public virtual string? GatewayVersion { get; set; }

Property Value

string

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

TagsRaw

A list of key-value pairs that contain metadata for the gateway.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

Methods

FromGatewayId(Construct, string, string)

Creates a new IGatewayRef from a gatewayId.

public static IGatewayRef FromGatewayId(Construct scope, string id, string gatewayId)

Parameters

scope Construct

id string

gatewayId string

Returns

IGatewayRef

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

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

CloudformationResource: AWS::IoTSiteWise::Gateway

ExampleMetadata: fixture=_generated

Implements

IInspectable

IGatewayRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable