Class CfnGateway
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise .
Inherited Members
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGateway : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnGateway
Inherits CfnResource
Implements IInspectable, 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"
},
SiemensIe = new SiemensIEProperty {
IotCoreThingName = "iotCoreThingName"
}
},
// the properties below are optional
GatewayCapabilitySummaries = new [] { new GatewayCapabilitySummaryProperty {
CapabilityNamespace = "capabilityNamespace",
// the properties below are optional
CapabilityConfiguration = "capabilityConfiguration"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnGateway(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGateway(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnGateway(Construct, String, ICfnGatewayProps) |
Properties
AttrGatewayId | The ID for the gateway. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of key-value pairs that contain metadata for the gateway. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGateway(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGateway(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGateway(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGateway(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnGateway(Construct, String, ICfnGatewayProps)
public CfnGateway(Construct scope, string id, ICfnGatewayProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnGatewayProps
Resource properties.
Properties
AttrGatewayId
The ID for the gateway.
public virtual string AttrGatewayId { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
GatewayCapabilitySummaries
A list of gateway capability summaries that each contain a namespace and status.
public virtual object GatewayCapabilitySummaries { get; set; }
Property Value
System.Object
GatewayName
A unique name for the gateway.
public virtual string GatewayName { get; set; }
Property Value
System.String
GatewayPlatform
The gateway's platform.
public virtual object GatewayPlatform { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of key-value pairs that contain metadata for the gateway.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>