com.pulumi.gcp.compute.kotlin.SecurityScanConfig.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.compute.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.compute.kotlin.outputs.SecurityScanConfigAuthentication
import com.pulumi.gcp.compute.kotlin.outputs.SecurityScanConfigSchedule
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.gcp.compute.kotlin.outputs.SecurityScanConfigAuthentication.Companion.toKotlin as securityScanConfigAuthenticationToKotlin
import com.pulumi.gcp.compute.kotlin.outputs.SecurityScanConfigSchedule.Companion.toKotlin as securityScanConfigScheduleToKotlin
/**
* Builder for [SecurityScanConfig].
*/
@PulumiTagMarker
public class SecurityScanConfigResourceBuilder internal constructor() {
public var name: String? = null
public var args: SecurityScanConfigArgs = SecurityScanConfigArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend SecurityScanConfigArgsBuilder.() -> Unit) {
val builder = SecurityScanConfigArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): SecurityScanConfig {
val builtJavaResource = com.pulumi.gcp.compute.SecurityScanConfig(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return SecurityScanConfig(builtJavaResource)
}
}
/**
* A ScanConfig resource contains the configurations to launch a scan.
* To get more information about ScanConfig, see:
* * [API documentation](https://cloud.google.com/security-scanner/docs/reference/rest/v1beta/projects.scanConfigs)
* * How-to Guides
* * [Using Cloud Security Scanner](https://cloud.google.com/security-scanner/docs/scanning)
* ## Example Usage
* ### Scan Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const scannerStaticIp = new gcp.compute.Address("scanner_static_ip", {name: "scan-basic-static-ip"});
* const scan_config = new gcp.compute.SecurityScanConfig("scan-config", {
* displayName: "scan-config",
* startingUrls: [pulumi.interpolate`http://${scannerStaticIp.address}`],
* targetPlatforms: ["COMPUTE"],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* scanner_static_ip = gcp.compute.Address("scanner_static_ip", name="scan-basic-static-ip")
* scan_config = gcp.compute.SecurityScanConfig("scan-config",
* display_name="scan-config",
* starting_urls=[scanner_static_ip.address.apply(lambda address: f"http://{address}")],
* target_platforms=["COMPUTE"])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var scannerStaticIp = new Gcp.Compute.Address("scanner_static_ip", new()
* {
* Name = "scan-basic-static-ip",
* });
* var scan_config = new Gcp.Compute.SecurityScanConfig("scan-config", new()
* {
* DisplayName = "scan-config",
* StartingUrls = new[]
* {
* scannerStaticIp.IPAddress.Apply(address => $"http://{address}"),
* },
* TargetPlatforms = new[]
* {
* "COMPUTE",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* scannerStaticIp, err := compute.NewAddress(ctx, "scanner_static_ip", &compute.AddressArgs{
* Name: pulumi.String("scan-basic-static-ip"),
* })
* if err != nil {
* return err
* }
* _, err = compute.NewSecurityScanConfig(ctx, "scan-config", &compute.SecurityScanConfigArgs{
* DisplayName: pulumi.String("scan-config"),
* StartingUrls: pulumi.StringArray{
* scannerStaticIp.Address.ApplyT(func(address string) (string, error) {
* return fmt.Sprintf("http://%v", address), nil
* }).(pulumi.StringOutput),
* },
* TargetPlatforms: pulumi.StringArray{
* pulumi.String("COMPUTE"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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 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.builder()
* .name("scan-basic-static-ip")
* .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());
* }
* }
* ```
* ```yaml
* resources:
* scannerStaticIp:
* type: gcp:compute:Address
* name: scanner_static_ip
* properties:
* name: scan-basic-static-ip
* scan-config:
* type: gcp:compute:SecurityScanConfig
* properties:
* displayName: scan-config
* startingUrls:
* - http://${scannerStaticIp.address}
* targetPlatforms:
* - COMPUTE
* ```
*
* ## Import
* ScanConfig can be imported using any of these accepted formats:
* * `{{project}}/{{name}}`
* * `{{project}} {{name}}`
* * `{{name}}`
* When using the `pulumi import` command, ScanConfig can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:compute/securityScanConfig:SecurityScanConfig default {{project}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:compute/securityScanConfig:SecurityScanConfig default "{{project}} {{name}}"
* ```
* ```sh
* $ pulumi import gcp:compute/securityScanConfig:SecurityScanConfig default {{name}}
* ```
*/
public class SecurityScanConfig internal constructor(
override val javaResource: com.pulumi.gcp.compute.SecurityScanConfig,
) : KotlinCustomResource(javaResource, SecurityScanConfigMapper) {
/**
* The authentication configuration.
* If specified, service will use the authentication configuration during scanning.
* Structure is documented below.
*/
public val authentication: Output?
get() = javaResource.authentication().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> securityScanConfigAuthenticationToKotlin(args0) })
}).orElse(null)
})
/**
* The blacklist URL patterns as described in
* https://cloud.google.com/security-scanner/docs/excluded-urls
*/
public val blacklistPatterns: Output>?
get() = javaResource.blacklistPatterns().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* The user provider display name of the ScanConfig.
*/
public val displayName: Output
get() = javaResource.displayName().applyValue({ args0 -> args0 })
/**
* Controls export of scan configurations and results to Cloud Security Command Center.
* Default value is `ENABLED`.
* Possible values are: `ENABLED`, `DISABLED`.
*/
public val exportToSecurityCommandCenter: Output?
get() = javaResource.exportToSecurityCommandCenter().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively.
* Defaults to 15.
*/
public val maxQps: Output?
get() = javaResource.maxQps().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A server defined name for this index. Format:
* `projects/{{project}}/scanConfigs/{{server_generated_id}}`
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The schedule of the ScanConfig
* Structure is documented below.
*/
public val schedule: Output?
get() = javaResource.schedule().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
securityScanConfigScheduleToKotlin(args0)
})
}).orElse(null)
})
/**
* The starting URLs from which the scanner finds site pages.
* - - -
*/
public val startingUrls: Output>
get() = javaResource.startingUrls().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* 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`.
*/
public val targetPlatforms: Output>?
get() = javaResource.targetPlatforms().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* 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`.
*/
public val userAgent: Output?
get() = javaResource.userAgent().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object SecurityScanConfigMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.compute.SecurityScanConfig::class == javaResource::class
override fun map(javaResource: Resource): SecurityScanConfig = SecurityScanConfig(
javaResource as
com.pulumi.gcp.compute.SecurityScanConfig,
)
}
/**
* @see [SecurityScanConfig].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [SecurityScanConfig].
*/
public suspend fun securityScanConfig(
name: String,
block: suspend SecurityScanConfigResourceBuilder.() -> Unit,
): SecurityScanConfig {
val builder = SecurityScanConfigResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [SecurityScanConfig].
* @param name The _unique_ name of the resulting resource.
*/
public fun securityScanConfig(name: String): SecurityScanConfig {
val builder = SecurityScanConfigResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy