Skip to content

DynamoDBAction

Source code in docs_src/capo_iot/types/dynamo_db_action.py
class DynamoDBAction(TypedDict, closed=True):
    table_name: "capo_iot.types.table_name.TableName"
    """<p>The name of the DynamoDB table.</p>"""
    role_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of the IAM role that grants access to the DynamoDB table.</p>"""
    operation: NotRequired["capo_iot.types.dynamo_operation.DynamoOperation"]
    """<p>The type of operation to be performed. This follows the substitution template, so it can be <code>${operation}</code>, but the substitution must result in one of the following: <code>INSERT</code>, <code>UPDATE</code>, or <code>DELETE</code>.</p>"""
    hash_key_field: "capo_iot.types.hash_key_field.HashKeyField"
    """<p>The hash key name.</p>"""
    hash_key_value: "capo_iot.types.hash_key_value.HashKeyValue"
    """<p>The hash key value.</p>"""
    hash_key_type: NotRequired["capo_iot.types.dynamo_key_type.DynamoKeyType"]
    """<p>The hash key type. Valid values are "STRING" or "NUMBER"</p>"""
    range_key_field: NotRequired["capo_iot.types.range_key_field.RangeKeyField"]
    """<p>The range key name.</p>"""
    range_key_value: NotRequired["capo_iot.types.range_key_value.RangeKeyValue"]
    """<p>The range key value.</p>"""
    range_key_type: NotRequired["capo_iot.types.dynamo_key_type.DynamoKeyType"]
    """<p>The range key type. Valid values are "STRING" or "NUMBER"</p>"""
    payload_field: NotRequired["capo_iot.types.payload_field.PayloadField"]
    """<p>The action payload. This name can be customized.</p>"""

hash_key_field instance-attribute

hash_key_field: HashKeyField

The hash key name.

hash_key_type instance-attribute

hash_key_type: NotRequired[DynamoKeyType]

The hash key type. Valid values are "STRING" or "NUMBER"

hash_key_value instance-attribute

hash_key_value: HashKeyValue

The hash key value.

operation instance-attribute

operation: NotRequired[DynamoOperation]

The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.

payload_field instance-attribute

payload_field: NotRequired[PayloadField]

The action payload. This name can be customized.

range_key_field instance-attribute

range_key_field: NotRequired[RangeKeyField]

The range key name.

range_key_type instance-attribute

range_key_type: NotRequired[DynamoKeyType]

The range key type. Valid values are "STRING" or "NUMBER"

range_key_value instance-attribute

range_key_value: NotRequired[RangeKeyValue]

The range key value.

role_arn instance-attribute

role_arn: AwsArn

The ARN of the IAM role that grants access to the DynamoDB table.

table_name instance-attribute

table_name: TableName

The name of the DynamoDB table.