Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getHostScanRecipe

This data source provides details about a specific Host Scan Recipe resource in Oracle Cloud Infrastructure Vulnerability Scanning service.

Retrieves a HostScanRecipe identified by the recipe ID. A recipe determines the types of security issues that you want scanned, and how often to scan.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testHostScanRecipe = Oci.VulnerabilityScanning.GetHostScanRecipe.Invoke(new()
    {
        HostScanRecipeId = oci_vulnerability_scanning_host_scan_recipe.Test_host_scan_recipe.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/VulnerabilityScanning"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := VulnerabilityScanning.GetHostScanRecipe(ctx, &vulnerabilityscanning.GetHostScanRecipeArgs{
			HostScanRecipeId: oci_vulnerability_scanning_host_scan_recipe.Test_host_scan_recipe.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.VulnerabilityScanning.VulnerabilityScanningFunctions;
import com.pulumi.oci.VulnerabilityScanning.inputs.GetHostScanRecipeArgs;
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) {
        final var testHostScanRecipe = VulnerabilityScanningFunctions.getHostScanRecipe(GetHostScanRecipeArgs.builder()
            .hostScanRecipeId(oci_vulnerability_scanning_host_scan_recipe.test_host_scan_recipe().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_host_scan_recipe = oci.VulnerabilityScanning.get_host_scan_recipe(host_scan_recipe_id=oci_vulnerability_scanning_host_scan_recipe["test_host_scan_recipe"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testHostScanRecipe = oci.VulnerabilityScanning.getHostScanRecipe({
    hostScanRecipeId: oci_vulnerability_scanning_host_scan_recipe.test_host_scan_recipe.id,
});
variables:
  testHostScanRecipe:
    Fn::Invoke:
      Function: oci:VulnerabilityScanning:getHostScanRecipe
      Arguments:
        hostScanRecipeId: ${oci_vulnerability_scanning_host_scan_recipe.test_host_scan_recipe.id}

Using getHostScanRecipe

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 getHostScanRecipe(args: GetHostScanRecipeArgs, opts?: InvokeOptions): Promise<GetHostScanRecipeResult>
function getHostScanRecipeOutput(args: GetHostScanRecipeOutputArgs, opts?: InvokeOptions): Output<GetHostScanRecipeResult>
def get_host_scan_recipe(host_scan_recipe_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetHostScanRecipeResult
def get_host_scan_recipe_output(host_scan_recipe_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetHostScanRecipeResult]
func GetHostScanRecipe(ctx *Context, args *GetHostScanRecipeArgs, opts ...InvokeOption) (*GetHostScanRecipeResult, error)
func GetHostScanRecipeOutput(ctx *Context, args *GetHostScanRecipeOutputArgs, opts ...InvokeOption) GetHostScanRecipeResultOutput

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

public static class GetHostScanRecipe 
{
    public static Task<GetHostScanRecipeResult> InvokeAsync(GetHostScanRecipeArgs args, InvokeOptions? opts = null)
    public static Output<GetHostScanRecipeResult> Invoke(GetHostScanRecipeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetHostScanRecipeResult> getHostScanRecipe(GetHostScanRecipeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:VulnerabilityScanning/getHostScanRecipe:getHostScanRecipe
  arguments:
    # arguments dictionary

The following arguments are supported:

HostScanRecipeId string

unique HostScanRecipe identifier

HostScanRecipeId string

unique HostScanRecipe identifier

hostScanRecipeId String

unique HostScanRecipe identifier

hostScanRecipeId string

unique HostScanRecipe identifier

host_scan_recipe_id str

unique HostScanRecipe identifier

hostScanRecipeId String

unique HostScanRecipe identifier

getHostScanRecipe Result

The following output properties are available:

AgentSettings List<GetHostScanRecipeAgentSetting>

Agent scan settings for a host scan

ApplicationSettings List<GetHostScanRecipeApplicationSetting>

Agent scan settings for an application scan (as a part of a host scan)

CompartmentId string

Compartment ID of the scan recipe

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

Recipe identifier, which can be renamed

FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

HostScanRecipeId string
Id string

Unique identifier of the config that is immutable on creation

PortSettings List<GetHostScanRecipePortSetting>

Port scan settings for a host scan

Schedules List<GetHostScanRecipeSchedule>

A scanning schedule

State string

The current state of the config.

SystemTags Dictionary<string, object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

Date and time the recipe was created, format as described in RFC 3339

TimeUpdated string

Date and time the recipe was last updated, format as described in RFC 3339

AgentSettings []GetHostScanRecipeAgentSetting

Agent scan settings for a host scan

ApplicationSettings []GetHostScanRecipeApplicationSetting

Agent scan settings for an application scan (as a part of a host scan)

CompartmentId string

Compartment ID of the scan recipe

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

Recipe identifier, which can be renamed

FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

HostScanRecipeId string
Id string

Unique identifier of the config that is immutable on creation

PortSettings []GetHostScanRecipePortSetting

Port scan settings for a host scan

Schedules []GetHostScanRecipeSchedule

A scanning schedule

State string

The current state of the config.

SystemTags map[string]interface{}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

TimeCreated string

Date and time the recipe was created, format as described in RFC 3339

TimeUpdated string

Date and time the recipe was last updated, format as described in RFC 3339

agentSettings List<GetHostScanRecipeAgentSetting>

Agent scan settings for a host scan

applicationSettings List<GetHostScanRecipeApplicationSetting>

Agent scan settings for an application scan (as a part of a host scan)

compartmentId String

Compartment ID of the scan recipe

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

Recipe identifier, which can be renamed

freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

hostScanRecipeId String
id String

Unique identifier of the config that is immutable on creation

portSettings List<GetHostScanRecipePortSetting>

Port scan settings for a host scan

schedules List<GetHostScanRecipeSchedule>

A scanning schedule

state String

The current state of the config.

systemTags Map<String,Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

Date and time the recipe was created, format as described in RFC 3339

timeUpdated String

Date and time the recipe was last updated, format as described in RFC 3339

agentSettings GetHostScanRecipeAgentSetting[]

Agent scan settings for a host scan

applicationSettings GetHostScanRecipeApplicationSetting[]

Agent scan settings for an application scan (as a part of a host scan)

compartmentId string

Compartment ID of the scan recipe

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

Recipe identifier, which can be renamed

freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

hostScanRecipeId string
id string

Unique identifier of the config that is immutable on creation

portSettings GetHostScanRecipePortSetting[]

Port scan settings for a host scan

schedules GetHostScanRecipeSchedule[]

A scanning schedule

state string

The current state of the config.

systemTags {[key: string]: any}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated string

Date and time the recipe was created, format as described in RFC 3339

timeUpdated string

Date and time the recipe was last updated, format as described in RFC 3339

agent_settings GetHostScanRecipeAgentSetting]

Agent scan settings for a host scan

application_settings GetHostScanRecipeApplicationSetting]

Agent scan settings for an application scan (as a part of a host scan)

compartment_id str

Compartment ID of the scan recipe

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

Recipe identifier, which can be renamed

freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host_scan_recipe_id str
id str

Unique identifier of the config that is immutable on creation

port_settings GetHostScanRecipePortSetting]

Port scan settings for a host scan

schedules GetHostScanRecipeSchedule]

A scanning schedule

state str

The current state of the config.

system_tags Mapping[str, Any]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

time_created str

Date and time the recipe was created, format as described in RFC 3339

time_updated str

Date and time the recipe was last updated, format as described in RFC 3339

agentSettings List<Property Map>

Agent scan settings for a host scan

applicationSettings List<Property Map>

Agent scan settings for an application scan (as a part of a host scan)

compartmentId String

Compartment ID of the scan recipe

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

Recipe identifier, which can be renamed

freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

hostScanRecipeId String
id String

Unique identifier of the config that is immutable on creation

portSettings List<Property Map>

Port scan settings for a host scan

schedules List<Property Map>

A scanning schedule

state String

The current state of the config.

systemTags Map<Any>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

timeCreated String

Date and time the recipe was created, format as described in RFC 3339

timeUpdated String

Date and time the recipe was last updated, format as described in RFC 3339

Supporting Types

GetHostScanRecipeAgentSetting

AgentConfigurations List<GetHostScanRecipeAgentSettingAgentConfiguration>

Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.

ScanLevel string

The scan level

AgentConfigurations []GetHostScanRecipeAgentSettingAgentConfiguration

Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.

ScanLevel string

The scan level

agentConfigurations List<GetHostScanRecipeAgentSettingAgentConfiguration>

Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.

scanLevel String

The scan level

agentConfigurations GetHostScanRecipeAgentSettingAgentConfiguration[]

Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.

scanLevel string

The scan level

agent_configurations GetHostScanRecipeAgentSettingAgentConfiguration]

Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.

scan_level str

The scan level

agentConfigurations List<Property Map>

Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.

scanLevel String

The scan level

GetHostScanRecipeAgentSettingAgentConfiguration

CisBenchmarkSettings List<GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting>

CIS (Center for Internet Security) Benchmark scan settings for a host scan

EndpointProtectionSettings List<GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting>

Endpoint Protection scan settings for a host scan

Vendor string

Vendor to use for the host scan agent.

CisBenchmarkSettings []GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting

CIS (Center for Internet Security) Benchmark scan settings for a host scan

EndpointProtectionSettings []GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting

Endpoint Protection scan settings for a host scan

Vendor string

Vendor to use for the host scan agent.

cisBenchmarkSettings List<GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting>

CIS (Center for Internet Security) Benchmark scan settings for a host scan

endpointProtectionSettings List<GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting>

Endpoint Protection scan settings for a host scan

vendor String

Vendor to use for the host scan agent.

cisBenchmarkSettings GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting[]

CIS (Center for Internet Security) Benchmark scan settings for a host scan

endpointProtectionSettings GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting[]

Endpoint Protection scan settings for a host scan

vendor string

Vendor to use for the host scan agent.

cis_benchmark_settings GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting]

CIS (Center for Internet Security) Benchmark scan settings for a host scan

endpoint_protection_settings GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting]

Endpoint Protection scan settings for a host scan

vendor str

Vendor to use for the host scan agent.

cisBenchmarkSettings List<Property Map>

CIS (Center for Internet Security) Benchmark scan settings for a host scan

endpointProtectionSettings List<Property Map>

Endpoint Protection scan settings for a host scan

vendor String

Vendor to use for the host scan agent.

GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting

ScanLevel string

The scan level

ScanLevel string

The scan level

scanLevel String

The scan level

scanLevel string

The scan level

scan_level str

The scan level

scanLevel String

The scan level

GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting

ScanLevel string

The scan level

ScanLevel string

The scan level

scanLevel String

The scan level

scanLevel string

The scan level

scan_level str

The scan level

scanLevel String

The scan level

GetHostScanRecipeApplicationSetting

ApplicationScanRecurrence string

Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)

FoldersToScans List<GetHostScanRecipeApplicationSettingFoldersToScan>

List of folders selected for scanning

IsEnabled bool

Enable or disable application scan

ApplicationScanRecurrence string

Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)

FoldersToScans []GetHostScanRecipeApplicationSettingFoldersToScan

List of folders selected for scanning

IsEnabled bool

Enable or disable application scan

applicationScanRecurrence String

Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)

foldersToScans List<GetHostScanRecipeApplicationSettingFoldersToScan>

List of folders selected for scanning

isEnabled Boolean

Enable or disable application scan

applicationScanRecurrence string

Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)

foldersToScans GetHostScanRecipeApplicationSettingFoldersToScan[]

List of folders selected for scanning

isEnabled boolean

Enable or disable application scan

application_scan_recurrence str

Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)

folders_to_scans GetHostScanRecipeApplicationSettingFoldersToScan]

List of folders selected for scanning

is_enabled bool

Enable or disable application scan

applicationScanRecurrence String

Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)

foldersToScans List<Property Map>

List of folders selected for scanning

isEnabled Boolean

Enable or disable application scan

GetHostScanRecipeApplicationSettingFoldersToScan

Folder string

Folder to be scanned in the corresponding operating system

Operatingsystem string

Operating system type

Folder string

Folder to be scanned in the corresponding operating system

Operatingsystem string

Operating system type

folder String

Folder to be scanned in the corresponding operating system

operatingsystem String

Operating system type

folder string

Folder to be scanned in the corresponding operating system

operatingsystem string

Operating system type

folder str

Folder to be scanned in the corresponding operating system

operatingsystem str

Operating system type

folder String

Folder to be scanned in the corresponding operating system

operatingsystem String

Operating system type

GetHostScanRecipePortSetting

ScanLevel string

The scan level

ScanLevel string

The scan level

scanLevel String

The scan level

scanLevel string

The scan level

scan_level str

The scan level

scanLevel String

The scan level

GetHostScanRecipeSchedule

DayOfWeek string

Day of week the scheduled scan occurs (not applicable for DAILY type)

Type string

How often the scan occurs

DayOfWeek string

Day of week the scheduled scan occurs (not applicable for DAILY type)

Type string

How often the scan occurs

dayOfWeek String

Day of week the scheduled scan occurs (not applicable for DAILY type)

type String

How often the scan occurs

dayOfWeek string

Day of week the scheduled scan occurs (not applicable for DAILY type)

type string

How often the scan occurs

day_of_week str

Day of week the scheduled scan occurs (not applicable for DAILY type)

type str

How often the scan occurs

dayOfWeek String

Day of week the scheduled scan occurs (not applicable for DAILY type)

type String

How often the scan occurs

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.