OpenSearchActionProps

class aws_cdk.aws_iot_actions_alpha.OpenSearchActionProps(*, role=None, id, index, type)

Bases: CommonActionProps

(experimental) Configuration properties of an action for Open Search.

Parameters:

role (Optional[IRole]) – (experimental) The IAM role that allows access to AWS service. Default: a new role will be created
id (str) – (experimental) The unique identifier for the document you are storing.
index (str) – (experimental) The OpenSearch index where you want to store your data.
type (str) – (experimental) The type of document you are storing.

Stability:

experimental

ExampleMetadata:

infused

Example:

import aws_cdk.aws_opensearchservice as opensearch
# domain: opensearch.Domain


topic_rule = iot.TopicRule(self, "TopicRule",
    sql=iot.IotSql.from_string_as_ver20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'")
)

topic_rule.add_action(actions.OpenSearchAction(domain,
    id="my-id",
    index="my-index",
    type="my-type"
))

Attributes

id

(experimental) The unique identifier for the document you are storing.

Stability:: experimental

index

(experimental) The OpenSearch index where you want to store your data.

Stability:: experimental

role

(experimental) The IAM role that allows access to AWS service.

Default:: a new role will be created
Stability:: experimental

type

(experimental) The type of document you are storing.

Stability:: experimental