Class Input
(experimental) Defines an AWS IoT Events input in this stack.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTEvents.Alpha
Assembly: Amazon.CDK.AWS.IoTEvents.Alpha.dll
Syntax (csharp)
public class Input : Resource, IInput, IResource
Syntax (vb)
Public Class Input
Inherits Resource
Implements IInput, IResource
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Input(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Input(Construct, String, IInputProps) |
Properties
InputArn | (experimental) The ARN of the input. |
InputName | (experimental) The name of the input. |
Methods
FromInputName(Construct, String, String) | (experimental) Import an existing input. |
Grant(IGrantable, 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(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Input(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Input(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Input(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Input(Construct, String, IInputProps)
public Input(Construct scope, string id, IInputProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IInputProps
Remarks
Stability: Experimental
Properties
InputArn
(experimental) The ARN of the input.
public virtual string InputArn { get; }
Property Value
System.String
Remarks
Stability: Experimental
InputName
(experimental) The name of the input.
public virtual string InputName { get; }
Property Value
System.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 Constructs.Construct
- id System.String
- inputName System.String
Returns
Remarks
Stability: Experimental
Grant(IGrantable, 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 System.String[]
Returns
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
Remarks
Stability: Experimental