Class SecurityScanConfig

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.Read more about secrets in state

Example Usage - Scan Config Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var scannerStaticIp = new Gcp.Compute.Address("scannerStaticIp", new Gcp.Compute.AddressArgs
    {
    });
    var scan_config = new Gcp.Compute.SecurityScanConfig("scan-config", new Gcp.Compute.SecurityScanConfigArgs
    {
        DisplayName = "scan-config",
        StartingUrls = 
        {
            scannerStaticIp.IPAddress.Apply(address => $"http://{address}"),
        },
        TargetPlatforms = 
        {
            "COMPUTE",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

SecurityScanConfig

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class SecurityScanConfig : CustomResource

Constructors

SecurityScanConfig(String, SecurityScanConfigArgs, CustomResourceOptions)

Create a SecurityScanConfig resource with the given unique name, arguments, and options.

Declaration

public SecurityScanConfig(string name, SecurityScanConfigArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SecurityScanConfigArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Authentication

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

Declaration

public Output<SecurityScanConfigAuthentication> Authentication { get; }

Property Value

Type	Description
Output<SecurityScanConfigAuthentication>

BlacklistPatterns

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

Declaration

public Output<ImmutableArray<string>> BlacklistPatterns { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

DisplayName

The user provider display name of the ScanConfig.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

ExportToSecurityCommandCenter

Controls export of scan configurations and results to Cloud Security Command Center.

Declaration

public Output<string> ExportToSecurityCommandCenter { get; }

Property Value

Type	Description
Output<System.String>

MaxQps

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

Declaration

public Output<int?> MaxQps { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Project

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

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Schedule

The schedule of the ScanConfig Structure is documented below.

Declaration

public Output<SecurityScanConfigSchedule> Schedule { get; }

Property Value

Type	Description
Output<SecurityScanConfigSchedule>

StartingUrls

The starting URLs from which the scanner finds site pages.

Declaration

public Output<ImmutableArray<string>> StartingUrls { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

TargetPlatforms

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

Declaration

public Output<ImmutableArray<string>> TargetPlatforms { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

UserAgent

Type of the user agents used for scanning

Declaration

public Output<string> UserAgent { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, SecurityScanConfigState, CustomResourceOptions)

Get an existing SecurityScanConfig resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static SecurityScanConfig Get(string name, Input<string> id, SecurityScanConfigState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SecurityScanConfigState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
SecurityScanConfig