Class Input

(experimental) Defines an AWS IoT Events input in this stack.

Inheritance
object
Resource
Input
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.IoTEvents.Alpha
Assembly: Amazon.CDK.AWS.IoTEvents.Alpha.dll
Syntax (csharp)
public class Input : Resource, IInput, IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class Input Inherits Resource Implements IInput, IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.IoTEvents.Alpha;
             using Amazon.CDK.AWS.IAM;

             IRole role;


             var input = new Input(this, "MyInput", new InputProps {
                 AttributeJsonPaths = new [] { "payload.temperature", "payload.transactionId" }
             });
             var topicRule = new TopicRule(this, "TopicRule", new TopicRuleProps {
                 Sql = IotSql.FromStringAsVer20160323("SELECT * FROM 'device/+/data'"),
                 Actions = new [] {
                     new IotEventsPutMessageAction(input, new IotEventsPutMessageActionProps {
                         BatchMode = true,  // optional property, default is 'false'
                         MessageId = "${payload.transactionId}",  // optional property, default is a new UUID
                         Role = role
                     }) }
             });

Synopsis

Constructors

Input(Construct, string, IInputProps)

(experimental) Defines an AWS IoT Events input in this stack.

Properties

InputArn

(experimental) The ARN of the input.
InputName

(experimental) The name of the input.
PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Methods

FromInputName(Construct, string, string)

(experimental) Import an existing input.
Grant(IGrantable, params string[])

(experimental) Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).
GrantWrite(IGrantable)

(experimental) Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).

Constructors

Input(Construct, string, IInputProps)

(experimental) Defines an AWS IoT Events input in this stack.

public Input(Construct scope, string id, IInputProps props)
Parameters
scope Construct
id string
props IInputProps
Remarks

Stability: Experimental

Properties

InputArn

(experimental) The ARN of the input.

public virtual string InputArn { get; }
Property Value

string

Remarks

Stability: Experimental

InputName

(experimental) The name of the input.

public virtual string InputName { get; }
Property Value

string

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Stability: Experimental

Methods

FromInputName(Construct, string, string)

(experimental) Import an existing input.

public static IInput FromInputName(Construct scope, string id, string inputName)
Parameters
scope Construct
id string
inputName string
Returns

IInput

Remarks

Stability: Experimental

Grant(IGrantable, params string[])

(experimental) Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).

public virtual Grant Grant(IGrantable grantee, params string[] actions)
Parameters
grantee IGrantable
actions string[]
Returns

Grant

Remarks

Stability: Experimental

GrantWrite(IGrantable)

(experimental) Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).

public virtual Grant GrantWrite(IGrantable grantee)
Parameters
grantee IGrantable
Returns

Grant

Remarks

Stability: Experimental

Implements

Constructs.IConstruct
Constructs.IDependable