awsiotactions

Documentation

Index

• func NewCloudWatchLogsAction_Override(c CloudWatchLogsAction, logGroup awslogs.ILogGroup, ...)
• func NewFirehoseStreamAction_Override(f FirehoseStreamAction, stream awskinesisfirehose.IDeliveryStream, ...)
• func NewLambdaFunctionAction_Override(l LambdaFunctionAction, func_ awslambda.IFunction)
• func NewS3PutObjectAction_Override(s S3PutObjectAction, bucket awss3.IBucket, props *S3PutObjectActionProps)
• type CloudWatchLogsAction
  • func NewCloudWatchLogsAction(logGroup awslogs.ILogGroup, props *CloudWatchLogsActionProps) CloudWatchLogsAction
• type CloudWatchLogsActionProps
• type CommonActionProps
• type FirehoseStreamAction
  • func NewFirehoseStreamAction(stream awskinesisfirehose.IDeliveryStream, props *FirehoseStreamActionProps) FirehoseStreamAction
• type FirehoseStreamActionProps
• type FirehoseStreamRecordSeparator
• type LambdaFunctionAction
  • func NewLambdaFunctionAction(func_ awslambda.IFunction) LambdaFunctionAction
• type S3PutObjectAction
  • func NewS3PutObjectAction(bucket awss3.IBucket, props *S3PutObjectActionProps) S3PutObjectAction
• type S3PutObjectActionProps

Functions

func NewCloudWatchLogsAction_Override

func NewCloudWatchLogsAction_Override(c CloudWatchLogsAction, logGroup awslogs.ILogGroup, props *CloudWatchLogsActionProps)

Experimental.

func NewFirehoseStreamAction_Override

func NewFirehoseStreamAction_Override(f FirehoseStreamAction, stream awskinesisfirehose.IDeliveryStream, props *FirehoseStreamActionProps)

Experimental.

func NewLambdaFunctionAction_Override

func NewLambdaFunctionAction_Override(l LambdaFunctionAction, func_ awslambda.IFunction)

Experimental.

func NewS3PutObjectAction_Override

func NewS3PutObjectAction_Override(s S3PutObjectAction, bucket awss3.IBucket, props *S3PutObjectActionProps)

Experimental.

Types

type CloudWatchLogsAction

type CloudWatchLogsAction interface {
	awsiot.IAction
	Bind(rule awsiot.ITopicRule) *awsiot.ActionConfig
}

The action to send data to Amazon CloudWatch Logs.

TODO: EXAMPLE

Experimental.

func NewCloudWatchLogsAction

func NewCloudWatchLogsAction(logGroup awslogs.ILogGroup, props *CloudWatchLogsActionProps) CloudWatchLogsAction

Experimental.

type CloudWatchLogsActionProps

type CloudWatchLogsActionProps struct {
	// The IAM role that allows access to AWS service.
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Configuration properties of an action for CloudWatch Logs. Experimental.

type CommonActionProps

type CommonActionProps struct {
	// The IAM role that allows access to AWS service.
	// Experimental.
	Role awsiam.IRole `json:"role"`
}

Common properties shared by Actions it access to AWS service. Experimental.

type FirehoseStreamAction

type FirehoseStreamAction interface {
	awsiot.IAction
	Bind(rule awsiot.ITopicRule) *awsiot.ActionConfig
}

The action to put the record from an MQTT message to the Kinesis Data Firehose stream.

TODO: EXAMPLE

Experimental.

func NewFirehoseStreamAction

func NewFirehoseStreamAction(stream awskinesisfirehose.IDeliveryStream, props *FirehoseStreamActionProps) FirehoseStreamAction

Experimental.

type FirehoseStreamActionProps

type FirehoseStreamActionProps struct {
	// The IAM role that allows access to AWS service.
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// Whether to deliver the Kinesis Data Firehose stream as a batch by using `PutRecordBatch`.
	//
	// When batchMode is true and the rule's SQL statement evaluates to an Array, each Array
	// element forms one record in the PutRecordBatch request. The resulting array can't have
	// more than 500 records.
	// Experimental.
	BatchMode *bool `json:"batchMode"`
	// A character separator that will be used to separate records written to the Kinesis Data Firehose stream.
	// Experimental.
	RecordSeparator FirehoseStreamRecordSeparator `json:"recordSeparator"`
}

Configuration properties of an action for the Kinesis Data Firehose stream.

TODO: EXAMPLE

Experimental.

type FirehoseStreamRecordSeparator

type FirehoseStreamRecordSeparator string

Record Separator to be used to separate records.

TODO: EXAMPLE

Experimental.

const (
	FirehoseStreamRecordSeparator_NEWLINE         FirehoseStreamRecordSeparator = "NEWLINE"
	FirehoseStreamRecordSeparator_TAB             FirehoseStreamRecordSeparator = "TAB"
	FirehoseStreamRecordSeparator_WINDOWS_NEWLINE FirehoseStreamRecordSeparator = "WINDOWS_NEWLINE"
	FirehoseStreamRecordSeparator_COMMA           FirehoseStreamRecordSeparator = "COMMA"
)

type LambdaFunctionAction

type LambdaFunctionAction interface {
	awsiot.IAction
	Bind(topicRule awsiot.ITopicRule) *awsiot.ActionConfig
}

The action to invoke an AWS Lambda function, passing in an MQTT message.

TODO: EXAMPLE

Experimental.

func NewLambdaFunctionAction

func NewLambdaFunctionAction(func_ awslambda.IFunction) LambdaFunctionAction

Experimental.

type S3PutObjectAction

type S3PutObjectAction interface {
	awsiot.IAction
	Bind(rule awsiot.ITopicRule) *awsiot.ActionConfig
}

The action to write the data from an MQTT message to an Amazon S3 bucket.

TODO: EXAMPLE

Experimental.

func NewS3PutObjectAction

func NewS3PutObjectAction(bucket awss3.IBucket, props *S3PutObjectActionProps) S3PutObjectAction

Experimental.

type S3PutObjectActionProps

type S3PutObjectActionProps struct {
	// The IAM role that allows access to AWS service.
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// The Amazon S3 canned ACL that controls access to the object identified by the object key.
	// See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl
	//
	// Experimental.
	AccessControl awss3.BucketAccessControl `json:"accessControl"`
	// The path to the file where the data is written.
	//
	// Supports substitution templates.
	// See: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html
	//
	// Experimental.
	Key *string `json:"key"`
}

Configuration properties of an action for s3. Experimental.