A ScanConfig resource contains the configurations to launch a scan.
To get more information about ScanConfig, see:
resource "google_compute_address" "scanner_static_ip" {
provider = google-beta
name = "scan-basic-static-ip"
}
resource "google_security_scanner_scan_config" "scan-config" {
provider = google-beta
display_name = "terraform-scan-config"
starting_urls = ["http://${google_compute_address.scanner_static_ip.address}"]
target_platforms = ["COMPUTE"]
}
The following arguments are supported:
display_name
-
(Required)
The user provider display name of the ScanConfig.
starting_urls
-
(Required)
The starting URLs from which the scanner finds site pages.
max_qps
-
(Optional)
The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively.
Defaults to 15.
authentication
-
(Optional)
The authentication configuration.
If specified, service will use the authentication configuration during scanning.
Structure is documented below.
user_agent
-
(Optional)
Type of the user agents used for scanning
Default value is CHROME_LINUX
.
Possible values are: USER_AGENT_UNSPECIFIED
, CHROME_LINUX
, CHROME_ANDROID
, SAFARI_IPHONE
.
blacklist_patterns
-
(Optional)
The blacklist URL patterns as described in
https://cloud.google.com/security-scanner/docs/excluded-urls
schedule
-
(Optional)
The schedule of the ScanConfig
Structure is documented below.
target_platforms
-
(Optional)
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
Each value may be one of: APP_ENGINE
, COMPUTE
.
export_to_security_command_center
-
(Optional)
Controls export of scan configurations and results to Cloud Security Command Center.
Default value is ENABLED
.
Possible values are: ENABLED
, DISABLED
.
project
- (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
The authentication
block supports:
google_account
-
(Optional)
Describes authentication configuration that uses a Google account.
Structure is documented below.
custom_account
-
(Optional)
Describes authentication configuration that uses a custom account.
Structure is documented below.
The google_account
block supports:
username
-
(Required)
The user name of the Google account.
password
-
(Required)
The password of the Google account. The credential is stored encrypted
in GCP.
Note: This property is sensitive and will not be displayed in the plan.
The custom_account
block supports:
username
-
(Required)
The user name of the custom account.
password
-
(Required)
The password of the custom account. The credential is stored encrypted
in GCP.
Note: This property is sensitive and will not be displayed in the plan.
login_url
-
(Required)
The login form URL of the website.
schedule_time
-
(Optional)
A timestamp indicates when the next run will be scheduled. The value is refreshed
by the server after each run. If unspecified, it will default to current server time,
which means the scan will be scheduled to start immediately.
interval_duration_days
-
(Required)
The duration of time between executions in days
In addition to the arguments listed above, the following computed attributes are exported:
id
- an identifier for the resource with format {{name}}
name
-
A server defined name for this index. Format:
projects/{{project}}/scanConfigs/{{server_generated_id}}
This resource provides the following Timeouts configuration options:
create
- Default is 20 minutes.update
- Default is 20 minutes.delete
- Default is 20 minutes.ScanConfig can be imported using any of these accepted formats:
projects/{{project}}/scanConfigs/{{name}}
{{project}}/{{name}}
{{name}}
In Terraform v1.5.0 and later, use an import
block to import ScanConfig using one of the formats above. For example:
import {
id = "projects/{{project}}/scanConfigs/{{name}}"
to = google_security_scanner_scan_config.default
}
When using the terraform import
command, ScanConfig can be imported using one of the formats above. For example:
$ terraform import google_security_scanner_scan_config.default projects/{{project}}/scanConfigs/{{name}}
$ terraform import google_security_scanner_scan_config.default {{project}}/{{name}}
$ terraform import google_security_scanner_scan_config.default {{name}}
This resource supports User Project Overrides.