Documentation

Describes a flow log.

See: newFlowLog smart constructor.

Create a value of FlowLog with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:FlowLog', flowLog_creationTime - The date and time the flow log was created.

$sel:deliverCrossAccountRole:FlowLog', flowLog_deliverCrossAccountRole - The ARN of the IAM role that allows the service to publish flow logs across accounts.

$sel:deliverLogsErrorMessage:FlowLog', flowLog_deliverLogsErrorMessage - 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.

$sel:deliverLogsPermissionArn:FlowLog', flowLog_deliverLogsPermissionArn - The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.

$sel:deliverLogsStatus:FlowLog', flowLog_deliverLogsStatus - The status of the logs delivery (SUCCESS | FAILED).

$sel:destinationOptions:FlowLog', flowLog_destinationOptions - The destination options.

$sel:flowLogId:FlowLog', flowLog_flowLogId - The ID of the flow log.

$sel:flowLogStatus:FlowLog', flowLog_flowLogStatus - The status of the flow log (ACTIVE).

$sel:logDestination:FlowLog', flowLog_logDestination - The Amazon Resource Name (ARN) of the destination for the flow log data.

$sel:logDestinationType:FlowLog', flowLog_logDestinationType - The type of destination for the flow log data.

$sel:logFormat:FlowLog', flowLog_logFormat - The format of the flow log record.

$sel:logGroupName:FlowLog', flowLog_logGroupName - The name of the flow log group.

$sel:maxAggregationInterval:FlowLog', flowLog_maxAggregationInterval - 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

$sel:resourceId:FlowLog', flowLog_resourceId - The ID of the resource being monitored.

$sel:tags:FlowLog', flowLog_tags - The tags for the flow log.

$sel:trafficType:FlowLog', flowLog_trafficType - The type of traffic captured for the flow log.

The date and time the flow log was created.

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

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.

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

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

The destination options.

The ID of the flow log.

The status of the flow log (ACTIVE).

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

The type of destination for the flow log data.

The format of the flow log record.

The name of the flow log group.

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

The ID of the resource being monitored.

The tags for the flow log.

The type of traffic captured for the flow log.