Skip to content

FlowLog

Source code in docs_src/capo_ec2/types/flow_log.py
class FlowLog(TypedDict, closed=True):
    creation_time: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>The date and time the flow log was created.</p>"""
    deliver_logs_error_message: NotRequired["capo_ec2.types.string.String"]
    """<p>Information about the error that occurred. <code>Rate limited</code> indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. <code>Access error</code> indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. <code>Unknown error</code> indicates an internal error.</p>"""
    deliver_logs_permission_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.</p>"""
    deliver_cross_account_role: NotRequired["capo_ec2.types.string.String"]
    """<p>The ARN of the IAM role that allows the service to publish flow logs across accounts.</p>"""
    deliver_logs_status: NotRequired["capo_ec2.types.string.String"]
    """<p>The status of the logs delivery (<code>SUCCESS</code> | <code>FAILED</code>).</p>"""
    flow_log_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the flow log.</p>"""
    flow_log_status: NotRequired["capo_ec2.types.string.String"]
    """<p>The status of the flow log (<code>ACTIVE</code>).</p>"""
    log_group_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the flow log group.</p>"""
    resource_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the resource being monitored.</p>"""
    traffic_type: NotRequired["capo_ec2.types.traffic_type.TrafficType"]
    """<p>The type of traffic captured for the flow log.</p>"""
    log_destination_type: NotRequired[
        "capo_ec2.types.log_destination_type.LogDestinationType"
    ]
    """<p>The type of destination for the flow log data.</p>"""
    log_destination: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the destination for the flow log data.</p>"""
    log_format: NotRequired["capo_ec2.types.string.String"]
    """<p>The format of the flow log record.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags for the flow log.</p>"""
    max_aggregation_interval: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.</p> <p>When a network interface is attached to a <a href="https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html">Nitro-based instance</a>, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.</p> <p>Valid Values: <code>60</code> | <code>600</code> </p>"""
    destination_options: NotRequired[
        "capo_ec2.types.destination_options_response.DestinationOptionsResponse"
    ]
    """<p>The destination options.</p>"""
    tag_field_specifications: NotRequired[
        "capo_ec2.types.tag_field_specification_list_response.TagFieldSpecificationListResponse"
    ]
    """<p>The tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format.</p>"""

creation_time instance-attribute

creation_time: NotRequired[MillisecondDateTime]

The date and time the flow log was created.

deliver_cross_account_role instance-attribute

deliver_cross_account_role: NotRequired[String]

The ARN of the IAM role that allows the service to publish flow logs across accounts.

deliver_logs_error_message instance-attribute

deliver_logs_error_message: NotRequired[String]

Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

deliver_logs_permission_arn instance-attribute

deliver_logs_permission_arn: NotRequired[String]

The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.

deliver_logs_status instance-attribute

deliver_logs_status: NotRequired[String]

The status of the logs delivery (SUCCESS | FAILED).

destination_options instance-attribute

destination_options: NotRequired[DestinationOptionsResponse]

The destination options.

flow_log_id instance-attribute

flow_log_id: NotRequired[String]

The ID of the flow log.

flow_log_status instance-attribute

flow_log_status: NotRequired[String]

The status of the flow log (ACTIVE).

log_destination instance-attribute

log_destination: NotRequired[String]

The Amazon Resource Name (ARN) of the destination for the flow log data.

log_destination_type instance-attribute

log_destination_type: NotRequired[LogDestinationType]

The type of destination for the flow log data.

log_format instance-attribute

log_format: NotRequired[String]

The format of the flow log record.

log_group_name instance-attribute

log_group_name: NotRequired[String]

The name of the flow log group.

max_aggregation_interval instance-attribute

max_aggregation_interval: NotRequired[Integer]

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.

Valid Values: 60 | 600

resource_id instance-attribute

resource_id: NotRequired[String]

The ID of the resource being monitored.

tag_field_specifications instance-attribute

tag_field_specifications: NotRequired[TagFieldSpecificationListResponse]

The tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format.

tags instance-attribute

tags: NotRequired[TagList]

The tags for the flow log.

traffic_type instance-attribute

traffic_type: NotRequired[TrafficType]

The type of traffic captured for the flow log.