|
| 1 | +--- |
| 2 | +title: ticloud serverless audit-log config update |
| 3 | +summary: The reference of `ticloud serverless audit-log config update`. |
| 4 | +--- |
| 5 | + |
| 6 | +# ticloud serverless audit-log config update |
| 7 | + |
| 8 | +Update the database audit logging configuration for a TiDB Cloud Essential cluster. |
| 9 | + |
| 10 | +```shell |
| 11 | +ticloud serverless audit-log config update [flags] |
| 12 | +``` |
| 13 | + |
| 14 | +## Examples |
| 15 | + |
| 16 | +Configure database audit logging in interactive mode: |
| 17 | + |
| 18 | +```shell |
| 19 | +ticloud serverless audit-log config update |
| 20 | +``` |
| 21 | + |
| 22 | +Unredact the database audit log in non-interactive mode: |
| 23 | + |
| 24 | +```shell |
| 25 | +ticloud serverless audit-log config update -c <cluster-id> --unredacted |
| 26 | +``` |
| 27 | + |
| 28 | +Enable database audit logging with S3 Cloud Storage in non-interactive mode: |
| 29 | + |
| 30 | +```shell |
| 31 | +ticloud serverless audit-log config update -c <cluster-id> --enabled --cloud-storage S3 --s3.uri <s3-uri> --s3.access-key-id <s3-access-key-id> --s3.secret-access-key <s3-secret-access-key> |
| 32 | +``` |
| 33 | + |
| 34 | +Configure database audit logging rotation strategy in non-interactive mode: |
| 35 | + |
| 36 | +```shell |
| 37 | +ticloud serverless audit-log config update -c <cluster-id> --rotation-interval-minutes <rotation-interval-minutes> --rotation-size-mib <rotation-size-mib> |
| 38 | +``` |
| 39 | + |
| 40 | +Disable database audit logging in non-interactive mode: |
| 41 | + |
| 42 | +```shell |
| 43 | +ticloud serverless audit-log config update -c <cluster-id> --enabled=false |
| 44 | +``` |
| 45 | + |
| 46 | +## Flags |
| 47 | + |
| 48 | +| Flag | Description | Required | Note | |
| 49 | +|------|-------------|----------|------| |
| 50 | +| --azblob.sas-token string | The SAS token of Azure Blob. | No | Only works in non-interactive mode. | |
| 51 | +| --azblob.uri string | The Azure Blob URI in `azure://<account>.blob.core.windows.net/<container>/<path>` format. | No | Only works in non-interactive mode. | |
| 52 | +| --cloud-storage string | The cloud storage. One of ["TIDB_CLOUD", "S3", "GCS", "AZURE_BLOB", "OSS"]. | No | Only works in non-interactive mode. | |
| 53 | +| -c, --cluster-id string | The ID of the cluster to be updated. | Yes | Only works in non-interactive mode. | |
| 54 | +| --enabled | Enable or disable database audit logging. | No | Only works in non-interactive mode. | |
| 55 | +| --gcs.service-account-key string | The base64 encoded service account key of GCS. | No | Only works in non-interactive mode. | |
| 56 | +| --gcs.uri string | The GCS URI in `gs://<bucket>/<path>` format. | No | Only works in non-interactive mode. | |
| 57 | +| --oss.access-key-id string | The access key ID of the OSS. | No | Only works in non-interactive mode. | |
| 58 | +| --oss.access-key-secret string | The access key secret of the OSS. | No | Only works in non-interactive mode. | |
| 59 | +| --oss.uri string | The OSS URI in `oss://<bucket>/<path>` format. | No | Only works in non-interactive mode. | |
| 60 | +| --rotation-interval-minutes int32 | The rotation interval in minutes, range [10, 1440]. | No | Only works in non-interactive mode. | |
| 61 | +| --rotation-size-mib int32 | The rotation size in MiB, range [1, 1024]. | No | Only works in non-interactive mode. | |
| 62 | +| --s3.access-key-id string | The access key ID of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key]. | No | Only works in non-interactive mode. | |
| 63 | +| --s3.role-arn string | The role arn of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key]. | No | Only works in non-interactive mode. | |
| 64 | +| --s3.secret-access-key string | The secret access key of the S3. You only need to set one of the s3.role-arn and [s3.access-key-id, s3.secret-access-key]. | No | Only works in non-interactive mode. | |
| 65 | +| --s3.uri string | The S3 URI in `s3://<bucket>/<path>` format. | No | Only works in non-interactive mode. | |
| 66 | +| --unredacted | Unredact or redact the database audit log. | No | Only works in non-interactive mode. | |
| 67 | +| -h, --help | Shows help information for this command. | No | Works in both interactive and non-interactive modes. | |
| 68 | + |
| 69 | +## Inherited flags |
| 70 | + |
| 71 | +| Flag | Description | Required | Note | |
| 72 | +|------|-------------|----------|------| |
| 73 | +| -D, --debug | Enable debug mode. | No | Works in both interactive and non-interactive modes. | |
| 74 | +| --no-color | Disable color output. | No | Only works in non-interactive mode. | |
| 75 | +| -P, --profile string | Profile to use from your configuration file. | No | Works in both interactive and non-interactive modes. | |
| 76 | + |
| 77 | +## Feedback |
| 78 | + |
| 79 | +If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any |
0 commit comments