Package software.amazon.awscdk.services.iotevents.alpha

Class Input

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.iotevents.alpha.Input
All Implemented Interfaces:
IResource, IInput, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:15.827Z") @Stability(Experimental) public class Input extends Resource implements IInput
(experimental) Defines an AWS IoT Events input in this stack.

Example: 

 import software.amazon.awscdk.services.iotevents.alpha.*;
 import software.amazon.awscdk.services.iam.*;
 IRole role;
 Input input = Input.Builder.create(this, "MyInput")
         .attributeJsonPaths(List.of("payload.temperature", "payload.transactionId"))
         .build();
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"))
         .actions(List.of(
             IotEventsPutMessageAction.Builder.create(input)
                     .batchMode(true) // optional property, default is 'false'
                     .messageId("${payload.transactionId}") // optional property, default is a new UUID
                     .role(role)
                     .build()))
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Input.Builder
    (experimental) A fluent builder for Input.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iotevents.alpha.IInput

    IInput.Jsii$Default, IInput.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Input(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Input(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    Input(software.constructs.Construct scope, String id, InputProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static IInput
    fromInputName(software.constructs.Construct scope, String id, String inputName)
    (experimental) Import an existing input.
    String
    getInputArn()
    (experimental) The ARN of the input.
    String
    getInputName()
    (experimental) The name of the input.
    Grant
    grant(IGrantable grantee, @NotNull String... actions)
    (experimental) Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).
    Grant
    grantWrite(IGrantable grantee)
    (experimental) Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).

    Methods inherited from class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Input

      protected Input(software.amazon.jsii.JsiiObjectRef objRef)

    • Input

      protected Input(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Input

      @Stability(Experimental) public Input(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull InputProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromInputName

      @Stability(Experimental) @NotNull public static IInput fromInputName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String inputName)
      (experimental) Import an existing input.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      inputName - This parameter is required.

    • grant

      @Stability(Experimental) @NotNull public Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions)
      (experimental) Grant the indicated permissions on this input to the given IAM principal (Role/Group/User).

      Specified by:
      grant in interface IInput
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantWrite

      @Stability(Experimental) @NotNull public Grant grantWrite(@NotNull IGrantable grantee)
      (experimental) Grant write permissions on this input and its contents to an IAM principal (Role/Group/User).

      Specified by:
      grantWrite in interface IInput
      Parameters:
      grantee - This parameter is required.

    • getInputArn

      @Stability(Experimental) @NotNull public String getInputArn()
      (experimental) The ARN of the input.
      Specified by:
      getInputArn in interface IInput

    • getInputName

      @Stability(Experimental) @NotNull public String getInputName()
      (experimental) The name of the input.
      Specified by:
      getInputName in interface IInput