awscdkioteventsalpha

README

AWS::IoTEvents Construct Library

---

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

---

AWS IoT Events enables you to monitor your equipment or device fleets for failures or changes in operation, and to trigger actions when such events occur.

Installation

Install the module:

$ npm i @aws-cdk/aws-iotevents

Import it into your code:

import * as iotevents from '@aws-cdk/aws-iotevents-alpha';

Input

Add an AWS IoT Events input to your stack:

import * as iotevents from '@aws-cdk/aws-iotevents-alpha';

new iotevents.Input(this, 'MyInput', {
  inputName: 'my_input',
  attributeJsonPaths: ['payload.temperature'],
});

Documentation

Overview

The CDK Construct Library for AWS::IoTEvents

Index

• func Input_IsConstruct(x interface{}) *bool
• func Input_IsResource(construct constructs.IConstruct) *bool
• func NewInput_Override(i Input, scope constructs.Construct, id *string, props *InputProps)
• type IInput
  • func Input_FromInputName(scope constructs.Construct, id *string, inputName *string) IInput
• type Input
  • func NewInput(scope constructs.Construct, id *string, props *InputProps) Input
• type InputProps

Functions

func Input_IsConstruct

func Input_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Input_IsResource

func Input_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewInput_Override

func NewInput_Override(i Input, scope constructs.Construct, id *string, props *InputProps)

Experimental.

Types

type IInput

type IInput interface {
	awscdk.IResource
	// The name of the input.
	// Experimental.
	InputName() *string
}

Represents an AWS IoT Events input. Experimental.

func Input_FromInputName

func Input_FromInputName(scope constructs.Construct, id *string, inputName *string) IInput

Import an existing input. Experimental.

type Input

type Input interface {
	awscdk.Resource
	IInput
	Env() *awscdk.ResourceEnvironment
	InputName() *string
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

Defines an AWS IoT Events input in this stack.

TODO: EXAMPLE

Experimental.

func NewInput

func NewInput(scope constructs.Construct, id *string, props *InputProps) Input

Experimental.

type InputProps

type InputProps struct {
	// An expression that specifies an attribute-value pair in a JSON structure.
	//
	// Use this to specify an attribute from the JSON payload that is made available
	// by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage).
	// Each such message contains a JSON payload. The attribute (and its paired value)
	// specified here are available for use in the condition expressions used by detectors.
	// Experimental.
	AttributeJsonPaths *[]*string `json:"attributeJsonPaths"`
	// The name of the input.
	// Experimental.
	InputName *string `json:"inputName"`
}

Properties for defining an AWS IoT Events input.

TODO: EXAMPLE

Experimental.