ScanConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A ScanConfig resource contains the configurations to launch a scan.
Attributes | |
---|---|
Name | Description |
name |
str
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. |
display_name |
str
Required. The user provided display name of the ScanConfig. |
max_qps |
int
The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. |
starting_urls |
Sequence[str]
Required. The starting URLs from which the scanner finds site pages. |
authentication |
google.cloud.websecurityscanner_v1beta.types.ScanConfig.Authentication
The authentication configuration. If specified, service will use the authentication configuration during scanning. |
user_agent |
google.cloud.websecurityscanner_v1beta.types.ScanConfig.UserAgent
The user agent used during scanning. |
blacklist_patterns |
Sequence[str]
The blacklist URL patterns as described in https://cloud.google.com/security- scanner/docs/excluded-urls |
schedule |
google.cloud.websecurityscanner_v1beta.types.ScanConfig.Schedule
The schedule of the ScanConfig. |
target_platforms |
Sequence[google.cloud.websecurityscanner_v1beta.types.ScanConfig.TargetPlatform]
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. |
export_to_security_command_center |
google.cloud.websecurityscanner_v1beta.types.ScanConfig.ExportToSecurityCommandCenter
Controls export of scan configurations and results to Cloud Security Command Center. |
latest_run |
google.cloud.websecurityscanner_v1beta.types.ScanRun
Latest ScanRun if available. |
risk_level |
google.cloud.websecurityscanner_v1beta.types.ScanConfig.RiskLevel
The risk level selected for the scan |
Classes
Authentication
Authentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Scan authentication configuration.
ExportToSecurityCommandCenter
ExportToSecurityCommandCenter(value)
Controls export of scan configurations and results to Cloud Security Command Center.
RiskLevel
RiskLevel(value)
Scan risk levels supported by Cloud Web Security Scanner. LOW impact scanning will minimize requests with the potential to modify data. To achieve the maximum scan coverage, NORMAL risk level is recommended.
Schedule
Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Scan schedule configuration.
TargetPlatform
TargetPlatform(value)
Cloud platforms supported by Cloud Web Security Scanner.
UserAgent
UserAgent(value)
Type of user agents used for scanning.