Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. websecurityscanner
  5. websecurityscanner/v1beta
  6. ScanConfig

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.websecurityscanner/v1beta.ScanConfig

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a new ScanConfig.

Create ScanConfig Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ScanConfig(name: string, args: ScanConfigArgs, opts?: CustomResourceOptions);
@overload
def ScanConfig(resource_name: str,
               args: ScanConfigArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def ScanConfig(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               starting_urls: Optional[Sequence[str]] = None,
               ignore_http_status_errors: Optional[bool] = None,
               project: Optional[str] = None,
               authentication: Optional[AuthenticationArgs] = None,
               latest_run: Optional[ScanRunArgs] = None,
               managed_scan: Optional[bool] = None,
               max_qps: Optional[int] = None,
               name: Optional[str] = None,
               export_to_security_command_center: Optional[ScanConfigExportToSecurityCommandCenter] = None,
               risk_level: Optional[ScanConfigRiskLevel] = None,
               schedule: Optional[ScheduleArgs] = None,
               blacklist_patterns: Optional[Sequence[str]] = None,
               static_ip_scan: Optional[bool] = None,
               target_platforms: Optional[Sequence[ScanConfigTargetPlatformsItem]] = None,
               user_agent: Optional[ScanConfigUserAgent] = None)
func NewScanConfig(ctx *Context, name string, args ScanConfigArgs, opts ...ResourceOption) (*ScanConfig, error)
public ScanConfig(string name, ScanConfigArgs args, CustomResourceOptions? opts = null)
public ScanConfig(String name, ScanConfigArgs args)
public ScanConfig(String name, ScanConfigArgs args, CustomResourceOptions options)

type: google-native:websecurityscanner/v1beta:ScanConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ScanConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ScanConfigArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ScanConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ScanConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ScanConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplescanConfigResourceResourceFromWebsecurityscannerv1beta = new GoogleNative.WebSecurityScanner.V1Beta.ScanConfig("examplescanConfigResourceResourceFromWebsecurityscannerv1beta", new()
{
    DisplayName = "string",
    StartingUrls = new[]
    {
        "string",
    },
    IgnoreHttpStatusErrors = false,
    Project = "string",
    Authentication = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.AuthenticationArgs
    {
        CustomAccount = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.CustomAccountArgs
        {
            LoginUrl = "string",
            Password = "string",
            Username = "string",
        },
        GoogleAccount = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.GoogleAccountArgs
        {
            Password = "string",
            Username = "string",
        },
        IapCredential = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.IapCredentialArgs
        {
            IapTestServiceAccountInfo = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.IapTestServiceAccountInfoArgs
            {
                TargetAudienceClientId = "string",
            },
        },
    },
    LatestRun = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunArgs
    {
        EndTime = "string",
        ErrorTrace = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunErrorTraceArgs
        {
            Code = GoogleNative.WebSecurityScanner.V1Beta.ScanRunErrorTraceCode.CodeUnspecified,
            MostCommonHttpErrorCode = 0,
            ScanConfigError = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanConfigErrorArgs
            {
                Code = GoogleNative.WebSecurityScanner.V1Beta.ScanConfigErrorCode.CodeUnspecified,
                FieldName = "string",
            },
        },
        ExecutionState = GoogleNative.WebSecurityScanner.V1Beta.ScanRunExecutionState.ExecutionStateUnspecified,
        HasVulnerabilities = false,
        Name = "string",
        ProgressPercent = 0,
        ResultState = GoogleNative.WebSecurityScanner.V1Beta.ScanRunResultState.ResultStateUnspecified,
        StartTime = "string",
        UrlsCrawledCount = "string",
        UrlsTestedCount = "string",
        WarningTraces = new[]
        {
            new GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunWarningTraceArgs
            {
                Code = GoogleNative.WebSecurityScanner.V1Beta.ScanRunWarningTraceCode.CodeUnspecified,
            },
        },
    },
    ManagedScan = false,
    MaxQps = 0,
    Name = "string",
    ExportToSecurityCommandCenter = GoogleNative.WebSecurityScanner.V1Beta.ScanConfigExportToSecurityCommandCenter.ExportToSecurityCommandCenterUnspecified,
    RiskLevel = GoogleNative.WebSecurityScanner.V1Beta.ScanConfigRiskLevel.RiskLevelUnspecified,
    Schedule = new GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScheduleArgs
    {
        IntervalDurationDays = 0,
        ScheduleTime = "string",
    },
    BlacklistPatterns = new[]
    {
        "string",
    },
    StaticIpScan = false,
    TargetPlatforms = new[]
    {
        GoogleNative.WebSecurityScanner.V1Beta.ScanConfigTargetPlatformsItem.TargetPlatformUnspecified,
    },
    UserAgent = GoogleNative.WebSecurityScanner.V1Beta.ScanConfigUserAgent.UserAgentUnspecified,
});
Copy
example, err := websecurityscannerv1beta.NewScanConfig(ctx, "examplescanConfigResourceResourceFromWebsecurityscannerv1beta", &websecurityscannerv1beta.ScanConfigArgs{
	DisplayName: pulumi.String("string"),
	StartingUrls: pulumi.StringArray{
		pulumi.String("string"),
	},
	IgnoreHttpStatusErrors: pulumi.Bool(false),
	Project:                pulumi.String("string"),
	Authentication: &websecurityscanner.AuthenticationArgs{
		CustomAccount: &websecurityscanner.CustomAccountArgs{
			LoginUrl: pulumi.String("string"),
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
		GoogleAccount: &websecurityscanner.GoogleAccountArgs{
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
		IapCredential: &websecurityscanner.IapCredentialArgs{
			IapTestServiceAccountInfo: &websecurityscanner.IapTestServiceAccountInfoArgs{
				TargetAudienceClientId: pulumi.String("string"),
			},
		},
	},
	LatestRun: &websecurityscanner.ScanRunArgs{
		EndTime: pulumi.String("string"),
		ErrorTrace: &websecurityscanner.ScanRunErrorTraceArgs{
			Code:                    websecurityscannerv1beta.ScanRunErrorTraceCodeCodeUnspecified,
			MostCommonHttpErrorCode: pulumi.Int(0),
			ScanConfigError: &websecurityscanner.ScanConfigErrorArgs{
				Code:      websecurityscannerv1beta.ScanConfigErrorCodeCodeUnspecified,
				FieldName: pulumi.String("string"),
			},
		},
		ExecutionState:     websecurityscannerv1beta.ScanRunExecutionStateExecutionStateUnspecified,
		HasVulnerabilities: pulumi.Bool(false),
		Name:               pulumi.String("string"),
		ProgressPercent:    pulumi.Int(0),
		ResultState:        websecurityscannerv1beta.ScanRunResultStateResultStateUnspecified,
		StartTime:          pulumi.String("string"),
		UrlsCrawledCount:   pulumi.String("string"),
		UrlsTestedCount:    pulumi.String("string"),
		WarningTraces: websecurityscanner.ScanRunWarningTraceArray{
			&websecurityscanner.ScanRunWarningTraceArgs{
				Code: websecurityscannerv1beta.ScanRunWarningTraceCodeCodeUnspecified,
			},
		},
	},
	ManagedScan:                   pulumi.Bool(false),
	MaxQps:                        pulumi.Int(0),
	Name:                          pulumi.String("string"),
	ExportToSecurityCommandCenter: websecurityscannerv1beta.ScanConfigExportToSecurityCommandCenterExportToSecurityCommandCenterUnspecified,
	RiskLevel:                     websecurityscannerv1beta.ScanConfigRiskLevelRiskLevelUnspecified,
	Schedule: &websecurityscanner.ScheduleArgs{
		IntervalDurationDays: pulumi.Int(0),
		ScheduleTime:         pulumi.String("string"),
	},
	BlacklistPatterns: pulumi.StringArray{
		pulumi.String("string"),
	},
	StaticIpScan: pulumi.Bool(false),
	TargetPlatforms: websecurityscanner.ScanConfigTargetPlatformsItemArray{
		websecurityscannerv1beta.ScanConfigTargetPlatformsItemTargetPlatformUnspecified,
	},
	UserAgent: websecurityscannerv1beta.ScanConfigUserAgentUserAgentUnspecified,
})
Copy
var examplescanConfigResourceResourceFromWebsecurityscannerv1beta = new com.pulumi.googlenative.websecurityscanner_v1beta.ScanConfig("examplescanConfigResourceResourceFromWebsecurityscannerv1beta", com.pulumi.googlenative.websecurityscanner_v1beta.ScanConfigArgs.builder()
    .displayName("string")
    .startingUrls("string")
    .ignoreHttpStatusErrors(false)
    .project("string")
    .authentication(AuthenticationArgs.builder()
        .customAccount(CustomAccountArgs.builder()
            .loginUrl("string")
            .password("string")
            .username("string")
            .build())
        .googleAccount(GoogleAccountArgs.builder()
            .password("string")
            .username("string")
            .build())
        .iapCredential(IapCredentialArgs.builder()
            .iapTestServiceAccountInfo(IapTestServiceAccountInfoArgs.builder()
                .targetAudienceClientId("string")
                .build())
            .build())
        .build())
    .latestRun(ScanRunArgs.builder()
        .endTime("string")
        .errorTrace(ScanRunErrorTraceArgs.builder()
            .code("CODE_UNSPECIFIED")
            .mostCommonHttpErrorCode(0)
            .scanConfigError(ScanConfigErrorArgs.builder()
                .code("CODE_UNSPECIFIED")
                .fieldName("string")
                .build())
            .build())
        .executionState("EXECUTION_STATE_UNSPECIFIED")
        .hasVulnerabilities(false)
        .name("string")
        .progressPercent(0)
        .resultState("RESULT_STATE_UNSPECIFIED")
        .startTime("string")
        .urlsCrawledCount("string")
        .urlsTestedCount("string")
        .warningTraces(ScanRunWarningTraceArgs.builder()
            .code("CODE_UNSPECIFIED")
            .build())
        .build())
    .managedScan(false)
    .maxQps(0)
    .name("string")
    .exportToSecurityCommandCenter("EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED")
    .riskLevel("RISK_LEVEL_UNSPECIFIED")
    .schedule(ScheduleArgs.builder()
        .intervalDurationDays(0)
        .scheduleTime("string")
        .build())
    .blacklistPatterns("string")
    .staticIpScan(false)
    .targetPlatforms("TARGET_PLATFORM_UNSPECIFIED")
    .userAgent("USER_AGENT_UNSPECIFIED")
    .build());
Copy
examplescan_config_resource_resource_from_websecurityscannerv1beta = google_native.websecurityscanner.v1beta.ScanConfig("examplescanConfigResourceResourceFromWebsecurityscannerv1beta",
    display_name="string",
    starting_urls=["string"],
    ignore_http_status_errors=False,
    project="string",
    authentication={
        "custom_account": {
            "login_url": "string",
            "password": "string",
            "username": "string",
        },
        "google_account": {
            "password": "string",
            "username": "string",
        },
        "iap_credential": {
            "iap_test_service_account_info": {
                "target_audience_client_id": "string",
            },
        },
    },
    latest_run={
        "end_time": "string",
        "error_trace": {
            "code": google_native.websecurityscanner.v1beta.ScanRunErrorTraceCode.CODE_UNSPECIFIED,
            "most_common_http_error_code": 0,
            "scan_config_error": {
                "code": google_native.websecurityscanner.v1beta.ScanConfigErrorCode.CODE_UNSPECIFIED,
                "field_name": "string",
            },
        },
        "execution_state": google_native.websecurityscanner.v1beta.ScanRunExecutionState.EXECUTION_STATE_UNSPECIFIED,
        "has_vulnerabilities": False,
        "name": "string",
        "progress_percent": 0,
        "result_state": google_native.websecurityscanner.v1beta.ScanRunResultState.RESULT_STATE_UNSPECIFIED,
        "start_time": "string",
        "urls_crawled_count": "string",
        "urls_tested_count": "string",
        "warning_traces": [{
            "code": google_native.websecurityscanner.v1beta.ScanRunWarningTraceCode.CODE_UNSPECIFIED,
        }],
    },
    managed_scan=False,
    max_qps=0,
    name="string",
    export_to_security_command_center=google_native.websecurityscanner.v1beta.ScanConfigExportToSecurityCommandCenter.EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED,
    risk_level=google_native.websecurityscanner.v1beta.ScanConfigRiskLevel.RISK_LEVEL_UNSPECIFIED,
    schedule={
        "interval_duration_days": 0,
        "schedule_time": "string",
    },
    blacklist_patterns=["string"],
    static_ip_scan=False,
    target_platforms=[google_native.websecurityscanner.v1beta.ScanConfigTargetPlatformsItem.TARGET_PLATFORM_UNSPECIFIED],
    user_agent=google_native.websecurityscanner.v1beta.ScanConfigUserAgent.USER_AGENT_UNSPECIFIED)
Copy
const examplescanConfigResourceResourceFromWebsecurityscannerv1beta = new google_native.websecurityscanner.v1beta.ScanConfig("examplescanConfigResourceResourceFromWebsecurityscannerv1beta", {
    displayName: "string",
    startingUrls: ["string"],
    ignoreHttpStatusErrors: false,
    project: "string",
    authentication: {
        customAccount: {
            loginUrl: "string",
            password: "string",
            username: "string",
        },
        googleAccount: {
            password: "string",
            username: "string",
        },
        iapCredential: {
            iapTestServiceAccountInfo: {
                targetAudienceClientId: "string",
            },
        },
    },
    latestRun: {
        endTime: "string",
        errorTrace: {
            code: google_native.websecurityscanner.v1beta.ScanRunErrorTraceCode.CodeUnspecified,
            mostCommonHttpErrorCode: 0,
            scanConfigError: {
                code: google_native.websecurityscanner.v1beta.ScanConfigErrorCode.CodeUnspecified,
                fieldName: "string",
            },
        },
        executionState: google_native.websecurityscanner.v1beta.ScanRunExecutionState.ExecutionStateUnspecified,
        hasVulnerabilities: false,
        name: "string",
        progressPercent: 0,
        resultState: google_native.websecurityscanner.v1beta.ScanRunResultState.ResultStateUnspecified,
        startTime: "string",
        urlsCrawledCount: "string",
        urlsTestedCount: "string",
        warningTraces: [{
            code: google_native.websecurityscanner.v1beta.ScanRunWarningTraceCode.CodeUnspecified,
        }],
    },
    managedScan: false,
    maxQps: 0,
    name: "string",
    exportToSecurityCommandCenter: google_native.websecurityscanner.v1beta.ScanConfigExportToSecurityCommandCenter.ExportToSecurityCommandCenterUnspecified,
    riskLevel: google_native.websecurityscanner.v1beta.ScanConfigRiskLevel.RiskLevelUnspecified,
    schedule: {
        intervalDurationDays: 0,
        scheduleTime: "string",
    },
    blacklistPatterns: ["string"],
    staticIpScan: false,
    targetPlatforms: [google_native.websecurityscanner.v1beta.ScanConfigTargetPlatformsItem.TargetPlatformUnspecified],
    userAgent: google_native.websecurityscanner.v1beta.ScanConfigUserAgent.UserAgentUnspecified,
});
Copy
type: google-native:websecurityscanner/v1beta:ScanConfig
properties:
    authentication:
        customAccount:
            loginUrl: string
            password: string
            username: string
        googleAccount:
            password: string
            username: string
        iapCredential:
            iapTestServiceAccountInfo:
                targetAudienceClientId: string
    blacklistPatterns:
        - string
    displayName: string
    exportToSecurityCommandCenter: EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED
    ignoreHttpStatusErrors: false
    latestRun:
        endTime: string
        errorTrace:
            code: CODE_UNSPECIFIED
            mostCommonHttpErrorCode: 0
            scanConfigError:
                code: CODE_UNSPECIFIED
                fieldName: string
        executionState: EXECUTION_STATE_UNSPECIFIED
        hasVulnerabilities: false
        name: string
        progressPercent: 0
        resultState: RESULT_STATE_UNSPECIFIED
        startTime: string
        urlsCrawledCount: string
        urlsTestedCount: string
        warningTraces:
            - code: CODE_UNSPECIFIED
    managedScan: false
    maxQps: 0
    name: string
    project: string
    riskLevel: RISK_LEVEL_UNSPECIFIED
    schedule:
        intervalDurationDays: 0
        scheduleTime: string
    startingUrls:
        - string
    staticIpScan: false
    targetPlatforms:
        - TARGET_PLATFORM_UNSPECIFIED
    userAgent: USER_AGENT_UNSPECIFIED
Copy

ScanConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ScanConfig resource accepts the following input properties:

DisplayName This property is required. string
The user provided display name of the ScanConfig.
StartingUrls This property is required. List<string>
The starting URLs from which the scanner finds site pages.
Authentication Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.Authentication
The authentication configuration. If specified, service will use the authentication configuration during scanning.
BlacklistPatterns List<string>
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
ExportToSecurityCommandCenter Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanConfigExportToSecurityCommandCenter
Controls export of scan configurations and results to Security Command Center.
IgnoreHttpStatusErrors bool
Whether to keep scanning even if most requests return HTTP error codes.
LatestRun Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRun
Latest ScanRun if available.
ManagedScan bool
Whether the scan config is managed by Web Security Scanner, output only.
MaxQps 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.
Name string
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
Project Changes to this property will trigger replacement. string
RiskLevel Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanConfigRiskLevel
The risk level selected for the scan
Schedule Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.Schedule
The schedule of the ScanConfig.
StaticIpScan bool
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
TargetPlatforms List<Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanConfigTargetPlatformsItem>
Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
UserAgent Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanConfigUserAgent
The user agent used during scanning.
DisplayName This property is required. string
The user provided display name of the ScanConfig.
StartingUrls This property is required. []string
The starting URLs from which the scanner finds site pages.
Authentication AuthenticationArgs
The authentication configuration. If specified, service will use the authentication configuration during scanning.
BlacklistPatterns []string
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
ExportToSecurityCommandCenter ScanConfigExportToSecurityCommandCenter
Controls export of scan configurations and results to Security Command Center.
IgnoreHttpStatusErrors bool
Whether to keep scanning even if most requests return HTTP error codes.
LatestRun ScanRunArgs
Latest ScanRun if available.
ManagedScan bool
Whether the scan config is managed by Web Security Scanner, output only.
MaxQps 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.
Name string
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
Project Changes to this property will trigger replacement. string
RiskLevel ScanConfigRiskLevel
The risk level selected for the scan
Schedule ScheduleArgs
The schedule of the ScanConfig.
StaticIpScan bool
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
TargetPlatforms []ScanConfigTargetPlatformsItem
Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
UserAgent ScanConfigUserAgent
The user agent used during scanning.
displayName This property is required. String
The user provided display name of the ScanConfig.
startingUrls This property is required. List<String>
The starting URLs from which the scanner finds site pages.
authentication Authentication
The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklistPatterns List<String>
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
exportToSecurityCommandCenter ScanConfigExportToSecurityCommandCenter
Controls export of scan configurations and results to Security Command Center.
ignoreHttpStatusErrors Boolean
Whether to keep scanning even if most requests return HTTP error codes.
latestRun ScanRun
Latest ScanRun if available.
managedScan Boolean
Whether the scan config is managed by Web Security Scanner, output only.
maxQps Integer
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.
name String
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
project Changes to this property will trigger replacement. String
riskLevel ScanConfigRiskLevel
The risk level selected for the scan
schedule Schedule
The schedule of the ScanConfig.
staticIpScan Boolean
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
targetPlatforms List<ScanConfigTargetPlatformsItem>
Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
userAgent ScanConfigUserAgent
The user agent used during scanning.
displayName This property is required. string
The user provided display name of the ScanConfig.
startingUrls This property is required. string[]
The starting URLs from which the scanner finds site pages.
authentication Authentication
The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklistPatterns string[]
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
exportToSecurityCommandCenter ScanConfigExportToSecurityCommandCenter
Controls export of scan configurations and results to Security Command Center.
ignoreHttpStatusErrors boolean
Whether to keep scanning even if most requests return HTTP error codes.
latestRun ScanRun
Latest ScanRun if available.
managedScan boolean
Whether the scan config is managed by Web Security Scanner, output only.
maxQps number
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.
name string
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
project Changes to this property will trigger replacement. string
riskLevel ScanConfigRiskLevel
The risk level selected for the scan
schedule Schedule
The schedule of the ScanConfig.
staticIpScan boolean
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
targetPlatforms ScanConfigTargetPlatformsItem[]
Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
userAgent ScanConfigUserAgent
The user agent used during scanning.
display_name This property is required. str
The user provided display name of the ScanConfig.
starting_urls This property is required. Sequence[str]
The starting URLs from which the scanner finds site pages.
authentication AuthenticationArgs
The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklist_patterns Sequence[str]
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
export_to_security_command_center ScanConfigExportToSecurityCommandCenter
Controls export of scan configurations and results to Security Command Center.
ignore_http_status_errors bool
Whether to keep scanning even if most requests return HTTP error codes.
latest_run ScanRunArgs
Latest ScanRun if available.
managed_scan bool
Whether the scan config is managed by Web Security Scanner, output only.
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.
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.
project Changes to this property will trigger replacement. str
risk_level ScanConfigRiskLevel
The risk level selected for the scan
schedule ScheduleArgs
The schedule of the ScanConfig.
static_ip_scan bool
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
target_platforms Sequence[ScanConfigTargetPlatformsItem]
Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
user_agent ScanConfigUserAgent
The user agent used during scanning.
displayName This property is required. String
The user provided display name of the ScanConfig.
startingUrls This property is required. List<String>
The starting URLs from which the scanner finds site pages.
authentication Property Map
The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklistPatterns List<String>
The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
exportToSecurityCommandCenter "EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED" | "ENABLED" | "DISABLED"
Controls export of scan configurations and results to Security Command Center.
ignoreHttpStatusErrors Boolean
Whether to keep scanning even if most requests return HTTP error codes.
latestRun Property Map
Latest ScanRun if available.
managedScan Boolean
Whether the scan config is managed by Web Security Scanner, output only.
maxQps Number
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.
name String
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
project Changes to this property will trigger replacement. String
riskLevel "RISK_LEVEL_UNSPECIFIED" | "NORMAL" | "LOW"
The risk level selected for the scan
schedule Property Map
The schedule of the ScanConfig.
staticIpScan Boolean
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
targetPlatforms List<"TARGET_PLATFORM_UNSPECIFIED" | "APP_ENGINE" | "COMPUTE" | "CLOUD_RUN" | "CLOUD_FUNCTIONS">
Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
userAgent "USER_AGENT_UNSPECIFIED" | "CHROME_LINUX" | "CHROME_ANDROID" | "SAFARI_IPHONE"
The user agent used during scanning.

Outputs

All input properties are implicitly available as output properties. Additionally, the ScanConfig resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Authentication
, AuthenticationArgs

CustomAccount CustomAccount
Authentication using a custom account.
GoogleAccount GoogleAccount
Authentication using a Google account.
IapCredential IapCredential
Authentication using Identity-Aware-Proxy (IAP).
customAccount CustomAccount
Authentication using a custom account.
googleAccount GoogleAccount
Authentication using a Google account.
iapCredential IapCredential
Authentication using Identity-Aware-Proxy (IAP).
customAccount CustomAccount
Authentication using a custom account.
googleAccount GoogleAccount
Authentication using a Google account.
iapCredential IapCredential
Authentication using Identity-Aware-Proxy (IAP).
custom_account CustomAccount
Authentication using a custom account.
google_account GoogleAccount
Authentication using a Google account.
iap_credential IapCredential
Authentication using Identity-Aware-Proxy (IAP).
customAccount Property Map
Authentication using a custom account.
googleAccount Property Map
Authentication using a Google account.
iapCredential Property Map
Authentication using Identity-Aware-Proxy (IAP).

AuthenticationResponse
, AuthenticationResponseArgs

CustomAccount This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.CustomAccountResponse
Authentication using a custom account.
GoogleAccount This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.GoogleAccountResponse
Authentication using a Google account.
IapCredential This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.IapCredentialResponse
Authentication using Identity-Aware-Proxy (IAP).
CustomAccount This property is required. CustomAccountResponse
Authentication using a custom account.
GoogleAccount This property is required. GoogleAccountResponse
Authentication using a Google account.
IapCredential This property is required. IapCredentialResponse
Authentication using Identity-Aware-Proxy (IAP).
customAccount This property is required. CustomAccountResponse
Authentication using a custom account.
googleAccount This property is required. GoogleAccountResponse
Authentication using a Google account.
iapCredential This property is required. IapCredentialResponse
Authentication using Identity-Aware-Proxy (IAP).
customAccount This property is required. CustomAccountResponse
Authentication using a custom account.
googleAccount This property is required. GoogleAccountResponse
Authentication using a Google account.
iapCredential This property is required. IapCredentialResponse
Authentication using Identity-Aware-Proxy (IAP).
custom_account This property is required. CustomAccountResponse
Authentication using a custom account.
google_account This property is required. GoogleAccountResponse
Authentication using a Google account.
iap_credential This property is required. IapCredentialResponse
Authentication using Identity-Aware-Proxy (IAP).
customAccount This property is required. Property Map
Authentication using a custom account.
googleAccount This property is required. Property Map
Authentication using a Google account.
iapCredential This property is required. Property Map
Authentication using Identity-Aware-Proxy (IAP).

CustomAccount
, CustomAccountArgs

LoginUrl This property is required. string
The login form URL of the website.
Password This property is required. string
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the custom account.
LoginUrl This property is required. string
The login form URL of the website.
Password This property is required. string
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the custom account.
loginUrl This property is required. String
The login form URL of the website.
password This property is required. String
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the custom account.
loginUrl This property is required. string
The login form URL of the website.
password This property is required. string
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. string
The user name of the custom account.
login_url This property is required. str
The login form URL of the website.
password This property is required. str
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. str
The user name of the custom account.
loginUrl This property is required. String
The login form URL of the website.
password This property is required. String
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the custom account.

CustomAccountResponse
, CustomAccountResponseArgs

LoginUrl This property is required. string
The login form URL of the website.
Password This property is required. string
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the custom account.
LoginUrl This property is required. string
The login form URL of the website.
Password This property is required. string
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the custom account.
loginUrl This property is required. String
The login form URL of the website.
password This property is required. String
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the custom account.
loginUrl This property is required. string
The login form URL of the website.
password This property is required. string
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. string
The user name of the custom account.
login_url This property is required. str
The login form URL of the website.
password This property is required. str
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. str
The user name of the custom account.
loginUrl This property is required. String
The login form URL of the website.
password This property is required. String
Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the custom account.

GoogleAccount
, GoogleAccountArgs

Password This property is required. string
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the Google account.
Password This property is required. string
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the Google account.
password This property is required. String
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the Google account.
password This property is required. string
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. string
The user name of the Google account.
password This property is required. str
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. str
The user name of the Google account.
password This property is required. String
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the Google account.

GoogleAccountResponse
, GoogleAccountResponseArgs

Password This property is required. string
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the Google account.
Password This property is required. string
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username This property is required. string
The user name of the Google account.
password This property is required. String
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the Google account.
password This property is required. string
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. string
The user name of the Google account.
password This property is required. str
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. str
The user name of the Google account.
password This property is required. String
Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username This property is required. String
The user name of the Google account.

IapCredential
, IapCredentialArgs

IapTestServiceAccountInfo Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.IapTestServiceAccountInfo
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
IapTestServiceAccountInfo IapTestServiceAccountInfo
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iapTestServiceAccountInfo IapTestServiceAccountInfo
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iapTestServiceAccountInfo IapTestServiceAccountInfo
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iap_test_service_account_info IapTestServiceAccountInfo
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iapTestServiceAccountInfo Property Map
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

IapCredentialResponse
, IapCredentialResponseArgs

IapTestServiceAccountInfo This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.IapTestServiceAccountInfoResponse
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
IapTestServiceAccountInfo This property is required. IapTestServiceAccountInfoResponse
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iapTestServiceAccountInfo This property is required. IapTestServiceAccountInfoResponse
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iapTestServiceAccountInfo This property is required. IapTestServiceAccountInfoResponse
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iap_test_service_account_info This property is required. IapTestServiceAccountInfoResponse
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.
iapTestServiceAccountInfo This property is required. Property Map
Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

IapTestServiceAccountInfo
, IapTestServiceAccountInfoArgs

TargetAudienceClientId This property is required. string
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
TargetAudienceClientId This property is required. string
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
targetAudienceClientId This property is required. String
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
targetAudienceClientId This property is required. string
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
target_audience_client_id This property is required. str
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
targetAudienceClientId This property is required. String
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

IapTestServiceAccountInfoResponse
, IapTestServiceAccountInfoResponseArgs

TargetAudienceClientId This property is required. string
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
TargetAudienceClientId This property is required. string
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
targetAudienceClientId This property is required. String
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
targetAudienceClientId This property is required. string
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
target_audience_client_id This property is required. str
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).
targetAudienceClientId This property is required. String
Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

ScanConfigError
, ScanConfigErrorArgs

Code Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanConfigErrorCode
Indicates the reason code for a configuration failure.
FieldName string
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
Code ScanConfigErrorCode
Indicates the reason code for a configuration failure.
FieldName string
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code ScanConfigErrorCode
Indicates the reason code for a configuration failure.
fieldName String
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code ScanConfigErrorCode
Indicates the reason code for a configuration failure.
fieldName string
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code ScanConfigErrorCode
Indicates the reason code for a configuration failure.
field_name str
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code "CODE_UNSPECIFIED" | "OK" | "INTERNAL_ERROR" | "APPENGINE_API_BACKEND_ERROR" | "APPENGINE_API_NOT_ACCESSIBLE" | "APPENGINE_DEFAULT_HOST_MISSING" | "CANNOT_USE_GOOGLE_COM_ACCOUNT" | "CANNOT_USE_OWNER_ACCOUNT" | "COMPUTE_API_BACKEND_ERROR" | "COMPUTE_API_NOT_ACCESSIBLE" | "CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT" | "CUSTOM_LOGIN_URL_MALFORMED" | "CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS" | "CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS" | "CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS" | "CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS" | "DUPLICATE_SCAN_NAME" | "INVALID_FIELD_VALUE" | "FAILED_TO_AUTHENTICATE_TO_TARGET" | "FINDING_TYPE_UNSPECIFIED" | "FORBIDDEN_TO_SCAN_COMPUTE" | "FORBIDDEN_UPDATE_TO_MANAGED_SCAN" | "MALFORMED_FILTER" | "MALFORMED_RESOURCE_NAME" | "PROJECT_INACTIVE" | "REQUIRED_FIELD" | "RESOURCE_NAME_INCONSISTENT" | "SCAN_ALREADY_RUNNING" | "SCAN_NOT_RUNNING" | "SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT" | "SEED_URL_MALFORMED" | "SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS" | "SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS" | "SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS" | "SEED_URL_HAS_UNRESERVED_IP_ADDRESS" | "SERVICE_ACCOUNT_NOT_CONFIGURED" | "TOO_MANY_SCANS" | "UNABLE_TO_RESOLVE_PROJECT_INFO" | "UNSUPPORTED_BLACKLIST_PATTERN_FORMAT" | "UNSUPPORTED_FILTER" | "UNSUPPORTED_FINDING_TYPE" | "UNSUPPORTED_URL_SCHEME" | "CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND"
Indicates the reason code for a configuration failure.
fieldName String
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

ScanConfigErrorCode
, ScanConfigErrorCodeArgs

CodeUnspecified
CODE_UNSPECIFIEDThere is no error.
Ok
OKThere is no error.
InternalError
INTERNAL_ERRORIndicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
AppengineApiBackendError
APPENGINE_API_BACKEND_ERROROne of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.
AppengineApiNotAccessible
APPENGINE_API_NOT_ACCESSIBLEOne of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.
AppengineDefaultHostMissing
APPENGINE_DEFAULT_HOST_MISSINGOne of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.
CannotUseGoogleComAccount
CANNOT_USE_GOOGLE_COM_ACCOUNTGoogle corporate accounts can not be used for scanning.
CannotUseOwnerAccount
CANNOT_USE_OWNER_ACCOUNTThe account of the scan creator can not be used for scanning.
ComputeApiBackendError
COMPUTE_API_BACKEND_ERRORThis scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.
ComputeApiNotAccessible
COMPUTE_API_NOT_ACCESSIBLEThis scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.
CustomLoginUrlDoesNotBelongToCurrentProject
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTThe Custom Login URL does not belong to the current project.
CustomLoginUrlMalformed
CUSTOM_LOGIN_URL_MALFORMEDThe Custom Login URL is malformed (can not be parsed).
CustomLoginUrlMappedToNonRoutableAddress
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSThe Custom Login URL is mapped to a non-routable IP address in DNS.
CustomLoginUrlMappedToUnreservedAddress
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESSThe Custom Login URL is mapped to an IP address which is not reserved for the current project.
CustomLoginUrlHasNonRoutableIpAddress
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESSThe Custom Login URL has a non-routable IP address.
CustomLoginUrlHasUnreservedIpAddress
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESSThe Custom Login URL has an IP address which is not reserved for the current project.
DuplicateScanName
DUPLICATE_SCAN_NAMEAnother scan with the same name (case-sensitive) already exists.
InvalidFieldValue
INVALID_FIELD_VALUEA field is set to an invalid value.
FailedToAuthenticateToTarget
FAILED_TO_AUTHENTICATE_TO_TARGETThere was an error trying to authenticate to the scan target.
FindingTypeUnspecified
FINDING_TYPE_UNSPECIFIEDFinding type value is not specified in the list findings request.
ForbiddenToScanCompute
FORBIDDEN_TO_SCAN_COMPUTEScan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.
ForbiddenUpdateToManagedScan
FORBIDDEN_UPDATE_TO_MANAGED_SCANUser tries to update managed scan
MalformedFilter
MALFORMED_FILTERThe supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.
MalformedResourceName
MALFORMED_RESOURCE_NAMEThe supplied resource name is malformed (can not be parsed).
ProjectInactive
PROJECT_INACTIVEThe current project is not in an active state.
RequiredField
REQUIRED_FIELDA required field is not set.
ResourceNameInconsistent
RESOURCE_NAME_INCONSISTENTProject id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.
ScanAlreadyRunning
SCAN_ALREADY_RUNNINGThe scan being requested to start is already running.
ScanNotRunning
SCAN_NOT_RUNNINGThe scan that was requested to be stopped is not running.
SeedUrlDoesNotBelongToCurrentProject
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTOne of the seed URLs does not belong to the current project.
SeedUrlMalformed
SEED_URL_MALFORMEDOne of the seed URLs is malformed (can not be parsed).
SeedUrlMappedToNonRoutableAddress
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSOne of the seed URLs is mapped to a non-routable IP address in DNS.
SeedUrlMappedToUnreservedAddress
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESSOne of the seed URLs is mapped to an IP address which is not reserved for the current project.
SeedUrlHasNonRoutableIpAddress
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESSOne of the seed URLs has on-routable IP address.
SeedUrlHasUnreservedIpAddress
SEED_URL_HAS_UNRESERVED_IP_ADDRESSOne of the seed URLs has an IP address that is not reserved for the current project.
ServiceAccountNotConfigured
SERVICE_ACCOUNT_NOT_CONFIGUREDThe Web Security Scanner service account is not configured under the project.
TooManyScans
TOO_MANY_SCANSA project has reached the maximum number of scans.
UnableToResolveProjectInfo
UNABLE_TO_RESOLVE_PROJECT_INFOResolving the details of the current project fails.
UnsupportedBlacklistPatternFormat
UNSUPPORTED_BLACKLIST_PATTERN_FORMATOne or more blacklist patterns were in the wrong format.
UnsupportedFilter
UNSUPPORTED_FILTERThe supplied filter is not supported.
UnsupportedFindingType
UNSUPPORTED_FINDING_TYPEThe supplied finding type is not supported. For example, we do not provide findings of the given finding type.
UnsupportedUrlScheme
UNSUPPORTED_URL_SCHEMEThe URL scheme of one or more of the supplied URLs is not supported.
CloudAssetInventoryAssetNotFound
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUNDCAI is not able to list assets.
ScanConfigErrorCodeCodeUnspecified
CODE_UNSPECIFIEDThere is no error.
ScanConfigErrorCodeOk
OKThere is no error.
ScanConfigErrorCodeInternalError
INTERNAL_ERRORIndicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
ScanConfigErrorCodeAppengineApiBackendError
APPENGINE_API_BACKEND_ERROROne of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.
ScanConfigErrorCodeAppengineApiNotAccessible
APPENGINE_API_NOT_ACCESSIBLEOne of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.
ScanConfigErrorCodeAppengineDefaultHostMissing
APPENGINE_DEFAULT_HOST_MISSINGOne of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.
ScanConfigErrorCodeCannotUseGoogleComAccount
CANNOT_USE_GOOGLE_COM_ACCOUNTGoogle corporate accounts can not be used for scanning.
ScanConfigErrorCodeCannotUseOwnerAccount
CANNOT_USE_OWNER_ACCOUNTThe account of the scan creator can not be used for scanning.
ScanConfigErrorCodeComputeApiBackendError
COMPUTE_API_BACKEND_ERRORThis scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.
ScanConfigErrorCodeComputeApiNotAccessible
COMPUTE_API_NOT_ACCESSIBLEThis scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.
ScanConfigErrorCodeCustomLoginUrlDoesNotBelongToCurrentProject
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTThe Custom Login URL does not belong to the current project.
ScanConfigErrorCodeCustomLoginUrlMalformed
CUSTOM_LOGIN_URL_MALFORMEDThe Custom Login URL is malformed (can not be parsed).
ScanConfigErrorCodeCustomLoginUrlMappedToNonRoutableAddress
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSThe Custom Login URL is mapped to a non-routable IP address in DNS.
ScanConfigErrorCodeCustomLoginUrlMappedToUnreservedAddress
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESSThe Custom Login URL is mapped to an IP address which is not reserved for the current project.
ScanConfigErrorCodeCustomLoginUrlHasNonRoutableIpAddress
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESSThe Custom Login URL has a non-routable IP address.
ScanConfigErrorCodeCustomLoginUrlHasUnreservedIpAddress
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESSThe Custom Login URL has an IP address which is not reserved for the current project.
ScanConfigErrorCodeDuplicateScanName
DUPLICATE_SCAN_NAMEAnother scan with the same name (case-sensitive) already exists.
ScanConfigErrorCodeInvalidFieldValue
INVALID_FIELD_VALUEA field is set to an invalid value.
ScanConfigErrorCodeFailedToAuthenticateToTarget
FAILED_TO_AUTHENTICATE_TO_TARGETThere was an error trying to authenticate to the scan target.
ScanConfigErrorCodeFindingTypeUnspecified
FINDING_TYPE_UNSPECIFIEDFinding type value is not specified in the list findings request.
ScanConfigErrorCodeForbiddenToScanCompute
FORBIDDEN_TO_SCAN_COMPUTEScan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.
ScanConfigErrorCodeForbiddenUpdateToManagedScan
FORBIDDEN_UPDATE_TO_MANAGED_SCANUser tries to update managed scan
ScanConfigErrorCodeMalformedFilter
MALFORMED_FILTERThe supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.
ScanConfigErrorCodeMalformedResourceName
MALFORMED_RESOURCE_NAMEThe supplied resource name is malformed (can not be parsed).
ScanConfigErrorCodeProjectInactive
PROJECT_INACTIVEThe current project is not in an active state.
ScanConfigErrorCodeRequiredField
REQUIRED_FIELDA required field is not set.
ScanConfigErrorCodeResourceNameInconsistent
RESOURCE_NAME_INCONSISTENTProject id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.
ScanConfigErrorCodeScanAlreadyRunning
SCAN_ALREADY_RUNNINGThe scan being requested to start is already running.
ScanConfigErrorCodeScanNotRunning
SCAN_NOT_RUNNINGThe scan that was requested to be stopped is not running.
ScanConfigErrorCodeSeedUrlDoesNotBelongToCurrentProject
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTOne of the seed URLs does not belong to the current project.
ScanConfigErrorCodeSeedUrlMalformed
SEED_URL_MALFORMEDOne of the seed URLs is malformed (can not be parsed).
ScanConfigErrorCodeSeedUrlMappedToNonRoutableAddress
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSOne of the seed URLs is mapped to a non-routable IP address in DNS.
ScanConfigErrorCodeSeedUrlMappedToUnreservedAddress
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESSOne of the seed URLs is mapped to an IP address which is not reserved for the current project.
ScanConfigErrorCodeSeedUrlHasNonRoutableIpAddress
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESSOne of the seed URLs has on-routable IP address.
ScanConfigErrorCodeSeedUrlHasUnreservedIpAddress
SEED_URL_HAS_UNRESERVED_IP_ADDRESSOne of the seed URLs has an IP address that is not reserved for the current project.
ScanConfigErrorCodeServiceAccountNotConfigured
SERVICE_ACCOUNT_NOT_CONFIGUREDThe Web Security Scanner service account is not configured under the project.
ScanConfigErrorCodeTooManyScans
TOO_MANY_SCANSA project has reached the maximum number of scans.
ScanConfigErrorCodeUnableToResolveProjectInfo
UNABLE_TO_RESOLVE_PROJECT_INFOResolving the details of the current project fails.
ScanConfigErrorCodeUnsupportedBlacklistPatternFormat
UNSUPPORTED_BLACKLIST_PATTERN_FORMATOne or more blacklist patterns were in the wrong format.
ScanConfigErrorCodeUnsupportedFilter
UNSUPPORTED_FILTERThe supplied filter is not supported.
ScanConfigErrorCodeUnsupportedFindingType
UNSUPPORTED_FINDING_TYPEThe supplied finding type is not supported. For example, we do not provide findings of the given finding type.
ScanConfigErrorCodeUnsupportedUrlScheme
UNSUPPORTED_URL_SCHEMEThe URL scheme of one or more of the supplied URLs is not supported.
ScanConfigErrorCodeCloudAssetInventoryAssetNotFound
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUNDCAI is not able to list assets.
CodeUnspecified
CODE_UNSPECIFIEDThere is no error.
Ok
OKThere is no error.
InternalError
INTERNAL_ERRORIndicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
AppengineApiBackendError
APPENGINE_API_BACKEND_ERROROne of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.
AppengineApiNotAccessible
APPENGINE_API_NOT_ACCESSIBLEOne of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.
AppengineDefaultHostMissing
APPENGINE_DEFAULT_HOST_MISSINGOne of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.
CannotUseGoogleComAccount
CANNOT_USE_GOOGLE_COM_ACCOUNTGoogle corporate accounts can not be used for scanning.
CannotUseOwnerAccount
CANNOT_USE_OWNER_ACCOUNTThe account of the scan creator can not be used for scanning.
ComputeApiBackendError
COMPUTE_API_BACKEND_ERRORThis scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.
ComputeApiNotAccessible
COMPUTE_API_NOT_ACCESSIBLEThis scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.
CustomLoginUrlDoesNotBelongToCurrentProject
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTThe Custom Login URL does not belong to the current project.
CustomLoginUrlMalformed
CUSTOM_LOGIN_URL_MALFORMEDThe Custom Login URL is malformed (can not be parsed).
CustomLoginUrlMappedToNonRoutableAddress
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSThe Custom Login URL is mapped to a non-routable IP address in DNS.
CustomLoginUrlMappedToUnreservedAddress
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESSThe Custom Login URL is mapped to an IP address which is not reserved for the current project.
CustomLoginUrlHasNonRoutableIpAddress
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESSThe Custom Login URL has a non-routable IP address.
CustomLoginUrlHasUnreservedIpAddress
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESSThe Custom Login URL has an IP address which is not reserved for the current project.
DuplicateScanName
DUPLICATE_SCAN_NAMEAnother scan with the same name (case-sensitive) already exists.
InvalidFieldValue
INVALID_FIELD_VALUEA field is set to an invalid value.
FailedToAuthenticateToTarget
FAILED_TO_AUTHENTICATE_TO_TARGETThere was an error trying to authenticate to the scan target.
FindingTypeUnspecified
FINDING_TYPE_UNSPECIFIEDFinding type value is not specified in the list findings request.
ForbiddenToScanCompute
FORBIDDEN_TO_SCAN_COMPUTEScan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.
ForbiddenUpdateToManagedScan
FORBIDDEN_UPDATE_TO_MANAGED_SCANUser tries to update managed scan
MalformedFilter
MALFORMED_FILTERThe supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.
MalformedResourceName
MALFORMED_RESOURCE_NAMEThe supplied resource name is malformed (can not be parsed).
ProjectInactive
PROJECT_INACTIVEThe current project is not in an active state.
RequiredField
REQUIRED_FIELDA required field is not set.
ResourceNameInconsistent
RESOURCE_NAME_INCONSISTENTProject id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.
ScanAlreadyRunning
SCAN_ALREADY_RUNNINGThe scan being requested to start is already running.
ScanNotRunning
SCAN_NOT_RUNNINGThe scan that was requested to be stopped is not running.
SeedUrlDoesNotBelongToCurrentProject
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTOne of the seed URLs does not belong to the current project.
SeedUrlMalformed
SEED_URL_MALFORMEDOne of the seed URLs is malformed (can not be parsed).
SeedUrlMappedToNonRoutableAddress
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSOne of the seed URLs is mapped to a non-routable IP address in DNS.
SeedUrlMappedToUnreservedAddress
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESSOne of the seed URLs is mapped to an IP address which is not reserved for the current project.
SeedUrlHasNonRoutableIpAddress
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESSOne of the seed URLs has on-routable IP address.
SeedUrlHasUnreservedIpAddress
SEED_URL_HAS_UNRESERVED_IP_ADDRESSOne of the seed URLs has an IP address that is not reserved for the current project.
ServiceAccountNotConfigured
SERVICE_ACCOUNT_NOT_CONFIGUREDThe Web Security Scanner service account is not configured under the project.
TooManyScans
TOO_MANY_SCANSA project has reached the maximum number of scans.
UnableToResolveProjectInfo
UNABLE_TO_RESOLVE_PROJECT_INFOResolving the details of the current project fails.
UnsupportedBlacklistPatternFormat
UNSUPPORTED_BLACKLIST_PATTERN_FORMATOne or more blacklist patterns were in the wrong format.
UnsupportedFilter
UNSUPPORTED_FILTERThe supplied filter is not supported.
UnsupportedFindingType
UNSUPPORTED_FINDING_TYPEThe supplied finding type is not supported. For example, we do not provide findings of the given finding type.
UnsupportedUrlScheme
UNSUPPORTED_URL_SCHEMEThe URL scheme of one or more of the supplied URLs is not supported.
CloudAssetInventoryAssetNotFound
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUNDCAI is not able to list assets.
CodeUnspecified
CODE_UNSPECIFIEDThere is no error.
Ok
OKThere is no error.
InternalError
INTERNAL_ERRORIndicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
AppengineApiBackendError
APPENGINE_API_BACKEND_ERROROne of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.
AppengineApiNotAccessible
APPENGINE_API_NOT_ACCESSIBLEOne of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.
AppengineDefaultHostMissing
APPENGINE_DEFAULT_HOST_MISSINGOne of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.
CannotUseGoogleComAccount
CANNOT_USE_GOOGLE_COM_ACCOUNTGoogle corporate accounts can not be used for scanning.
CannotUseOwnerAccount
CANNOT_USE_OWNER_ACCOUNTThe account of the scan creator can not be used for scanning.
ComputeApiBackendError
COMPUTE_API_BACKEND_ERRORThis scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.
ComputeApiNotAccessible
COMPUTE_API_NOT_ACCESSIBLEThis scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.
CustomLoginUrlDoesNotBelongToCurrentProject
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTThe Custom Login URL does not belong to the current project.
CustomLoginUrlMalformed
CUSTOM_LOGIN_URL_MALFORMEDThe Custom Login URL is malformed (can not be parsed).
CustomLoginUrlMappedToNonRoutableAddress
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSThe Custom Login URL is mapped to a non-routable IP address in DNS.
CustomLoginUrlMappedToUnreservedAddress
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESSThe Custom Login URL is mapped to an IP address which is not reserved for the current project.
CustomLoginUrlHasNonRoutableIpAddress
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESSThe Custom Login URL has a non-routable IP address.
CustomLoginUrlHasUnreservedIpAddress
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESSThe Custom Login URL has an IP address which is not reserved for the current project.
DuplicateScanName
DUPLICATE_SCAN_NAMEAnother scan with the same name (case-sensitive) already exists.
InvalidFieldValue
INVALID_FIELD_VALUEA field is set to an invalid value.
FailedToAuthenticateToTarget
FAILED_TO_AUTHENTICATE_TO_TARGETThere was an error trying to authenticate to the scan target.
FindingTypeUnspecified
FINDING_TYPE_UNSPECIFIEDFinding type value is not specified in the list findings request.
ForbiddenToScanCompute
FORBIDDEN_TO_SCAN_COMPUTEScan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.
ForbiddenUpdateToManagedScan
FORBIDDEN_UPDATE_TO_MANAGED_SCANUser tries to update managed scan
MalformedFilter
MALFORMED_FILTERThe supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.
MalformedResourceName
MALFORMED_RESOURCE_NAMEThe supplied resource name is malformed (can not be parsed).
ProjectInactive
PROJECT_INACTIVEThe current project is not in an active state.
RequiredField
REQUIRED_FIELDA required field is not set.
ResourceNameInconsistent
RESOURCE_NAME_INCONSISTENTProject id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.
ScanAlreadyRunning
SCAN_ALREADY_RUNNINGThe scan being requested to start is already running.
ScanNotRunning
SCAN_NOT_RUNNINGThe scan that was requested to be stopped is not running.
SeedUrlDoesNotBelongToCurrentProject
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTOne of the seed URLs does not belong to the current project.
SeedUrlMalformed
SEED_URL_MALFORMEDOne of the seed URLs is malformed (can not be parsed).
SeedUrlMappedToNonRoutableAddress
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSOne of the seed URLs is mapped to a non-routable IP address in DNS.
SeedUrlMappedToUnreservedAddress
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESSOne of the seed URLs is mapped to an IP address which is not reserved for the current project.
SeedUrlHasNonRoutableIpAddress
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESSOne of the seed URLs has on-routable IP address.
SeedUrlHasUnreservedIpAddress
SEED_URL_HAS_UNRESERVED_IP_ADDRESSOne of the seed URLs has an IP address that is not reserved for the current project.
ServiceAccountNotConfigured
SERVICE_ACCOUNT_NOT_CONFIGUREDThe Web Security Scanner service account is not configured under the project.
TooManyScans
TOO_MANY_SCANSA project has reached the maximum number of scans.
UnableToResolveProjectInfo
UNABLE_TO_RESOLVE_PROJECT_INFOResolving the details of the current project fails.
UnsupportedBlacklistPatternFormat
UNSUPPORTED_BLACKLIST_PATTERN_FORMATOne or more blacklist patterns were in the wrong format.
UnsupportedFilter
UNSUPPORTED_FILTERThe supplied filter is not supported.
UnsupportedFindingType
UNSUPPORTED_FINDING_TYPEThe supplied finding type is not supported. For example, we do not provide findings of the given finding type.
UnsupportedUrlScheme
UNSUPPORTED_URL_SCHEMEThe URL scheme of one or more of the supplied URLs is not supported.
CloudAssetInventoryAssetNotFound
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUNDCAI is not able to list assets.
CODE_UNSPECIFIED
CODE_UNSPECIFIEDThere is no error.
OK
OKThere is no error.
INTERNAL_ERROR
INTERNAL_ERRORIndicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
APPENGINE_API_BACKEND_ERROR
APPENGINE_API_BACKEND_ERROROne of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.
APPENGINE_API_NOT_ACCESSIBLE
APPENGINE_API_NOT_ACCESSIBLEOne of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.
APPENGINE_DEFAULT_HOST_MISSING
APPENGINE_DEFAULT_HOST_MISSINGOne of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.
CANNOT_USE_GOOGLE_COM_ACCOUNT
CANNOT_USE_GOOGLE_COM_ACCOUNTGoogle corporate accounts can not be used for scanning.
CANNOT_USE_OWNER_ACCOUNT
CANNOT_USE_OWNER_ACCOUNTThe account of the scan creator can not be used for scanning.
COMPUTE_API_BACKEND_ERROR
COMPUTE_API_BACKEND_ERRORThis scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.
COMPUTE_API_NOT_ACCESSIBLE
COMPUTE_API_NOT_ACCESSIBLEThis scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTThe Custom Login URL does not belong to the current project.
CUSTOM_LOGIN_URL_MALFORMED
CUSTOM_LOGIN_URL_MALFORMEDThe Custom Login URL is malformed (can not be parsed).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSThe Custom Login URL is mapped to a non-routable IP address in DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESSThe Custom Login URL is mapped to an IP address which is not reserved for the current project.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESSThe Custom Login URL has a non-routable IP address.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESSThe Custom Login URL has an IP address which is not reserved for the current project.
DUPLICATE_SCAN_NAME
DUPLICATE_SCAN_NAMEAnother scan with the same name (case-sensitive) already exists.
INVALID_FIELD_VALUE
INVALID_FIELD_VALUEA field is set to an invalid value.
FAILED_TO_AUTHENTICATE_TO_TARGET
FAILED_TO_AUTHENTICATE_TO_TARGETThere was an error trying to authenticate to the scan target.
FINDING_TYPE_UNSPECIFIED
FINDING_TYPE_UNSPECIFIEDFinding type value is not specified in the list findings request.
FORBIDDEN_TO_SCAN_COMPUTE
FORBIDDEN_TO_SCAN_COMPUTEScan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN
FORBIDDEN_UPDATE_TO_MANAGED_SCANUser tries to update managed scan
MALFORMED_FILTER
MALFORMED_FILTERThe supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.
MALFORMED_RESOURCE_NAME
MALFORMED_RESOURCE_NAMEThe supplied resource name is malformed (can not be parsed).
PROJECT_INACTIVE
PROJECT_INACTIVEThe current project is not in an active state.
REQUIRED_FIELD
REQUIRED_FIELDA required field is not set.
RESOURCE_NAME_INCONSISTENT
RESOURCE_NAME_INCONSISTENTProject id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.
SCAN_ALREADY_RUNNING
SCAN_ALREADY_RUNNINGThe scan being requested to start is already running.
SCAN_NOT_RUNNING
SCAN_NOT_RUNNINGThe scan that was requested to be stopped is not running.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTOne of the seed URLs does not belong to the current project.
SEED_URL_MALFORMED
SEED_URL_MALFORMEDOne of the seed URLs is malformed (can not be parsed).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSOne of the seed URLs is mapped to a non-routable IP address in DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESSOne of the seed URLs is mapped to an IP address which is not reserved for the current project.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESSOne of the seed URLs has on-routable IP address.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS
SEED_URL_HAS_UNRESERVED_IP_ADDRESSOne of the seed URLs has an IP address that is not reserved for the current project.
SERVICE_ACCOUNT_NOT_CONFIGURED
SERVICE_ACCOUNT_NOT_CONFIGUREDThe Web Security Scanner service account is not configured under the project.
TOO_MANY_SCANS
TOO_MANY_SCANSA project has reached the maximum number of scans.
UNABLE_TO_RESOLVE_PROJECT_INFO
UNABLE_TO_RESOLVE_PROJECT_INFOResolving the details of the current project fails.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT
UNSUPPORTED_BLACKLIST_PATTERN_FORMATOne or more blacklist patterns were in the wrong format.
UNSUPPORTED_FILTER
UNSUPPORTED_FILTERThe supplied filter is not supported.
UNSUPPORTED_FINDING_TYPE
UNSUPPORTED_FINDING_TYPEThe supplied finding type is not supported. For example, we do not provide findings of the given finding type.
UNSUPPORTED_URL_SCHEME
UNSUPPORTED_URL_SCHEMEThe URL scheme of one or more of the supplied URLs is not supported.
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUNDCAI is not able to list assets.
"CODE_UNSPECIFIED"
CODE_UNSPECIFIEDThere is no error.
"OK"
OKThere is no error.
"INTERNAL_ERROR"
INTERNAL_ERRORIndicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
"APPENGINE_API_BACKEND_ERROR"
APPENGINE_API_BACKEND_ERROROne of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.
"APPENGINE_API_NOT_ACCESSIBLE"
APPENGINE_API_NOT_ACCESSIBLEOne of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.
"APPENGINE_DEFAULT_HOST_MISSING"
APPENGINE_DEFAULT_HOST_MISSINGOne of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.
"CANNOT_USE_GOOGLE_COM_ACCOUNT"
CANNOT_USE_GOOGLE_COM_ACCOUNTGoogle corporate accounts can not be used for scanning.
"CANNOT_USE_OWNER_ACCOUNT"
CANNOT_USE_OWNER_ACCOUNTThe account of the scan creator can not be used for scanning.
"COMPUTE_API_BACKEND_ERROR"
COMPUTE_API_BACKEND_ERRORThis scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.
"COMPUTE_API_NOT_ACCESSIBLE"
COMPUTE_API_NOT_ACCESSIBLEThis scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.
"CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT"
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTThe Custom Login URL does not belong to the current project.
"CUSTOM_LOGIN_URL_MALFORMED"
CUSTOM_LOGIN_URL_MALFORMEDThe Custom Login URL is malformed (can not be parsed).
"CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS"
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSThe Custom Login URL is mapped to a non-routable IP address in DNS.
"CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS"
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESSThe Custom Login URL is mapped to an IP address which is not reserved for the current project.
"CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS"
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESSThe Custom Login URL has a non-routable IP address.
"CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS"
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESSThe Custom Login URL has an IP address which is not reserved for the current project.
"DUPLICATE_SCAN_NAME"
DUPLICATE_SCAN_NAMEAnother scan with the same name (case-sensitive) already exists.
"INVALID_FIELD_VALUE"
INVALID_FIELD_VALUEA field is set to an invalid value.
"FAILED_TO_AUTHENTICATE_TO_TARGET"
FAILED_TO_AUTHENTICATE_TO_TARGETThere was an error trying to authenticate to the scan target.
"FINDING_TYPE_UNSPECIFIED"
FINDING_TYPE_UNSPECIFIEDFinding type value is not specified in the list findings request.
"FORBIDDEN_TO_SCAN_COMPUTE"
FORBIDDEN_TO_SCAN_COMPUTEScan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.
"FORBIDDEN_UPDATE_TO_MANAGED_SCAN"
FORBIDDEN_UPDATE_TO_MANAGED_SCANUser tries to update managed scan
"MALFORMED_FILTER"
MALFORMED_FILTERThe supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.
"MALFORMED_RESOURCE_NAME"
MALFORMED_RESOURCE_NAMEThe supplied resource name is malformed (can not be parsed).
"PROJECT_INACTIVE"
PROJECT_INACTIVEThe current project is not in an active state.
"REQUIRED_FIELD"
REQUIRED_FIELDA required field is not set.
"RESOURCE_NAME_INCONSISTENT"
RESOURCE_NAME_INCONSISTENTProject id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.
"SCAN_ALREADY_RUNNING"
SCAN_ALREADY_RUNNINGThe scan being requested to start is already running.
"SCAN_NOT_RUNNING"
SCAN_NOT_RUNNINGThe scan that was requested to be stopped is not running.
"SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT"
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECTOne of the seed URLs does not belong to the current project.
"SEED_URL_MALFORMED"
SEED_URL_MALFORMEDOne of the seed URLs is malformed (can not be parsed).
"SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS"
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESSOne of the seed URLs is mapped to a non-routable IP address in DNS.
"SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS"
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESSOne of the seed URLs is mapped to an IP address which is not reserved for the current project.
"SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS"
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESSOne of the seed URLs has on-routable IP address.
"SEED_URL_HAS_UNRESERVED_IP_ADDRESS"
SEED_URL_HAS_UNRESERVED_IP_ADDRESSOne of the seed URLs has an IP address that is not reserved for the current project.
"SERVICE_ACCOUNT_NOT_CONFIGURED"
SERVICE_ACCOUNT_NOT_CONFIGUREDThe Web Security Scanner service account is not configured under the project.
"TOO_MANY_SCANS"
TOO_MANY_SCANSA project has reached the maximum number of scans.
"UNABLE_TO_RESOLVE_PROJECT_INFO"
UNABLE_TO_RESOLVE_PROJECT_INFOResolving the details of the current project fails.
"UNSUPPORTED_BLACKLIST_PATTERN_FORMAT"
UNSUPPORTED_BLACKLIST_PATTERN_FORMATOne or more blacklist patterns were in the wrong format.
"UNSUPPORTED_FILTER"
UNSUPPORTED_FILTERThe supplied filter is not supported.
"UNSUPPORTED_FINDING_TYPE"
UNSUPPORTED_FINDING_TYPEThe supplied finding type is not supported. For example, we do not provide findings of the given finding type.
"UNSUPPORTED_URL_SCHEME"
UNSUPPORTED_URL_SCHEMEThe URL scheme of one or more of the supplied URLs is not supported.
"CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND"
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUNDCAI is not able to list assets.

ScanConfigErrorResponse
, ScanConfigErrorResponseArgs

Code This property is required. string
Indicates the reason code for a configuration failure.
FieldName This property is required. string
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
Code This property is required. string
Indicates the reason code for a configuration failure.
FieldName This property is required. string
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code This property is required. String
Indicates the reason code for a configuration failure.
fieldName This property is required. String
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code This property is required. string
Indicates the reason code for a configuration failure.
fieldName This property is required. string
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code This property is required. str
Indicates the reason code for a configuration failure.
field_name This property is required. str
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
code This property is required. String
Indicates the reason code for a configuration failure.
fieldName This property is required. String
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

ScanConfigExportToSecurityCommandCenter
, ScanConfigExportToSecurityCommandCenterArgs

ExportToSecurityCommandCenterUnspecified
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIEDUse default, which is ENABLED.
Enabled
ENABLEDExport results of this scan to Security Command Center.
Disabled
DISABLEDDo not export results of this scan to Security Command Center.
ScanConfigExportToSecurityCommandCenterExportToSecurityCommandCenterUnspecified
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIEDUse default, which is ENABLED.
ScanConfigExportToSecurityCommandCenterEnabled
ENABLEDExport results of this scan to Security Command Center.
ScanConfigExportToSecurityCommandCenterDisabled
DISABLEDDo not export results of this scan to Security Command Center.
ExportToSecurityCommandCenterUnspecified
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIEDUse default, which is ENABLED.
Enabled
ENABLEDExport results of this scan to Security Command Center.
Disabled
DISABLEDDo not export results of this scan to Security Command Center.
ExportToSecurityCommandCenterUnspecified
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIEDUse default, which is ENABLED.
Enabled
ENABLEDExport results of this scan to Security Command Center.
Disabled
DISABLEDDo not export results of this scan to Security Command Center.
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIEDUse default, which is ENABLED.
ENABLED
ENABLEDExport results of this scan to Security Command Center.
DISABLED
DISABLEDDo not export results of this scan to Security Command Center.
"EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED"
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIEDUse default, which is ENABLED.
"ENABLED"
ENABLEDExport results of this scan to Security Command Center.
"DISABLED"
DISABLEDDo not export results of this scan to Security Command Center.

ScanConfigRiskLevel
, ScanConfigRiskLevelArgs

RiskLevelUnspecified
RISK_LEVEL_UNSPECIFIEDUse default, which is NORMAL.
Normal
NORMALNormal scanning (Recommended)
Low
LOWLower impact scanning
ScanConfigRiskLevelRiskLevelUnspecified
RISK_LEVEL_UNSPECIFIEDUse default, which is NORMAL.
ScanConfigRiskLevelNormal
NORMALNormal scanning (Recommended)
ScanConfigRiskLevelLow
LOWLower impact scanning
RiskLevelUnspecified
RISK_LEVEL_UNSPECIFIEDUse default, which is NORMAL.
Normal
NORMALNormal scanning (Recommended)
Low
LOWLower impact scanning
RiskLevelUnspecified
RISK_LEVEL_UNSPECIFIEDUse default, which is NORMAL.
Normal
NORMALNormal scanning (Recommended)
Low
LOWLower impact scanning
RISK_LEVEL_UNSPECIFIED
RISK_LEVEL_UNSPECIFIEDUse default, which is NORMAL.
NORMAL
NORMALNormal scanning (Recommended)
LOW
LOWLower impact scanning
"RISK_LEVEL_UNSPECIFIED"
RISK_LEVEL_UNSPECIFIEDUse default, which is NORMAL.
"NORMAL"
NORMALNormal scanning (Recommended)
"LOW"
LOWLower impact scanning

ScanConfigTargetPlatformsItem
, ScanConfigTargetPlatformsItemArgs

TargetPlatformUnspecified
TARGET_PLATFORM_UNSPECIFIEDThe target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.
AppEngine
APP_ENGINEGoogle App Engine service.
Compute
COMPUTEGoogle Compute Engine service.
CloudRun
CLOUD_RUNGoogle Cloud Run service.
CloudFunctions
CLOUD_FUNCTIONSGoogle Cloud Function service.
ScanConfigTargetPlatformsItemTargetPlatformUnspecified
TARGET_PLATFORM_UNSPECIFIEDThe target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.
ScanConfigTargetPlatformsItemAppEngine
APP_ENGINEGoogle App Engine service.
ScanConfigTargetPlatformsItemCompute
COMPUTEGoogle Compute Engine service.
ScanConfigTargetPlatformsItemCloudRun
CLOUD_RUNGoogle Cloud Run service.
ScanConfigTargetPlatformsItemCloudFunctions
CLOUD_FUNCTIONSGoogle Cloud Function service.
TargetPlatformUnspecified
TARGET_PLATFORM_UNSPECIFIEDThe target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.
AppEngine
APP_ENGINEGoogle App Engine service.
Compute
COMPUTEGoogle Compute Engine service.
CloudRun
CLOUD_RUNGoogle Cloud Run service.
CloudFunctions
CLOUD_FUNCTIONSGoogle Cloud Function service.
TargetPlatformUnspecified
TARGET_PLATFORM_UNSPECIFIEDThe target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.
AppEngine
APP_ENGINEGoogle App Engine service.
Compute
COMPUTEGoogle Compute Engine service.
CloudRun
CLOUD_RUNGoogle Cloud Run service.
CloudFunctions
CLOUD_FUNCTIONSGoogle Cloud Function service.
TARGET_PLATFORM_UNSPECIFIED
TARGET_PLATFORM_UNSPECIFIEDThe target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.
APP_ENGINE
APP_ENGINEGoogle App Engine service.
COMPUTE
COMPUTEGoogle Compute Engine service.
CLOUD_RUN
CLOUD_RUNGoogle Cloud Run service.
CLOUD_FUNCTIONS
CLOUD_FUNCTIONSGoogle Cloud Function service.
"TARGET_PLATFORM_UNSPECIFIED"
TARGET_PLATFORM_UNSPECIFIEDThe target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.
"APP_ENGINE"
APP_ENGINEGoogle App Engine service.
"COMPUTE"
COMPUTEGoogle Compute Engine service.
"CLOUD_RUN"
CLOUD_RUNGoogle Cloud Run service.
"CLOUD_FUNCTIONS"
CLOUD_FUNCTIONSGoogle Cloud Function service.

ScanConfigUserAgent
, ScanConfigUserAgentArgs

UserAgentUnspecified
USER_AGENT_UNSPECIFIEDThe user agent is unknown. Service will default to CHROME_LINUX.
ChromeLinux
CHROME_LINUXChrome on Linux. This is the service default if unspecified.
ChromeAndroid
CHROME_ANDROIDChrome on Android.
SafariIphone
SAFARI_IPHONESafari on IPhone.
ScanConfigUserAgentUserAgentUnspecified
USER_AGENT_UNSPECIFIEDThe user agent is unknown. Service will default to CHROME_LINUX.
ScanConfigUserAgentChromeLinux
CHROME_LINUXChrome on Linux. This is the service default if unspecified.
ScanConfigUserAgentChromeAndroid
CHROME_ANDROIDChrome on Android.
ScanConfigUserAgentSafariIphone
SAFARI_IPHONESafari on IPhone.
UserAgentUnspecified
USER_AGENT_UNSPECIFIEDThe user agent is unknown. Service will default to CHROME_LINUX.
ChromeLinux
CHROME_LINUXChrome on Linux. This is the service default if unspecified.
ChromeAndroid
CHROME_ANDROIDChrome on Android.
SafariIphone
SAFARI_IPHONESafari on IPhone.
UserAgentUnspecified
USER_AGENT_UNSPECIFIEDThe user agent is unknown. Service will default to CHROME_LINUX.
ChromeLinux
CHROME_LINUXChrome on Linux. This is the service default if unspecified.
ChromeAndroid
CHROME_ANDROIDChrome on Android.
SafariIphone
SAFARI_IPHONESafari on IPhone.
USER_AGENT_UNSPECIFIED
USER_AGENT_UNSPECIFIEDThe user agent is unknown. Service will default to CHROME_LINUX.
CHROME_LINUX
CHROME_LINUXChrome on Linux. This is the service default if unspecified.
CHROME_ANDROID
CHROME_ANDROIDChrome on Android.
SAFARI_IPHONE
SAFARI_IPHONESafari on IPhone.
"USER_AGENT_UNSPECIFIED"
USER_AGENT_UNSPECIFIEDThe user agent is unknown. Service will default to CHROME_LINUX.
"CHROME_LINUX"
CHROME_LINUXChrome on Linux. This is the service default if unspecified.
"CHROME_ANDROID"
CHROME_ANDROIDChrome on Android.
"SAFARI_IPHONE"
SAFARI_IPHONESafari on IPhone.

ScanRun
, ScanRunArgs

EndTime string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ErrorTrace Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunErrorTrace
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
ExecutionState Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanRunExecutionState
The execution state of the ScanRun.
HasVulnerabilities bool
Whether the scan run has found any vulnerabilities.
Name string
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
ProgressPercent int
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
ResultState Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanRunResultState
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime string
The time at which the ScanRun started.
UrlsCrawledCount string
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
UrlsTestedCount string
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
WarningTraces List<Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunWarningTrace>
A list of warnings, if such are encountered during this scan run.
EndTime string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ErrorTrace ScanRunErrorTrace
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
ExecutionState ScanRunExecutionState
The execution state of the ScanRun.
HasVulnerabilities bool
Whether the scan run has found any vulnerabilities.
Name string
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
ProgressPercent int
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
ResultState ScanRunResultState
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime string
The time at which the ScanRun started.
UrlsCrawledCount string
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
UrlsTestedCount string
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
WarningTraces []ScanRunWarningTrace
A list of warnings, if such are encountered during this scan run.
endTime String
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace ScanRunErrorTrace
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState ScanRunExecutionState
The execution state of the ScanRun.
hasVulnerabilities Boolean
Whether the scan run has found any vulnerabilities.
name String
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent Integer
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState ScanRunResultState
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime String
The time at which the ScanRun started.
urlsCrawledCount String
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount String
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces List<ScanRunWarningTrace>
A list of warnings, if such are encountered during this scan run.
endTime string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace ScanRunErrorTrace
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState ScanRunExecutionState
The execution state of the ScanRun.
hasVulnerabilities boolean
Whether the scan run has found any vulnerabilities.
name string
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent number
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState ScanRunResultState
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime string
The time at which the ScanRun started.
urlsCrawledCount string
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount string
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces ScanRunWarningTrace[]
A list of warnings, if such are encountered during this scan run.
end_time str
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
error_trace ScanRunErrorTrace
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
execution_state ScanRunExecutionState
The execution state of the ScanRun.
has_vulnerabilities bool
Whether the scan run has found any vulnerabilities.
name str
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progress_percent int
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
result_state ScanRunResultState
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
start_time str
The time at which the ScanRun started.
urls_crawled_count str
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urls_tested_count str
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warning_traces Sequence[ScanRunWarningTrace]
A list of warnings, if such are encountered during this scan run.
endTime String
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace Property Map
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState "EXECUTION_STATE_UNSPECIFIED" | "QUEUED" | "SCANNING" | "FINISHED"
The execution state of the ScanRun.
hasVulnerabilities Boolean
Whether the scan run has found any vulnerabilities.
name String
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent Number
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState "RESULT_STATE_UNSPECIFIED" | "SUCCESS" | "ERROR" | "KILLED"
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime String
The time at which the ScanRun started.
urlsCrawledCount String
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount String
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces List<Property Map>
A list of warnings, if such are encountered during this scan run.

ScanRunErrorTrace
, ScanRunErrorTraceArgs

Code Pulumi.GoogleNative.WebSecurityScanner.V1Beta.ScanRunErrorTraceCode
Indicates the error reason code.
MostCommonHttpErrorCode int
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
ScanConfigError Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanConfigError
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
Code ScanRunErrorTraceCode
Indicates the error reason code.
MostCommonHttpErrorCode int
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
ScanConfigError ScanConfigError
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code ScanRunErrorTraceCode
Indicates the error reason code.
mostCommonHttpErrorCode Integer
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError ScanConfigError
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code ScanRunErrorTraceCode
Indicates the error reason code.
mostCommonHttpErrorCode number
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError ScanConfigError
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code ScanRunErrorTraceCode
Indicates the error reason code.
most_common_http_error_code int
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scan_config_error ScanConfigError
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code "CODE_UNSPECIFIED" | "INTERNAL_ERROR" | "SCAN_CONFIG_ISSUE" | "AUTHENTICATION_CONFIG_ISSUE" | "TIMED_OUT_WHILE_SCANNING" | "TOO_MANY_REDIRECTS" | "TOO_MANY_HTTP_ERRORS" | "STARTING_URLS_CRAWL_HTTP_ERRORS"
Indicates the error reason code.
mostCommonHttpErrorCode Number
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError Property Map
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

ScanRunErrorTraceCode
, ScanRunErrorTraceCodeArgs

CodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
InternalError
INTERNAL_ERRORIndicates that the scan run failed due to an internal server error.
ScanConfigIssue
SCAN_CONFIG_ISSUEIndicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.
AuthenticationConfigIssue
AUTHENTICATION_CONFIG_ISSUEIndicates an authentication error, usually due to outdated ScanConfig authentication settings.
TimedOutWhileScanning
TIMED_OUT_WHILE_SCANNINGIndicates a scan operation timeout, usually caused by a very large site.
TooManyRedirects
TOO_MANY_REDIRECTSIndicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.
TooManyHttpErrors
TOO_MANY_HTTP_ERRORSIndicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan.
StartingUrlsCrawlHttpErrors
STARTING_URLS_CRAWL_HTTP_ERRORSIndicates that some of the starting web urls returned HTTP errors during the scan.
ScanRunErrorTraceCodeCodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
ScanRunErrorTraceCodeInternalError
INTERNAL_ERRORIndicates that the scan run failed due to an internal server error.
ScanRunErrorTraceCodeScanConfigIssue
SCAN_CONFIG_ISSUEIndicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.
ScanRunErrorTraceCodeAuthenticationConfigIssue
AUTHENTICATION_CONFIG_ISSUEIndicates an authentication error, usually due to outdated ScanConfig authentication settings.
ScanRunErrorTraceCodeTimedOutWhileScanning
TIMED_OUT_WHILE_SCANNINGIndicates a scan operation timeout, usually caused by a very large site.
ScanRunErrorTraceCodeTooManyRedirects
TOO_MANY_REDIRECTSIndicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.
ScanRunErrorTraceCodeTooManyHttpErrors
TOO_MANY_HTTP_ERRORSIndicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan.
ScanRunErrorTraceCodeStartingUrlsCrawlHttpErrors
STARTING_URLS_CRAWL_HTTP_ERRORSIndicates that some of the starting web urls returned HTTP errors during the scan.
CodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
InternalError
INTERNAL_ERRORIndicates that the scan run failed due to an internal server error.
ScanConfigIssue
SCAN_CONFIG_ISSUEIndicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.
AuthenticationConfigIssue
AUTHENTICATION_CONFIG_ISSUEIndicates an authentication error, usually due to outdated ScanConfig authentication settings.
TimedOutWhileScanning
TIMED_OUT_WHILE_SCANNINGIndicates a scan operation timeout, usually caused by a very large site.
TooManyRedirects
TOO_MANY_REDIRECTSIndicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.
TooManyHttpErrors
TOO_MANY_HTTP_ERRORSIndicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan.
StartingUrlsCrawlHttpErrors
STARTING_URLS_CRAWL_HTTP_ERRORSIndicates that some of the starting web urls returned HTTP errors during the scan.
CodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
InternalError
INTERNAL_ERRORIndicates that the scan run failed due to an internal server error.
ScanConfigIssue
SCAN_CONFIG_ISSUEIndicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.
AuthenticationConfigIssue
AUTHENTICATION_CONFIG_ISSUEIndicates an authentication error, usually due to outdated ScanConfig authentication settings.
TimedOutWhileScanning
TIMED_OUT_WHILE_SCANNINGIndicates a scan operation timeout, usually caused by a very large site.
TooManyRedirects
TOO_MANY_REDIRECTSIndicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.
TooManyHttpErrors
TOO_MANY_HTTP_ERRORSIndicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan.
StartingUrlsCrawlHttpErrors
STARTING_URLS_CRAWL_HTTP_ERRORSIndicates that some of the starting web urls returned HTTP errors during the scan.
CODE_UNSPECIFIED
CODE_UNSPECIFIEDDefault value is never used.
INTERNAL_ERROR
INTERNAL_ERRORIndicates that the scan run failed due to an internal server error.
SCAN_CONFIG_ISSUE
SCAN_CONFIG_ISSUEIndicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.
AUTHENTICATION_CONFIG_ISSUE
AUTHENTICATION_CONFIG_ISSUEIndicates an authentication error, usually due to outdated ScanConfig authentication settings.
TIMED_OUT_WHILE_SCANNING
TIMED_OUT_WHILE_SCANNINGIndicates a scan operation timeout, usually caused by a very large site.
TOO_MANY_REDIRECTS
TOO_MANY_REDIRECTSIndicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.
TOO_MANY_HTTP_ERRORS
TOO_MANY_HTTP_ERRORSIndicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan.
STARTING_URLS_CRAWL_HTTP_ERRORS
STARTING_URLS_CRAWL_HTTP_ERRORSIndicates that some of the starting web urls returned HTTP errors during the scan.
"CODE_UNSPECIFIED"
CODE_UNSPECIFIEDDefault value is never used.
"INTERNAL_ERROR"
INTERNAL_ERRORIndicates that the scan run failed due to an internal server error.
"SCAN_CONFIG_ISSUE"
SCAN_CONFIG_ISSUEIndicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.
"AUTHENTICATION_CONFIG_ISSUE"
AUTHENTICATION_CONFIG_ISSUEIndicates an authentication error, usually due to outdated ScanConfig authentication settings.
"TIMED_OUT_WHILE_SCANNING"
TIMED_OUT_WHILE_SCANNINGIndicates a scan operation timeout, usually caused by a very large site.
"TOO_MANY_REDIRECTS"
TOO_MANY_REDIRECTSIndicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.
"TOO_MANY_HTTP_ERRORS"
TOO_MANY_HTTP_ERRORSIndicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan.
"STARTING_URLS_CRAWL_HTTP_ERRORS"
STARTING_URLS_CRAWL_HTTP_ERRORSIndicates that some of the starting web urls returned HTTP errors during the scan.

ScanRunErrorTraceResponse
, ScanRunErrorTraceResponseArgs

Code This property is required. string
Indicates the error reason code.
MostCommonHttpErrorCode This property is required. int
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
ScanConfigError This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanConfigErrorResponse
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
Code This property is required. string
Indicates the error reason code.
MostCommonHttpErrorCode This property is required. int
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
ScanConfigError This property is required. ScanConfigErrorResponse
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code This property is required. String
Indicates the error reason code.
mostCommonHttpErrorCode This property is required. Integer
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError This property is required. ScanConfigErrorResponse
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code This property is required. string
Indicates the error reason code.
mostCommonHttpErrorCode This property is required. number
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError This property is required. ScanConfigErrorResponse
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code This property is required. str
Indicates the error reason code.
most_common_http_error_code This property is required. int
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scan_config_error This property is required. ScanConfigErrorResponse
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
code This property is required. String
Indicates the error reason code.
mostCommonHttpErrorCode This property is required. Number
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError This property is required. Property Map
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

ScanRunExecutionState
, ScanRunExecutionStateArgs

ExecutionStateUnspecified
EXECUTION_STATE_UNSPECIFIEDRepresents an invalid state caused by internal server error. This value should never be returned.
Queued
QUEUEDThe scan is waiting in the queue.
Scanning
SCANNINGThe scan is in progress.
Finished
FINISHEDThe scan is either finished or stopped by user.
ScanRunExecutionStateExecutionStateUnspecified
EXECUTION_STATE_UNSPECIFIEDRepresents an invalid state caused by internal server error. This value should never be returned.
ScanRunExecutionStateQueued
QUEUEDThe scan is waiting in the queue.
ScanRunExecutionStateScanning
SCANNINGThe scan is in progress.
ScanRunExecutionStateFinished
FINISHEDThe scan is either finished or stopped by user.
ExecutionStateUnspecified
EXECUTION_STATE_UNSPECIFIEDRepresents an invalid state caused by internal server error. This value should never be returned.
Queued
QUEUEDThe scan is waiting in the queue.
Scanning
SCANNINGThe scan is in progress.
Finished
FINISHEDThe scan is either finished or stopped by user.
ExecutionStateUnspecified
EXECUTION_STATE_UNSPECIFIEDRepresents an invalid state caused by internal server error. This value should never be returned.
Queued
QUEUEDThe scan is waiting in the queue.
Scanning
SCANNINGThe scan is in progress.
Finished
FINISHEDThe scan is either finished or stopped by user.
EXECUTION_STATE_UNSPECIFIED
EXECUTION_STATE_UNSPECIFIEDRepresents an invalid state caused by internal server error. This value should never be returned.
QUEUED
QUEUEDThe scan is waiting in the queue.
SCANNING
SCANNINGThe scan is in progress.
FINISHED
FINISHEDThe scan is either finished or stopped by user.
"EXECUTION_STATE_UNSPECIFIED"
EXECUTION_STATE_UNSPECIFIEDRepresents an invalid state caused by internal server error. This value should never be returned.
"QUEUED"
QUEUEDThe scan is waiting in the queue.
"SCANNING"
SCANNINGThe scan is in progress.
"FINISHED"
FINISHEDThe scan is either finished or stopped by user.

ScanRunResponse
, ScanRunResponseArgs

EndTime This property is required. string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ErrorTrace This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunErrorTraceResponse
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
ExecutionState This property is required. string
The execution state of the ScanRun.
HasVulnerabilities This property is required. bool
Whether the scan run has found any vulnerabilities.
Name This property is required. string
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
ProgressPercent This property is required. int
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
ResultState This property is required. string
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime This property is required. string
The time at which the ScanRun started.
UrlsCrawledCount This property is required. string
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
UrlsTestedCount This property is required. string
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
WarningTraces This property is required. List<Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunWarningTraceResponse>
A list of warnings, if such are encountered during this scan run.
EndTime This property is required. string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ErrorTrace This property is required. ScanRunErrorTraceResponse
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
ExecutionState This property is required. string
The execution state of the ScanRun.
HasVulnerabilities This property is required. bool
Whether the scan run has found any vulnerabilities.
Name This property is required. string
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
ProgressPercent This property is required. int
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
ResultState This property is required. string
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime This property is required. string
The time at which the ScanRun started.
UrlsCrawledCount This property is required. string
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
UrlsTestedCount This property is required. string
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
WarningTraces This property is required. []ScanRunWarningTraceResponse
A list of warnings, if such are encountered during this scan run.
endTime This property is required. String
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace This property is required. ScanRunErrorTraceResponse
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState This property is required. String
The execution state of the ScanRun.
hasVulnerabilities This property is required. Boolean
Whether the scan run has found any vulnerabilities.
name This property is required. String
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent This property is required. Integer
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState This property is required. String
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime This property is required. String
The time at which the ScanRun started.
urlsCrawledCount This property is required. String
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount This property is required. String
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces This property is required. List<ScanRunWarningTraceResponse>
A list of warnings, if such are encountered during this scan run.
endTime This property is required. string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace This property is required. ScanRunErrorTraceResponse
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState This property is required. string
The execution state of the ScanRun.
hasVulnerabilities This property is required. boolean
Whether the scan run has found any vulnerabilities.
name This property is required. string
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent This property is required. number
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState This property is required. string
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime This property is required. string
The time at which the ScanRun started.
urlsCrawledCount This property is required. string
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount This property is required. string
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces This property is required. ScanRunWarningTraceResponse[]
A list of warnings, if such are encountered during this scan run.
end_time This property is required. str
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
error_trace This property is required. ScanRunErrorTraceResponse
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
execution_state This property is required. str
The execution state of the ScanRun.
has_vulnerabilities This property is required. bool
Whether the scan run has found any vulnerabilities.
name This property is required. str
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progress_percent This property is required. int
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
result_state This property is required. str
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
start_time This property is required. str
The time at which the ScanRun started.
urls_crawled_count This property is required. str
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urls_tested_count This property is required. str
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warning_traces This property is required. Sequence[ScanRunWarningTraceResponse]
A list of warnings, if such are encountered during this scan run.
endTime This property is required. String
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace This property is required. Property Map
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState This property is required. String
The execution state of the ScanRun.
hasVulnerabilities This property is required. Boolean
Whether the scan run has found any vulnerabilities.
name This property is required. String
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent This property is required. Number
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState This property is required. String
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime This property is required. String
The time at which the ScanRun started.
urlsCrawledCount This property is required. String
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount This property is required. String
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces This property is required. List<Property Map>
A list of warnings, if such are encountered during this scan run.

ScanRunResultState
, ScanRunResultStateArgs

ResultStateUnspecified
RESULT_STATE_UNSPECIFIEDDefault value. This value is returned when the ScanRun is not yet finished.
Success
SUCCESSThe scan finished without errors.
Error
ERRORThe scan finished with errors.
Killed
KILLEDThe scan was terminated by user.
ScanRunResultStateResultStateUnspecified
RESULT_STATE_UNSPECIFIEDDefault value. This value is returned when the ScanRun is not yet finished.
ScanRunResultStateSuccess
SUCCESSThe scan finished without errors.
ScanRunResultStateError
ERRORThe scan finished with errors.
ScanRunResultStateKilled
KILLEDThe scan was terminated by user.
ResultStateUnspecified
RESULT_STATE_UNSPECIFIEDDefault value. This value is returned when the ScanRun is not yet finished.
Success
SUCCESSThe scan finished without errors.
Error
ERRORThe scan finished with errors.
Killed
KILLEDThe scan was terminated by user.
ResultStateUnspecified
RESULT_STATE_UNSPECIFIEDDefault value. This value is returned when the ScanRun is not yet finished.
Success
SUCCESSThe scan finished without errors.
Error
ERRORThe scan finished with errors.
Killed
KILLEDThe scan was terminated by user.
RESULT_STATE_UNSPECIFIED
RESULT_STATE_UNSPECIFIEDDefault value. This value is returned when the ScanRun is not yet finished.
SUCCESS
SUCCESSThe scan finished without errors.
ERROR
ERRORThe scan finished with errors.
KILLED
KILLEDThe scan was terminated by user.
"RESULT_STATE_UNSPECIFIED"
RESULT_STATE_UNSPECIFIEDDefault value. This value is returned when the ScanRun is not yet finished.
"SUCCESS"
SUCCESSThe scan finished without errors.
"ERROR"
ERRORThe scan finished with errors.
"KILLED"
KILLEDThe scan was terminated by user.

ScanRunWarningTrace
, ScanRunWarningTraceArgs

Code ScanRunWarningTraceCode
Indicates the warning code.
code ScanRunWarningTraceCode
Indicates the warning code.
code ScanRunWarningTraceCode
Indicates the warning code.
code ScanRunWarningTraceCode
Indicates the warning code.

ScanRunWarningTraceCode
, ScanRunWarningTraceCodeArgs

CodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
InsufficientCrawlResults
INSUFFICIENT_CRAWL_RESULTSIndicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.
TooManyCrawlResults
TOO_MANY_CRAWL_RESULTSIndicates that a scan discovered too many URLs to test, or excessive redundant URLs.
TooManyFuzzTasks
TOO_MANY_FUZZ_TASKSIndicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.
BlockedByIap
BLOCKED_BY_IAPIndicates that a scan is blocked by IAP.
NoStartingUrlFoundForManagedScan
NO_STARTING_URL_FOUND_FOR_MANAGED_SCANIndicates that no seed is found for a scan
ScanRunWarningTraceCodeCodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
ScanRunWarningTraceCodeInsufficientCrawlResults
INSUFFICIENT_CRAWL_RESULTSIndicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.
ScanRunWarningTraceCodeTooManyCrawlResults
TOO_MANY_CRAWL_RESULTSIndicates that a scan discovered too many URLs to test, or excessive redundant URLs.
ScanRunWarningTraceCodeTooManyFuzzTasks
TOO_MANY_FUZZ_TASKSIndicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.
ScanRunWarningTraceCodeBlockedByIap
BLOCKED_BY_IAPIndicates that a scan is blocked by IAP.
ScanRunWarningTraceCodeNoStartingUrlFoundForManagedScan
NO_STARTING_URL_FOUND_FOR_MANAGED_SCANIndicates that no seed is found for a scan
CodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
InsufficientCrawlResults
INSUFFICIENT_CRAWL_RESULTSIndicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.
TooManyCrawlResults
TOO_MANY_CRAWL_RESULTSIndicates that a scan discovered too many URLs to test, or excessive redundant URLs.
TooManyFuzzTasks
TOO_MANY_FUZZ_TASKSIndicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.
BlockedByIap
BLOCKED_BY_IAPIndicates that a scan is blocked by IAP.
NoStartingUrlFoundForManagedScan
NO_STARTING_URL_FOUND_FOR_MANAGED_SCANIndicates that no seed is found for a scan
CodeUnspecified
CODE_UNSPECIFIEDDefault value is never used.
InsufficientCrawlResults
INSUFFICIENT_CRAWL_RESULTSIndicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.
TooManyCrawlResults
TOO_MANY_CRAWL_RESULTSIndicates that a scan discovered too many URLs to test, or excessive redundant URLs.
TooManyFuzzTasks
TOO_MANY_FUZZ_TASKSIndicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.
BlockedByIap
BLOCKED_BY_IAPIndicates that a scan is blocked by IAP.
NoStartingUrlFoundForManagedScan
NO_STARTING_URL_FOUND_FOR_MANAGED_SCANIndicates that no seed is found for a scan
CODE_UNSPECIFIED
CODE_UNSPECIFIEDDefault value is never used.
INSUFFICIENT_CRAWL_RESULTS
INSUFFICIENT_CRAWL_RESULTSIndicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.
TOO_MANY_CRAWL_RESULTS
TOO_MANY_CRAWL_RESULTSIndicates that a scan discovered too many URLs to test, or excessive redundant URLs.
TOO_MANY_FUZZ_TASKS
TOO_MANY_FUZZ_TASKSIndicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.
BLOCKED_BY_IAP
BLOCKED_BY_IAPIndicates that a scan is blocked by IAP.
NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN
NO_STARTING_URL_FOUND_FOR_MANAGED_SCANIndicates that no seed is found for a scan
"CODE_UNSPECIFIED"
CODE_UNSPECIFIEDDefault value is never used.
"INSUFFICIENT_CRAWL_RESULTS"
INSUFFICIENT_CRAWL_RESULTSIndicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.
"TOO_MANY_CRAWL_RESULTS"
TOO_MANY_CRAWL_RESULTSIndicates that a scan discovered too many URLs to test, or excessive redundant URLs.
"TOO_MANY_FUZZ_TASKS"
TOO_MANY_FUZZ_TASKSIndicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.
"BLOCKED_BY_IAP"
BLOCKED_BY_IAPIndicates that a scan is blocked by IAP.
"NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN"
NO_STARTING_URL_FOUND_FOR_MANAGED_SCANIndicates that no seed is found for a scan

ScanRunWarningTraceResponse
, ScanRunWarningTraceResponseArgs

Code This property is required. string
Indicates the warning code.
Code This property is required. string
Indicates the warning code.
code This property is required. String
Indicates the warning code.
code This property is required. string
Indicates the warning code.
code This property is required. str
Indicates the warning code.
code This property is required. String
Indicates the warning code.

Schedule
, ScheduleArgs

IntervalDurationDays This property is required. int
The duration of time between executions in days.
ScheduleTime string
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.
IntervalDurationDays This property is required. int
The duration of time between executions in days.
ScheduleTime string
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.
intervalDurationDays This property is required. Integer
The duration of time between executions in days.
scheduleTime String
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.
intervalDurationDays This property is required. number
The duration of time between executions in days.
scheduleTime string
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 This property is required. int
The duration of time between executions in days.
schedule_time str
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.
intervalDurationDays This property is required. Number
The duration of time between executions in days.
scheduleTime String
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.

ScheduleResponse
, ScheduleResponseArgs

IntervalDurationDays This property is required. int
The duration of time between executions in days.
ScheduleTime This property is required. string
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.
IntervalDurationDays This property is required. int
The duration of time between executions in days.
ScheduleTime This property is required. string
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.
intervalDurationDays This property is required. Integer
The duration of time between executions in days.
scheduleTime This property is required. String
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.
intervalDurationDays This property is required. number
The duration of time between executions in days.
scheduleTime This property is required. string
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 This property is required. int
The duration of time between executions in days.
schedule_time This property is required. str
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.
intervalDurationDays This property is required. Number
The duration of time between executions in days.
scheduleTime This property is required. String
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.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native