- NAME
-
- gcloud scc custom-modules sha create - create a Security Health Analytics custom module
- SYNOPSIS
-
-
gcloud scc custom-modules sha create
--custom-config-from-file
=PATH_TO_FILE
--display-name
=DISPLAY_NAME
--enablement-state
=ENABLEMENT_STATE
[--folder
=FOLDER
|--organization
=ORGANIZATION
|--project
=PROJECT
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Create a Security Health Analytics custom module.
- EXAMPLES
-
To create a Security Health Analytics custom module for given organization
123
, run:gcloud scc custom-modules sha create --organization=organizations/123 --display-name="test_display_name" --enablement-state="ENABLED" --custom-config-from-file=custom_config.yaml
To create a Security Health Analytics custom module for given folder
456
, run:gcloud scc custom-modules sha create --folder=folders/456 --display-name="test_display_name" --enablement-state="ENABLED" --custom-config-from-file=custom_config.yaml
To create a Security Health Analytics custom module for given project
789
, run:gcloud scc custom-modules sha create --project=projects/789 --display-name="test_display_name" --enablement-state="ENABLED" --custom-config-from-file=custom_config.yaml
- REQUIRED FLAGS
-
--custom-config-from-file
=PATH_TO_FILE
- Path to a YAML file that contains the configuration for the Security Health Analytics custom module. Use a full or relative path to a local file containing the value of custom_config.
--display-name
=DISPLAY_NAME
- Sets the display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
--enablement-state
=ENABLEMENT_STATE
-
Sets the enablement state of the Security Health Analytics custom module. From
the following list of possible enablement states, specify either enabled or
disabled only.
ENABLEMENT_STATE
must be one of:disabled
,enabled
,enablement-state-unspecified
,inherited
.
- OPTIONAL FLAGS
-
-
At most one of these can be specified:
--folder
=FOLDER
-
Folder where the Security Health Analytics custom module resides. Formatted as
folders/456
or just456
. --organization
=ORGANIZATION
-
Organization where the Security Health Analytics custom module resides.
Formatted as
organizations/123
or just123
. --project
=PROJECT
-
ID or number of the project where the Security Health Analytics custom module
resides. Formatted as
projects/789
or just789
.
-
At most one of these can be specified:
- 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. - API REFERENCE
-
This command uses the
securitycenter/v1
API. The full documentation for this API can be found at: https://cloud.google.com/security-command-center - NOTES
-
This variant is also available:
gcloud alpha scc custom-modules sha create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-30 UTC.