Google Native

Pulumi Official
Package maintained by Pulumi
v0.19.1 published on Tuesday, May 24, 2022 by Pulumi

getScanConfig

Gets a ScanConfig.

Using getScanConfig

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getScanConfig(args: GetScanConfigArgs, opts?: InvokeOptions): Promise<GetScanConfigResult>
function getScanConfigOutput(args: GetScanConfigOutputArgs, opts?: InvokeOptions): Output<GetScanConfigResult>
def get_scan_config(project: Optional[str] = None,
                    scan_config_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetScanConfigResult
def get_scan_config_output(project: Optional[pulumi.Input[str]] = None,
                    scan_config_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetScanConfigResult]
func LookupScanConfig(ctx *Context, args *LookupScanConfigArgs, opts ...InvokeOption) (*LookupScanConfigResult, error)
func LookupScanConfigOutput(ctx *Context, args *LookupScanConfigOutputArgs, opts ...InvokeOption) LookupScanConfigResultOutput

> Note: This function is named LookupScanConfig in the Go SDK.

public static class GetScanConfig 
{
    public static Task<GetScanConfigResult> InvokeAsync(GetScanConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetScanConfigResult> Invoke(GetScanConfigInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetScanConfigResult> getScanConfig(GetScanConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:websecurityscanner/v1:getScanConfig
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ScanConfigId string
Project string
ScanConfigId string
Project string
scanConfigId String
project String
scanConfigId string
project string
scanConfigId String
project String

getScanConfig Result

The following output properties are available:

Authentication Pulumi.GoogleNative.WebSecurityScanner.V1.Outputs.AuthenticationResponse

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

DisplayName string

The user provided display name of the ScanConfig.

ExportToSecurityCommandCenter string

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.

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.

RiskLevel string

The risk level selected for the scan

Schedule Pulumi.GoogleNative.WebSecurityScanner.V1.Outputs.ScheduleResponse

The schedule of the ScanConfig.

StartingUrls List<string>

The starting URLs from which the scanner finds site pages.

StaticIpScan bool

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

UserAgent string

The user agent used during scanning.

Authentication AuthenticationResponse

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

DisplayName string

The user provided display name of the ScanConfig.

ExportToSecurityCommandCenter string

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.

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.

RiskLevel string

The risk level selected for the scan

Schedule ScheduleResponse

The schedule of the ScanConfig.

StartingUrls []string

The starting URLs from which the scanner finds site pages.

StaticIpScan bool

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

UserAgent string

The user agent used during scanning.

authentication AuthenticationResponse

The authentication configuration. If specified, service will use the authentication configuration during scanning.

blacklistPatterns List

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

displayName String

The user provided display name of the ScanConfig.

exportToSecurityCommandCenter String

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.

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.

riskLevel String

The risk level selected for the scan

schedule ScheduleResponse

The schedule of the ScanConfig.

startingUrls List

The starting URLs from which the scanner finds site pages.

staticIpScan Boolean

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

userAgent String

The user agent used during scanning.

authentication AuthenticationResponse

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

displayName string

The user provided display name of the ScanConfig.

exportToSecurityCommandCenter string

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.

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.

riskLevel string

The risk level selected for the scan

schedule ScheduleResponse

The schedule of the ScanConfig.

startingUrls string[]

The starting URLs from which the scanner finds site pages.

staticIpScan boolean

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

userAgent string

The user agent used during scanning.

authentication AuthenticationResponse

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

display_name str

The user provided display name of the ScanConfig.

export_to_security_command_center str

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.

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.

risk_level str

The risk level selected for the scan

schedule ScheduleResponse

The schedule of the ScanConfig.

starting_urls Sequence[str]

The starting URLs from which the scanner finds site pages.

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.

user_agent str

The user agent used during scanning.

authentication Property Map

The authentication configuration. If specified, service will use the authentication configuration during scanning.

blacklistPatterns List

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

displayName String

The user provided display name of the ScanConfig.

exportToSecurityCommandCenter String

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.

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.

riskLevel String

The risk level selected for the scan

schedule Property Map

The schedule of the ScanConfig.

startingUrls List

The starting URLs from which the scanner finds site pages.

staticIpScan Boolean

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

userAgent String

The user agent used during scanning.

Supporting Types

AuthenticationResponse

CustomAccount CustomAccountResponse

Authentication using a custom account.

GoogleAccount GoogleAccountResponse

Authentication using a Google account.

IapCredential IapCredentialResponse

Authentication using Identity-Aware-Proxy (IAP).

customAccount CustomAccountResponse

Authentication using a custom account.

googleAccount GoogleAccountResponse

Authentication using a Google account.

iapCredential IapCredentialResponse

Authentication using Identity-Aware-Proxy (IAP).

customAccount CustomAccountResponse

Authentication using a custom account.

googleAccount GoogleAccountResponse

Authentication using a Google account.

iapCredential IapCredentialResponse

Authentication using Identity-Aware-Proxy (IAP).

custom_account CustomAccountResponse

Authentication using a custom account.

google_account GoogleAccountResponse

Authentication using a Google account.

iap_credential IapCredentialResponse

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

CustomAccountResponse

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.

GoogleAccountResponse

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.

IapCredentialResponse

IapTestServiceAccountInfo Pulumi.GoogleNative.WebSecurityScanner.V1.Inputs.IapTestServiceAccountInfoResponse

Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

IapTestServiceAccountInfo IapTestServiceAccountInfoResponse

Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

iapTestServiceAccountInfo IapTestServiceAccountInfoResponse

Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

iapTestServiceAccountInfo IapTestServiceAccountInfoResponse

Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

iap_test_service_account_info IapTestServiceAccountInfoResponse

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.

IapTestServiceAccountInfoResponse

TargetAudienceClientId string

Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).

TargetAudienceClientId string

Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).

targetAudienceClientId String

Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).

targetAudienceClientId string

Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).

target_audience_client_id str

Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).

targetAudienceClientId String

Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP).

ScheduleResponse

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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0