TopicRuleDestination ¶

class TopicRuleDestination(TypedDict, closed=True):
    arn: NotRequired["capo_iot.types.aws_arn.AwsArn"]
    """<p>The topic rule destination URL.</p>"""
    status: NotRequired[
        "capo_iot.types.topic_rule_destination_status.TopicRuleDestinationStatus"
    ]
    """<p>The status of the topic rule destination. Valid values are:</p> <dl> <dt>IN_PROGRESS</dt> <dd> <p>A topic rule destination was created but has not been confirmed. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling <code>UpdateTopicRuleDestination</code>. Calling <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to be sent to your confirmation endpoint.</p> </dd> <dt>ENABLED</dt> <dd> <p>Confirmation was completed, and traffic to this destination is allowed. You can set <code>status</code> to <code>DISABLED</code> by calling <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>DISABLED</dt> <dd> <p>Confirmation was completed, and traffic to this destination is not allowed. You can set <code>status</code> to <code>ENABLED</code> by calling <code>UpdateTopicRuleDestination</code>.</p> </dd> <dt>ERROR</dt> <dd> <p>Confirmation could not be completed, for example if the confirmation timed out. You can call <code>GetTopicRuleDestination</code> for details about the error. You can set <code>status</code> to <code>IN_PROGRESS</code> by calling <code>UpdateTopicRuleDestination</code>. Calling <code>UpdateTopicRuleDestination</code> causes a new confirmation challenge to be sent to your confirmation endpoint.</p> </dd> </dl>"""
    created_at: NotRequired["capo_iot.types.created_at_date.CreatedAtDate"]
    """<p>The date and time when the topic rule destination was created.</p>"""
    last_updated_at: NotRequired[
        "capo_iot.types.last_updated_at_date.LastUpdatedAtDate"
    ]
    """<p>The date and time when the topic rule destination was last updated.</p>"""
    status_reason: NotRequired["capo_iot.types.string.String"]
    """<p>Additional details or reason why the topic rule destination is in the current status.</p>"""
    http_url_properties: NotRequired[
        "capo_iot.types.http_url_destination_properties.HttpUrlDestinationProperties"
    ]
    """<p>Properties of the HTTP URL.</p>"""
    vpc_properties: NotRequired[
        "capo_iot.types.vpc_destination_properties.VpcDestinationProperties"
    ]
    """<p>Properties of the virtual private cloud (VPC) connection.</p>"""
    influx_db_properties: NotRequired[
        "capo_iot.types.influx_db_destination_properties.InfluxDBDestinationProperties"
    ]
    """<p>The properties of an InfluxDB topic rule destination, as returned by <code>CreateTopicRuleDestination</code> and <code>GetTopicRuleDestination</code>.</p>"""