Package software.amazon.awscdk.services.iotevents

Class CfnInput

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotevents.CfnInput
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:08.536Z") @Stability(Stable) public class CfnInput extends CfnResource implements IInspectable, ITaggable
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotevents.*;
 CfnInput cfnInput = CfnInput.Builder.create(this, "MyCfnInput")
         .inputDefinition(InputDefinitionProperty.builder()
                 .attributes(List.of(AttributeProperty.builder()
                         .jsonPath("jsonPath")
                         .build()))
                 .build())
         // the properties below are optional
         .inputDescription("inputDescription")
         .inputName("inputName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInput

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

    • CfnInput

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

    • CfnInput

      @Stability(Stable) public CfnInput(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInputProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getInputDefinition

      @Stability(Stable) @NotNull public Object getInputDefinition()
      The definition of the input.

    • setInputDefinition

      @Stability(Stable) public void setInputDefinition(@NotNull IResolvable value)
      The definition of the input.

    • setInputDefinition

      @Stability(Stable) public void setInputDefinition(@NotNull CfnInput.InputDefinitionProperty value)
      The definition of the input.

    • getInputDescription

      @Stability(Stable) @Nullable public String getInputDescription()
      A brief description of the input.

    • setInputDescription

      @Stability(Stable) public void setInputDescription(@Nullable String value)
      A brief description of the input.

    • getInputName

      @Stability(Stable) @Nullable public String getInputName()
      The name of the input.

    • setInputName

      @Stability(Stable) public void setInputName(@Nullable String value)
      The name of the input.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.