configure-archiving¶

Description¶

Configures the audit system for archiving audit events to an external cloud storage service, replacing any existing configuration. Also returns the current configuration.

Synopsis¶

  configure-archiving
--storage-location <value>
--credential-name <value>
--enabled | --no-enabled
[--storage-region <value>]
[--verify-only | --no-verify-only]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--storage-location (string)

The destination for the logs, e.g. S3 bucket name

--credential-name (string)

The credential name or CRN to use

--enabled | --no-enabled (boolean)

Flag to enable/disable the archiving process

--storage-region (string)

The region to work with when accessing the logs, e.g. S3 region

--verify-only | --no-verify-only (boolean)

Whether to only verify the configuration, and not update it.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

configuration -> (object)

Object for holding archiving configuration information for the audit service.

storageLocation -> (string)

The destination for the logs, e.g. S3 bucket name

credentialName -> (string)

The credential name or CRN to use

enabled -> (boolean)

Flag to enable/disable the archiving process

storageRegion -> (string)

The region to work with when accessing the logs, e.g. S3 region

Form Factors¶

public