Skip to content

RecordField

Source code in docs_src/capo_cloudwatch_logs/types/record_field.py
class RecordField(TypedDict, closed=True):
    name: NotRequired["capo_cloudwatch_logs.types.field_header.FieldHeader"]
    """<p>The name to use when specifying this record field in a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a> operation. </p>"""
    mandatory: NotRequired["capo_cloudwatch_logs.types.boolean.Boolean"]
    """<p>If this is <code>true</code>, the record field must be present in the <code>recordFields</code> parameter provided to a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a> operation.</p>"""

mandatory instance-attribute

mandatory: NotRequired[Boolean]

If this is true, the record field must be present in the recordFields parameter provided to a CreateDelivery or UpdateDeliveryConfiguration operation.

name instance-attribute

name: NotRequired[FieldHeader]

The name to use when specifying this record field in a CreateDelivery or UpdateDeliveryConfiguration operation.