Struct aws_sdk_iotevents::types::builders::AlarmActionBuilder

#[non_exhaustive]
pub struct AlarmActionBuilder { /* private fields */ }

A builder for AlarmAction.

Implementations

impl AlarmActionBuilder

pub fn sns(self, input: SnsTopicPublishAction) -> Self

Information required to publish the Amazon SNS message.

pub fn set_sns(self, input: Option<SnsTopicPublishAction>) -> Self

Information required to publish the Amazon SNS message.

pub fn get_sns(&self) -> &Option<SnsTopicPublishAction>

Information required to publish the Amazon SNS message.

pub fn iot_topic_publish(self, input: IotTopicPublishAction) -> Self

Information required to publish the MQTT message through the AWS IoT message broker.

pub fn set_iot_topic_publish(self, input: Option<IotTopicPublishAction>) -> Self

Information required to publish the MQTT message through the AWS IoT message broker.

pub fn get_iot_topic_publish(&self) -> &Option<IotTopicPublishAction>

Information required to publish the MQTT message through the AWS IoT message broker.

pub fn lambda(self, input: LambdaAction) -> Self

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

pub fn set_lambda(self, input: Option<LambdaAction>) -> Self

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

pub fn get_lambda(&self) -> &Option<LambdaAction>

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

pub fn iot_events(self, input: IotEventsAction) -> Self

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

pub fn set_iot_events(self, input: Option<IotEventsAction>) -> Self

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

pub fn get_iot_events(&self) -> &Option<IotEventsAction>

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

pub fn sqs(self, input: SqsAction) -> Self

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

pub fn set_sqs(self, input: Option<SqsAction>) -> Self

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

pub fn get_sqs(&self) -> &Option<SqsAction>

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

pub fn firehose(self, input: FirehoseAction) -> Self

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

pub fn set_firehose(self, input: Option<FirehoseAction>) -> Self

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

pub fn get_firehose(&self) -> &Option<FirehoseAction>

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

pub fn dynamo_db(self, input: DynamoDbAction) -> Self

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

• For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the hashKeyValue parameter uses a substitution template.

  '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

• For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the tableName parameter uses a string concatenation.

  'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is _raw .

pub fn set_dynamo_db(self, input: Option<DynamoDbAction>) -> Self

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

• For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the hashKeyValue parameter uses a substitution template.

  '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

• For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the tableName parameter uses a string concatenation.

  'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is _raw .

pub fn get_dynamo_db(&self) -> &Option<DynamoDbAction>

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

• For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the hashKeyValue parameter uses a substitution template.

  '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

• For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the tableName parameter uses a string concatenation.

  'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is _raw .

pub fn dynamo_dbv2(self, input: DynamoDBv2Action) -> Self

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.

• For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

  '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

• For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the tableName parameter uses a string concatenation.

  'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

pub fn set_dynamo_dbv2(self, input: Option<DynamoDBv2Action>) -> Self

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.

• For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

  '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

• For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the tableName parameter uses a string concatenation.

  'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

pub fn get_dynamo_dbv2(&self) -> &Option<DynamoDBv2Action>

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.

• For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

  '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

• For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the tableName parameter uses a string concatenation.

  'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

pub fn iot_site_wise(self, input: IotSiteWiseAction) -> Self

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

• For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the propertyAlias parameter uses a substitution template.

  'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

pub fn set_iot_site_wise(self, input: Option<IotSiteWiseAction>) -> Self

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

• For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the propertyAlias parameter uses a substitution template.

  'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

pub fn get_iot_site_wise(&self) -> &Option<IotSiteWiseAction>

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

• For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

• For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

• For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

  In the following example, the value for the propertyAlias parameter uses a substitution template.

  'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

pub fn build(self) -> AlarmAction

Consumes the builder and constructs a AlarmAction.

Trait Implementations

impl Clone for AlarmActionBuilder

fn clone(&self) -> AlarmActionBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AlarmActionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AlarmActionBuilder

fn default() -> AlarmActionBuilder

Returns the “default value” for a type.

impl PartialEq for AlarmActionBuilder

fn eq(&self, other: &AlarmActionBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AlarmActionBuilder