# JsonFileLogDriverProps

Specifies the json-file log driver configuration options.

[Source](https://docs.docker.com/config/containers/logging/json-file/)

Extends: JsonFileLogDriverProps
Extends: BaseLogDriverProps
Used as props by: JsonFileLogDriver

- Source: [`aws-ecs/lib/log-drivers/json-file-log-driver.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-ecs/lib/log-drivers/json-file-log-driver.ts#L15)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const jsonFileLogDriverProps: ecs.JsonFileLogDriverProps = {
  compress: false,
  env: ['env'],
  envRegex: 'envRegex',
  labels: ['labels'],
  maxFile: 123,
  maxSize: 'maxSize',
  tag: 'tag',
};
```

## Properties

- `compress`: boolean = false — Toggles compression for rotated logs.

- `env`: string[] — The env option takes an array of keys.

  **Default:** No env

  If there is collision between
  label and env keys, the value of the env takes precedence. Adds additional fields
  to the extra attributes of a logging message.

- `envRegex`: string — The env-regex option is similar to and compatible with env.

  **Default:** No envRegex

  Its value is a regular
  expression to match logging-related environment variables. It is used for advanced
  log tag options.

- `labels`: string[] — The labels option takes an array of keys.

  **Default:** No labels

  If there is collision
  between label and env keys, the value of the env takes precedence. Adds additional
  fields to the extra attributes of a logging message.

- `maxFile`: number = 1 — The maximum number of log files that can be present.

  If rolling the logs creates
  excess files, the oldest file is removed. Only effective when max-size is also set.
  A positive integer.

- `maxSize`: string — The maximum size of the log before it is rolled.

  **Default:** -1 (unlimited)

  A positive integer plus a modifier
  representing the unit of measure (k, m, or g).

- `tag`: string — By default, Docker uses the first 12 characters of the container ID to tag log messages.

  **Default:** The first 12 characters of the container ID

  Refer to the log tag option documentation for customizing the
  log tag format.