Class CfnInput
A CloudFormation AWS::IoTEvents::Input
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTEvents
Assembly: Amazon.CDK.AWS.IoTEvents.dll
Syntax (csharp)
public class CfnInput : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnInput
Inherits CfnResource
Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks
The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as inputs to AWS IoT Events . For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide .
CloudformationResource: AWS::IoTEvents::Input
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html
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.IoTEvents;
CfnInput cfnInput = new CfnInput(this, "MyCfnInput", new CfnInputProps {
InputDefinition = new InputDefinitionProperty {
Attributes = new [] { new AttributeProperty {
JsonPath = "jsonPath"
} }
},
// the properties below are optional
InputDescription = "inputDescription",
InputName = "inputName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnInput(Construct, String, ICfnInputProps) | Create a new |
CfnInput(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnInput(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
InputDefinition | The definition of the input. |
InputDescription | A brief description of the input. |
InputName | The name of the input. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnInput(Construct, String, ICfnInputProps)
Create a new AWS::IoTEvents::Input
.
public CfnInput(Construct scope, string id, ICfnInputProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnInputProps
- resource properties.
CfnInput(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnInput(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnInput(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnInput(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
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
InputDefinition
The definition of the input.
public virtual object InputDefinition { get; set; }
Property Value
System.Object
Remarks
InputDescription
A brief description of the input.
public virtual string InputDescription { get; set; }
Property Value
System.String
Remarks
InputName
The name of the input.
public virtual string InputName { get; set; }
Property Value
System.String
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
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>