pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/SecurityScanConfig

SecurityScanConfig

class SecurityScanConfig : KotlinCustomResource

A ScanConfig resource contains the configurations to launch a scan. To get more information about ScanConfig, see:

API documentation
How-to Guides

Using Cloud Security Scanner

Warning: All arguments including authentication.google_account.password and authentication.custom_account.password will be stored in the raw state as plain-text.

Example Usage

Scan Config Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.AddressArgs;
import com.pulumi.gcp.compute.SecurityScanConfig;
import com.pulumi.gcp.compute.SecurityScanConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var scannerStaticIp = new Address("scannerStaticIp", AddressArgs.Empty, CustomResourceOptions.builder()
            .provider(google_beta)
            .build());
        var scan_config = new SecurityScanConfig("scan-config", SecurityScanConfigArgs.builder()
            .displayName("scan-config")
            .startingUrls(scannerStaticIp.address().applyValue(address -> String.format("http://%s", address)))
            .targetPlatforms("COMPUTE")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
    }
}

Import

ScanConfig can be imported using any of these accepted formats

$ pulumi import gcp:compute/securityScanConfig:SecurityScanConfig default projects/{{project}}/scanConfigs/{{name}}

$ pulumi import gcp:compute/securityScanConfig:SecurityScanConfig default {{project}}/{{name}}

$ pulumi import gcp:compute/securityScanConfig:SecurityScanConfig default {{name}}

Properties

authentication

val authentication: Output<SecurityScanConfigAuthentication>?

The authentication configuration. If specified, service will use the authentication configuration during scanning. Structure is documented below.

blacklistPatterns

val blacklistPatterns: Output<List<String>>?

The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls

displayName

val displayName: Output<String>

The user provider display name of the ScanConfig.

exportToSecurityCommandCenter

val exportToSecurityCommandCenter: Output<String>?

Controls export of scan configurations and results to Cloud Security Command Center. Default value is ENABLED. Possible values are: ENABLED, DISABLED.

val id: Output<String>

maxQps

val maxQps: Output<Int>?

The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. Defaults to 15.

name

val name: Output<String>

A server defined name for this index. Format: projects/{{project}}/scanConfigs/{{server_generated_id}}

project

val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

schedule

val schedule: Output<SecurityScanConfigSchedule>?

The schedule of the ScanConfig Structure is documented below.

startingUrls

val startingUrls: Output<List<String>>

The starting URLs from which the scanner finds site pages.

targetPlatforms

val targetPlatforms: Output<List<String>>?

Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. Each value may be one of: APP_ENGINE, COMPUTE.

urn

val urn: Output<String>

userAgent

val userAgent: Output<String>?

Type of the user agents used for scanning Default value is CHROME_LINUX. Possible values are: USER_AGENT_UNSPECIFIED, CHROME_LINUX, CHROME_ANDROID, SAFARI_IPHONE.