Package software.amazon.awssdk.services.iot.model

Class Action

java.lang.Object
software.amazon.awssdk.services.iot.model.Action
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Action.Builder,Action>
@Generated("software.amazon.awssdk:codegen") public final class Action extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Action.Builder,Action>

Describes the actions associated with a rule.

See Also:

  • Method Details

    • dynamoDB

      public final DynamoDBAction dynamoDB()

      Write to a DynamoDB table.

      Returns:
      Write to a DynamoDB table.

    • dynamoDBv2

      public final DynamoDBv2Action dynamoDBv2()

      Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

      Returns:
      Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

    • lambda

      public final LambdaAction lambda()

      Invoke a Lambda function.

      Returns:
      Invoke a Lambda function.

    • sns

      public final SnsAction sns()

      Publish to an Amazon SNS topic.

      Returns:
      Publish to an Amazon SNS topic.

    • sqs

      public final SqsAction sqs()

      Publish to an Amazon SQS queue.

      Returns:
      Publish to an Amazon SQS queue.

    • kinesis

      public final KinesisAction kinesis()

      Write data to an Amazon Kinesis stream.

      Returns:
      Write data to an Amazon Kinesis stream.

    • republish

      public final RepublishAction republish()

      Publish to another MQTT topic.

      Returns:
      Publish to another MQTT topic.

    • s3

      public final S3Action s3()

      Write to an Amazon S3 bucket.

      Returns:
      Write to an Amazon S3 bucket.

    • firehose

      public final FirehoseAction firehose()

      Write to an Amazon Kinesis Firehose stream.

      Returns:
      Write to an Amazon Kinesis Firehose stream.

    • cloudwatchMetric

      public final CloudwatchMetricAction cloudwatchMetric()

      Capture a CloudWatch metric.

      Returns:
      Capture a CloudWatch metric.

    • cloudwatchAlarm

      public final CloudwatchAlarmAction cloudwatchAlarm()

      Change the state of a CloudWatch alarm.

      Returns:
      Change the state of a CloudWatch alarm.

    • cloudwatchLogs

      public final CloudwatchLogsAction cloudwatchLogs()

      Send data to CloudWatch Logs.

      Returns:
      Send data to CloudWatch Logs.

    • elasticsearch

      public final ElasticsearchAction elasticsearch()

      Write data to an Amazon OpenSearch Service domain.

      The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

      Returns:
      Write data to an Amazon OpenSearch Service domain.

      The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

    • salesforce

      public final SalesforceAction salesforce()

      Send a message to a Salesforce IoT Cloud Input Stream.

      Returns:
      Send a message to a Salesforce IoT Cloud Input Stream.

    • iotAnalytics

      public final IotAnalyticsAction iotAnalytics()

      Sends message data to an IoT Analytics channel.

      Returns:
      Sends message data to an IoT Analytics channel.

    • iotEvents

      public final IotEventsAction iotEvents()

      Sends an input to an IoT Events detector.

      Returns:
      Sends an input to an IoT Events detector.

    • iotSiteWise

      public final IotSiteWiseAction iotSiteWise()

      Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

      Returns:
      Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

    • stepFunctions

      public final StepFunctionsAction stepFunctions()

      Starts execution of a Step Functions state machine.

      Returns:
      Starts execution of a Step Functions state machine.

    • timestream

      public final TimestreamAction timestream()

      The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

      Returns:
      The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

    • http

      public final HttpAction http()

      Send data to an HTTPS endpoint.

      Returns:
      Send data to an HTTPS endpoint.

    • kafka

      public final KafkaAction kafka()

      Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

      Returns:
      Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

    • openSearch

      public final OpenSearchAction openSearch()

      Write data to an Amazon OpenSearch Service domain.

      Returns:
      Write data to an Amazon OpenSearch Service domain.

    • location

      public final LocationAction location()

      The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

      Returns:
      The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

    • toBuilder

      public Action.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Action.Builder,Action>
      Returns:
      a builder for type T

    • builder

      public static Action.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Action.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.