gcloud audit-manager audit-schedules create

NAME

gcloud audit-manager audit-schedules create - create Audit Schedule

SYNOPSIS

gcloud audit-manager audit-schedules create --audit-schedule-id=AUDIT_SCHEDULE_ID --compliance-framework=COMPLIANCE_FRAMEWORK --frequency=FREQUENCY --gcs-uri=GCS_URI --location=LOCATION --report-format=REPORT_FORMAT --start-time=START_TIME (--folder=FOLDER     | --organization=ORGANIZATION     | --project=PROJECT) [--display-name=DISPLAY_NAME] [--end-time=END_TIME] [--parameter-overrides=[PARAMETER_OVERRIDES,…]] [--time-zone=TIME_ZONE] [GCLOUD_WIDE_FLAG …]

DESCRIPTION

Create a new Audit Schedule. Parameter overrides are applied to every audit run of the schedule and cannot be changed after the schedule is created.

EXAMPLES

To create an Audit Schedule in the us-central1 region, for a project with ID 123 against the compliance framework organizations/456/locations/global/frameworks/builtin-nist-800-53-revision5 in odf format, run:

gcloud audit-manager audit-schedules create --project=123 --location=us-central1 --audit-schedule-id=my-schedule --compliance-framework=organizations/456/locations/global/frameworks/builtin-nist-800-53-revision5 --report-format=odf --gcs-uri=gs://testbucketauditmanager --start-time="2026-03-01T00:00:00Z" --frequency=DAILY

If the compliance framework is parameterized, to create the same Audit Schedule while overriding cloud control parameters defined in the file overrides.json, run:

gcloud audit-manager audit-schedules create --project=123 --location=us-central1 --audit-schedule-id=my-schedule --compliance-framework=organizations/456/locations/global/frameworks/builtin-nist-800-53-revision5 --report-format=odf --gcs-uri=gs://testbucketauditmanager --start-time="2026-03-01T00:00:00Z" --frequency=DAILY --parameter-overrides=overrides.json

REQUIRED FLAGS

--audit-schedule-id=AUDIT_SCHEDULE_ID

ID to use for the audit schedule.

--compliance-framework=COMPLIANCE_FRAMEWORK

Compliance Framework against which the Report must be generated. Eg: FEDRAMP_MODERATE

--frequency=FREQUENCY

Frequency of audit runs. FREQUENCY must be one of: daily, weekly, monthly, quarterly, annually.

--gcs-uri=GCS_URI

Destination Cloud storage bucket where report and evidence must be uploaded. The Cloud storage bucket provided here must be selected among the buckets entered during the enrollment process.

--location=LOCATION

The location where the audit schedule should be created.

--report-format=REPORT_FORMAT

The format in which the audit report should be created. REPORT_FORMAT must be (only one value is supported): odf.

--start-time=START_TIME

Date and time when the first audit run is triggered in RFC 3339 format.

Exactly one of these must be specified:

--folder=FOLDER

Folder Id for which to create audit schedule

--organization=ORGANIZATION

Organization Id for which to create audit schedule

--project=PROJECT

Project Id for which to create audit schedule

OPTIONAL FLAGS

--display-name=DISPLAY_NAME

Display name for the audit schedule.

--end-time=END_TIME

Date and time that the schedule stops in RFC 3339 format.

--parameter-overrides=[PARAMETER_OVERRIDES,…]

Overrides for the parameters of parameterized cloud controls, applied when the audit runs. Map from cloud control resource name to the overrides for that cloud control.

KEY

Full resource name of the cloud control, for example organizations/123/locations/global/cloudControls/my-control, as returned by gcloud compliance-manager cloud-controls list.

VALUE

Parameter overrides for the cloud control.

parameters

Parameters to override.

name

Name of the parameter.

parameterValue

Value of the parameter. Set exactly one of the following fields.

boolValue

A boolean value.

numberValue

A numeric value.

oneofValue

The selected sub-parameter of a oneOf parameter, with its own name and parameterValue. Can be nested up to 3 levels.

name

Name of the parameter.

parameterValue

Value of the parameter. Set exactly one of the following fields.

boolValue

A boolean value.

numberValue

A numeric value.

stringListValue

A list of strings.

values

The strings in the list.

stringValue

A string value.

stringListValue

A list of strings.

values

The strings in the list.

stringValue

A string value.

Shorthand Example:

--parameter-overrides=string={parameters=[{name=string,parameterValue={boolValue=boolean,numberValue=float,oneofValue={name=string,parameterValue={boolValue=boolean,numberValue=float,stringListValue={values=[string]},stringValue=string}},stringListValue={values=[string]},stringValue=string}}]}

JSON Example:

--parameter-overrides='{"string": {"parameters": [{"name": "string", "parameterValue": {"boolValue": boolean, "numberValue": float, "oneofValue": {"name": "string", "parameterValue": {"boolValue": boolean, "numberValue": float, "stringListValue": {"values": ["string"]}, "stringValue": "string"}}, "stringListValue": {"values": ["string"]}, "stringValue": "string"}}]}}'

File Example:

--parameter-overrides=path_to_file.(yaml|json)

--time-zone=TIME_ZONE

Time zone for the audit schedule in IANA format (e.g. America/New_York).

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES

This variant is also available:

gcloud alpha audit-manager audit-schedules create