ActionConfig

class aws_cdk.aws_iot_alpha.ActionConfig(*, configuration)

Bases: object

(experimental) Properties for an topic rule action.

Parameters:

configuration (Union[ActionProperty, Dict[str, Any]]) – (experimental) The configuration for this action.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot_alpha as iot_alpha

action_config = iot_alpha.ActionConfig(
    configuration=ActionProperty(
        cloudwatch_alarm=CloudwatchAlarmActionProperty(
            alarm_name="alarmName",
            role_arn="roleArn",
            state_reason="stateReason",
            state_value="stateValue"
        ),
        cloudwatch_logs=CloudwatchLogsActionProperty(
            log_group_name="logGroupName",
            role_arn="roleArn",

            # the properties below are optional
            batch_mode=False
        ),
        cloudwatch_metric=CloudwatchMetricActionProperty(
            metric_name="metricName",
            metric_namespace="metricNamespace",
            metric_unit="metricUnit",
            metric_value="metricValue",
            role_arn="roleArn",

            # the properties below are optional
            metric_timestamp="metricTimestamp"
        ),
        dynamo_db=DynamoDBActionProperty(
            hash_key_field="hashKeyField",
            hash_key_value="hashKeyValue",
            role_arn="roleArn",
            table_name="tableName",

            # the properties below are optional
            hash_key_type="hashKeyType",
            payload_field="payloadField",
            range_key_field="rangeKeyField",
            range_key_type="rangeKeyType",
            range_key_value="rangeKeyValue"
        ),
        dynamo_dBv2=DynamoDBv2ActionProperty(
            put_item=PutItemInputProperty(
                table_name="tableName"
            ),
            role_arn="roleArn"
        ),
        elasticsearch=ElasticsearchActionProperty(
            endpoint="endpoint",
            id="id",
            index="index",
            role_arn="roleArn",
            type="type"
        ),
        firehose=FirehoseActionProperty(
            delivery_stream_name="deliveryStreamName",
            role_arn="roleArn",

            # the properties below are optional
            batch_mode=False,
            separator="separator"
        ),
        http=HttpActionProperty(
            url="url",

            # the properties below are optional
            auth=HttpAuthorizationProperty(
                sigv4=SigV4AuthorizationProperty(
                    role_arn="roleArn",
                    service_name="serviceName",
                    signing_region="signingRegion"
                )
            ),
            confirmation_url="confirmationUrl",
            headers=[HttpActionHeaderProperty(
                key="key",
                value="value"
            )]
        ),
        iot_analytics=IotAnalyticsActionProperty(
            channel_name="channelName",
            role_arn="roleArn",

            # the properties below are optional
            batch_mode=False
        ),
        iot_events=IotEventsActionProperty(
            input_name="inputName",
            role_arn="roleArn",

            # the properties below are optional
            batch_mode=False,
            message_id="messageId"
        ),
        iot_site_wise=IotSiteWiseActionProperty(
            put_asset_property_value_entries=[PutAssetPropertyValueEntryProperty(
                property_values=[AssetPropertyValueProperty(
                    timestamp=AssetPropertyTimestampProperty(
                        time_in_seconds="timeInSeconds",

                        # the properties below are optional
                        offset_in_nanos="offsetInNanos"
                    ),
                    value=AssetPropertyVariantProperty(
                        boolean_value="booleanValue",
                        double_value="doubleValue",
                        integer_value="integerValue",
                        string_value="stringValue"
                    ),

                    # the properties below are optional
                    quality="quality"
                )],

                # the properties below are optional
                asset_id="assetId",
                entry_id="entryId",
                property_alias="propertyAlias",
                property_id="propertyId"
            )],
            role_arn="roleArn"
        ),
        kafka=KafkaActionProperty(
            client_properties={
                "client_properties_key": "clientProperties"
            },
            destination_arn="destinationArn",
            topic="topic",

            # the properties below are optional
            headers=[KafkaActionHeaderProperty(
                key="key",
                value="value"
            )],
            key="key",
            partition="partition"
        ),
        kinesis=KinesisActionProperty(
            role_arn="roleArn",
            stream_name="streamName",

            # the properties below are optional
            partition_key="partitionKey"
        ),
        lambda_=LambdaActionProperty(
            function_arn="functionArn"
        ),
        location=LocationActionProperty(
            device_id="deviceId",
            latitude="latitude",
            longitude="longitude",
            role_arn="roleArn",
            tracker_name="trackerName",

            # the properties below are optional
            timestamp=TimestampProperty(
                value="value",

                # the properties below are optional
                unit="unit"
            )
        ),
        open_search=OpenSearchActionProperty(
            endpoint="endpoint",
            id="id",
            index="index",
            role_arn="roleArn",
            type="type"
        ),
        republish=RepublishActionProperty(
            role_arn="roleArn",
            topic="topic",

            # the properties below are optional
            headers=RepublishActionHeadersProperty(
                content_type="contentType",
                correlation_data="correlationData",
                message_expiry="messageExpiry",
                payload_format_indicator="payloadFormatIndicator",
                response_topic="responseTopic",
                user_properties=[UserPropertyProperty(
                    key="key",
                    value="value"
                )]
            ),
            qos=123
        ),
        s3=S3ActionProperty(
            bucket_name="bucketName",
            key="key",
            role_arn="roleArn",

            # the properties below are optional
            canned_acl="cannedAcl"
        ),
        sns=SnsActionProperty(
            role_arn="roleArn",
            target_arn="targetArn",

            # the properties below are optional
            message_format="messageFormat"
        ),
        sqs=SqsActionProperty(
            queue_url="queueUrl",
            role_arn="roleArn",

            # the properties below are optional
            use_base64=False
        ),
        step_functions=StepFunctionsActionProperty(
            role_arn="roleArn",
            state_machine_name="stateMachineName",

            # the properties below are optional
            execution_name_prefix="executionNamePrefix"
        ),
        timestream=TimestreamActionProperty(
            database_name="databaseName",
            dimensions=[TimestreamDimensionProperty(
                name="name",
                value="value"
            )],
            role_arn="roleArn",
            table_name="tableName",

            # the properties below are optional
            timestamp=TimestreamTimestampProperty(
                unit="unit",
                value="value"
            )
        )
    )
)

Attributes

configuration

(experimental) The configuration for this action.

Stability:

experimental