Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. websecurityscanner
  5. websecurityscanner/v1alpha
  6. ScanConfig

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.websecurityscanner/v1alpha.ScanConfig

Explore with Pulumi AI

google-native logo

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new ScanConfig.

    Create ScanConfig Resource

    new ScanConfig(name: string, args: ScanConfigArgs, opts?: CustomResourceOptions);
    @overload
def ScanConfig(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               authentication: Optional[AuthenticationArgs] = None,
               blacklist_patterns: Optional[Sequence[str]] = None,
               display_name: Optional[str] = None,
               latest_run: Optional[ScanRunArgs] = None,
               max_qps: Optional[int] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               schedule: Optional[ScheduleArgs] = None,
               starting_urls: Optional[Sequence[str]] = None,
               target_platforms: Optional[Sequence[ScanConfigTargetPlatformsItem]] = None,
               user_agent: Optional[ScanConfigUserAgent] = None)
@overload
def ScanConfig(resource_name: str,
               args: ScanConfigArgs,
               opts: Optional[ResourceOptions] = 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/v1alpha:ScanConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScanConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args ScanConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScanConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScanConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The ScanConfig resource accepts the following input properties:

    DisplayName string

    The user provided display name of the ScanConfig.

    StartingUrls List<string>

    The starting URLs from which the scanner finds site pages.

    Authentication Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.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

    LatestRun Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.Inputs.ScanRun

    Latest ScanRun if available.

    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 string
    Schedule Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.Inputs.Schedule

    The schedule of the ScanConfig.

    TargetPlatforms List<Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.ScanConfigTargetPlatformsItem>

    Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

    UserAgent Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.ScanConfigUserAgent

    The user agent used during scanning.

    DisplayName string

    The user provided display name of the ScanConfig.

    StartingUrls []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

    LatestRun ScanRunArgs

    Latest ScanRun if available.

    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 string
    Schedule ScheduleArgs

    The schedule of the ScanConfig.

    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 String

    The user provided display name of the ScanConfig.

    startingUrls 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

    latestRun ScanRun

    Latest ScanRun if available.

    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 String
    schedule Schedule

    The schedule of the ScanConfig.

    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 string

    The user provided display name of the ScanConfig.

    startingUrls 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

    latestRun ScanRun

    Latest ScanRun if available.

    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 string
    schedule Schedule

    The schedule of the ScanConfig.

    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 str

    The user provided display name of the ScanConfig.

    starting_urls 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

    latest_run ScanRunArgs

    Latest ScanRun if available.

    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 str
    schedule ScheduleArgs

    The schedule of the ScanConfig.

    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 String

    The user provided display name of the ScanConfig.

    startingUrls 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

    latestRun Property Map

    Latest ScanRun if available.

    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 String
    schedule Property Map

    The schedule of the ScanConfig.

    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.

    customAccount CustomAccount

    Authentication using a custom account.

    googleAccount GoogleAccount

    Authentication using a Google account.

    customAccount CustomAccount

    Authentication using a custom account.

    googleAccount GoogleAccount

    Authentication using a Google account.

    custom_account CustomAccount

    Authentication using a custom account.

    google_account GoogleAccount

    Authentication using a Google account.

    customAccount Property Map

    Authentication using a custom account.

    googleAccount Property Map

    Authentication using a Google account.

    AuthenticationResponse, AuthenticationResponseArgs

    CustomAccount CustomAccountResponse

    Authentication using a custom account.

    GoogleAccount GoogleAccountResponse

    Authentication using a Google account.

    customAccount CustomAccountResponse

    Authentication using a custom account.

    googleAccount GoogleAccountResponse

    Authentication using a Google account.

    customAccount CustomAccountResponse

    Authentication using a custom account.

    googleAccount GoogleAccountResponse

    Authentication using a Google account.

    custom_account CustomAccountResponse

    Authentication using a custom account.

    google_account GoogleAccountResponse

    Authentication using a Google account.

    customAccount Property Map

    Authentication using a custom account.

    googleAccount Property Map

    Authentication using a Google account.

    CustomAccount, CustomAccountArgs

    LoginUrl string

    The login form URL of the website.

    Password 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 string

    The user name of the custom account.

    LoginUrl string

    The login form URL of the website.

    Password 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 string

    The user name of the custom account.

    loginUrl String

    The login form URL of the website.

    password 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 String

    The user name of the custom account.

    loginUrl string

    The login form URL of the website.

    password 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 string

    The user name of the custom account.

    login_url str

    The login form URL of the website.

    password 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 str

    The user name of the custom account.

    loginUrl String

    The login form URL of the website.

    password 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 String

    The user name of the custom account.

    CustomAccountResponse, CustomAccountResponseArgs

    LoginUrl string

    The login form URL of the website.

    Password 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 string

    The user name of the custom account.

    LoginUrl string

    The login form URL of the website.

    Password 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 string

    The user name of the custom account.

    loginUrl String

    The login form URL of the website.

    password 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 String

    The user name of the custom account.

    loginUrl string

    The login form URL of the website.

    password 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 string

    The user name of the custom account.

    login_url str

    The login form URL of the website.

    password 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 str

    The user name of the custom account.

    loginUrl String

    The login form URL of the website.

    password 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 String

    The user name of the custom account.

    GoogleAccount, GoogleAccountArgs

    Password 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 string

    The user name of the Google account.

    Password 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 string

    The user name of the Google account.

    password 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 String

    The user name of the Google account.

    password 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 string

    The user name of the Google account.

    password 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 str

    The user name of the Google account.

    password 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 String

    The user name of the Google account.

    GoogleAccountResponse, GoogleAccountResponseArgs

    Password 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 string

    The user name of the Google account.

    Password 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 string

    The user name of the Google account.

    password 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 String

    The user name of the Google account.

    password 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 string

    The user name of the Google account.

    password 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 str

    The user name of the Google account.

    password 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 String

    The user name of the Google account.

    ScanConfigTargetPlatformsItem, ScanConfigTargetPlatformsItemArgs

    TargetPlatformUnspecified
    TARGET_PLATFORM_UNSPECIFIED

    The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.

    AppEngine
    APP_ENGINE

    Google App Engine service.

    Compute
    COMPUTE

    Google Compute Engine service.

    CloudRun
    CLOUD_RUN

    Google Cloud Run service.

    CloudFunctions
    CLOUD_FUNCTIONS

    Google Cloud Function service.

    ScanConfigTargetPlatformsItemTargetPlatformUnspecified
    TARGET_PLATFORM_UNSPECIFIED

    The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.

    ScanConfigTargetPlatformsItemAppEngine
    APP_ENGINE

    Google App Engine service.

    ScanConfigTargetPlatformsItemCompute
    COMPUTE

    Google Compute Engine service.

    ScanConfigTargetPlatformsItemCloudRun
    CLOUD_RUN

    Google Cloud Run service.

    ScanConfigTargetPlatformsItemCloudFunctions
    CLOUD_FUNCTIONS

    Google Cloud Function service.

    TargetPlatformUnspecified
    TARGET_PLATFORM_UNSPECIFIED

    The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.

    AppEngine
    APP_ENGINE

    Google App Engine service.

    Compute
    COMPUTE

    Google Compute Engine service.

    CloudRun
    CLOUD_RUN

    Google Cloud Run service.

    CloudFunctions
    CLOUD_FUNCTIONS

    Google Cloud Function service.

    TargetPlatformUnspecified
    TARGET_PLATFORM_UNSPECIFIED

    The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.

    AppEngine
    APP_ENGINE

    Google App Engine service.

    Compute
    COMPUTE

    Google Compute Engine service.

    CloudRun
    CLOUD_RUN

    Google Cloud Run service.

    CloudFunctions
    CLOUD_FUNCTIONS

    Google Cloud Function service.

    TARGET_PLATFORM_UNSPECIFIED
    TARGET_PLATFORM_UNSPECIFIED

    The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.

    APP_ENGINE
    APP_ENGINE

    Google App Engine service.

    COMPUTE
    COMPUTE

    Google Compute Engine service.

    CLOUD_RUN
    CLOUD_RUN

    Google Cloud Run service.

    CLOUD_FUNCTIONS
    CLOUD_FUNCTIONS

    Google Cloud Function service.

    "TARGET_PLATFORM_UNSPECIFIED"
    TARGET_PLATFORM_UNSPECIFIED

    The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.

    "APP_ENGINE"
    APP_ENGINE

    Google App Engine service.

    "COMPUTE"
    COMPUTE

    Google Compute Engine service.

    "CLOUD_RUN"
    CLOUD_RUN

    Google Cloud Run service.

    "CLOUD_FUNCTIONS"
    CLOUD_FUNCTIONS

    Google Cloud Function service.

    ScanConfigUserAgent, ScanConfigUserAgentArgs

    UserAgentUnspecified
    USER_AGENT_UNSPECIFIED

    The user agent is unknown. Service will default to CHROME_LINUX.

    ChromeLinux
    CHROME_LINUX

    Chrome on Linux. This is the service default if unspecified.

    ChromeAndroid
    CHROME_ANDROID

    Chrome on Android.

    SafariIphone
    SAFARI_IPHONE

    Safari on IPhone.

    ScanConfigUserAgentUserAgentUnspecified
    USER_AGENT_UNSPECIFIED

    The user agent is unknown. Service will default to CHROME_LINUX.

    ScanConfigUserAgentChromeLinux
    CHROME_LINUX

    Chrome on Linux. This is the service default if unspecified.

    ScanConfigUserAgentChromeAndroid
    CHROME_ANDROID

    Chrome on Android.

    ScanConfigUserAgentSafariIphone
    SAFARI_IPHONE

    Safari on IPhone.

    UserAgentUnspecified
    USER_AGENT_UNSPECIFIED

    The user agent is unknown. Service will default to CHROME_LINUX.

    ChromeLinux
    CHROME_LINUX

    Chrome on Linux. This is the service default if unspecified.

    ChromeAndroid
    CHROME_ANDROID

    Chrome on Android.

    SafariIphone
    SAFARI_IPHONE

    Safari on IPhone.

    UserAgentUnspecified
    USER_AGENT_UNSPECIFIED

    The user agent is unknown. Service will default to CHROME_LINUX.

    ChromeLinux
    CHROME_LINUX

    Chrome on Linux. This is the service default if unspecified.

    ChromeAndroid
    CHROME_ANDROID

    Chrome on Android.

    SafariIphone
    SAFARI_IPHONE

    Safari on IPhone.

    USER_AGENT_UNSPECIFIED
    USER_AGENT_UNSPECIFIED

    The user agent is unknown. Service will default to CHROME_LINUX.

    CHROME_LINUX
    CHROME_LINUX

    Chrome on Linux. This is the service default if unspecified.

    CHROME_ANDROID
    CHROME_ANDROID

    Chrome on Android.

    SAFARI_IPHONE
    SAFARI_IPHONE

    Safari on IPhone.

    "USER_AGENT_UNSPECIFIED"
    USER_AGENT_UNSPECIFIED

    The user agent is unknown. Service will default to CHROME_LINUX.

    "CHROME_LINUX"
    CHROME_LINUX

    Chrome on Linux. This is the service default if unspecified.

    "CHROME_ANDROID"
    CHROME_ANDROID

    Chrome on Android.

    "SAFARI_IPHONE"
    SAFARI_IPHONE

    Safari 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.

    ExecutionState Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.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.V1Alpha.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.

    EndTime string

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    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.

    endTime String

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    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.

    endTime string

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    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.

    end_time str

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    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.

    endTime String

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    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.

    ScanRunExecutionState, ScanRunExecutionStateArgs

    ExecutionStateUnspecified
    EXECUTION_STATE_UNSPECIFIED

    Represents an invalid state caused by internal server error. This value should never be returned.

    Queued
    QUEUED

    The scan is waiting in the queue.

    Scanning
    SCANNING

    The scan is in progress.

    Finished
    FINISHED

    The scan is either finished or stopped by user.

    ScanRunExecutionStateExecutionStateUnspecified
    EXECUTION_STATE_UNSPECIFIED

    Represents an invalid state caused by internal server error. This value should never be returned.

    ScanRunExecutionStateQueued
    QUEUED

    The scan is waiting in the queue.

    ScanRunExecutionStateScanning
    SCANNING

    The scan is in progress.

    ScanRunExecutionStateFinished
    FINISHED

    The scan is either finished or stopped by user.

    ExecutionStateUnspecified
    EXECUTION_STATE_UNSPECIFIED

    Represents an invalid state caused by internal server error. This value should never be returned.

    Queued
    QUEUED

    The scan is waiting in the queue.

    Scanning
    SCANNING

    The scan is in progress.

    Finished
    FINISHED

    The scan is either finished or stopped by user.

    ExecutionStateUnspecified
    EXECUTION_STATE_UNSPECIFIED

    Represents an invalid state caused by internal server error. This value should never be returned.

    Queued
    QUEUED

    The scan is waiting in the queue.

    Scanning
    SCANNING

    The scan is in progress.

    Finished
    FINISHED

    The scan is either finished or stopped by user.

    EXECUTION_STATE_UNSPECIFIED
    EXECUTION_STATE_UNSPECIFIED

    Represents an invalid state caused by internal server error. This value should never be returned.

    QUEUED
    QUEUED

    The scan is waiting in the queue.

    SCANNING
    SCANNING

    The scan is in progress.

    FINISHED
    FINISHED

    The scan is either finished or stopped by user.

    "EXECUTION_STATE_UNSPECIFIED"
    EXECUTION_STATE_UNSPECIFIED

    Represents an invalid state caused by internal server error. This value should never be returned.

    "QUEUED"
    QUEUED

    The scan is waiting in the queue.

    "SCANNING"
    SCANNING

    The scan is in progress.

    "FINISHED"
    FINISHED

    The scan is either finished or stopped by user.

    ScanRunResponse, ScanRunResponseArgs

    EndTime string

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    ExecutionState string

    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 string

    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.

    EndTime string

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    ExecutionState string

    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 string

    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.

    endTime String

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    executionState String

    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 String

    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.

    endTime string

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    executionState string

    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 string

    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.

    end_time str

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    execution_state str

    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 str

    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.

    endTime String

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

    executionState String

    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 String

    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.

    ScanRunResultState, ScanRunResultStateArgs

    ResultStateUnspecified
    RESULT_STATE_UNSPECIFIED

    Default value. This value is returned when the ScanRun is not yet finished.

    Success
    SUCCESS

    The scan finished without errors.

    Error
    ERROR

    The scan finished with errors.

    Killed
    KILLED

    The scan was terminated by user.

    ScanRunResultStateResultStateUnspecified
    RESULT_STATE_UNSPECIFIED

    Default value. This value is returned when the ScanRun is not yet finished.

    ScanRunResultStateSuccess
    SUCCESS

    The scan finished without errors.

    ScanRunResultStateError
    ERROR

    The scan finished with errors.

    ScanRunResultStateKilled
    KILLED

    The scan was terminated by user.

    ResultStateUnspecified
    RESULT_STATE_UNSPECIFIED

    Default value. This value is returned when the ScanRun is not yet finished.

    Success
    SUCCESS

    The scan finished without errors.

    Error
    ERROR

    The scan finished with errors.

    Killed
    KILLED

    The scan was terminated by user.

    ResultStateUnspecified
    RESULT_STATE_UNSPECIFIED

    Default value. This value is returned when the ScanRun is not yet finished.

    Success
    SUCCESS

    The scan finished without errors.

    Error
    ERROR

    The scan finished with errors.

    Killed
    KILLED

    The scan was terminated by user.

    RESULT_STATE_UNSPECIFIED
    RESULT_STATE_UNSPECIFIED

    Default value. This value is returned when the ScanRun is not yet finished.

    SUCCESS
    SUCCESS

    The scan finished without errors.

    ERROR
    ERROR

    The scan finished with errors.

    KILLED
    KILLED

    The scan was terminated by user.

    "RESULT_STATE_UNSPECIFIED"
    RESULT_STATE_UNSPECIFIED

    Default value. This value is returned when the ScanRun is not yet finished.

    "SUCCESS"
    SUCCESS

    The scan finished without errors.

    "ERROR"
    ERROR

    The scan finished with errors.

    "KILLED"
    KILLED

    The scan was terminated by user.

    Schedule, ScheduleArgs

    IntervalDurationDays 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 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 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 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 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 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 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 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 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 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 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 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.

    Package Details

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

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

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi
    pulumi/pulumi-google-native