Rancher 2 v3.9.0, Jan 18 23

rancher2.getClusterScan

Use this data source to retrieve information about a Rancher v2 Cluster CIS Scan resource.

Using getClusterScan

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 getClusterScan(args: GetClusterScanArgs, opts?: InvokeOptions): Promise<GetClusterScanResult>
function getClusterScanOutput(args: GetClusterScanOutputArgs, opts?: InvokeOptions): Output<GetClusterScanResult>

def get_cluster_scan(cluster_id: Optional[str] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetClusterScanResult
def get_cluster_scan_output(cluster_id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetClusterScanResult]

func GetClusterScan(ctx *Context, args *GetClusterScanArgs, opts ...InvokeOption) (*GetClusterScanResult, error)
func GetClusterScanOutput(ctx *Context, args *GetClusterScanOutputArgs, opts ...InvokeOption) GetClusterScanResultOutput

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

public static class GetClusterScan 
{
    public static Task<GetClusterScanResult> InvokeAsync(GetClusterScanArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterScanResult> Invoke(GetClusterScanInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterScanResult> getClusterScan(GetClusterScanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: rancher2:index/getClusterScan:getClusterScan
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string: Cluster ID for CIS Scan (string)
Name string: Name of the cluster Scan (string)

ClusterId string: Cluster ID for CIS Scan (string)
Name string: Name of the cluster Scan (string)

clusterId String: Cluster ID for CIS Scan (string)
name String: Name of the cluster Scan (string)

clusterId string: Cluster ID for CIS Scan (string)
name string: Name of the cluster Scan (string)

cluster_id str: Cluster ID for CIS Scan (string)
name str: Name of the cluster Scan (string)

clusterId String: Cluster ID for CIS Scan (string)
name String: Name of the cluster Scan (string)

getClusterScan Result

The following output properties are available:

Annotations Dictionary<string, object>: (Computed) Annotations of the resource (map)
ClusterId string
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, object>: (Computed) Labels of the resource (map)
Name string
RunType string: (Computed) Cluster Scan run type (string)
ScanConfig GetClusterScanScanConfig: (Computed) Cluster Scan config (bool)
ScanType string: (Computed) Cluster Scan type (string)
Status string: (Computed) Cluster Scan status (string)

Annotations map[string]interface{}: (Computed) Annotations of the resource (map)
ClusterId string
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]interface{}: (Computed) Labels of the resource (map)
Name string
RunType string: (Computed) Cluster Scan run type (string)
ScanConfig GetClusterScanScanConfig: (Computed) Cluster Scan config (bool)
ScanType string: (Computed) Cluster Scan type (string)
Status string: (Computed) Cluster Scan status (string)

annotations Map<String,Object>: (Computed) Annotations of the resource (map)
clusterId String
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,Object>: (Computed) Labels of the resource (map)
name String
runType String: (Computed) Cluster Scan run type (string)
scanConfig GetClusterScanScanConfig: (Computed) Cluster Scan config (bool)
scanType String: (Computed) Cluster Scan type (string)
status String: (Computed) Cluster Scan status (string)

annotations {[key: string]: any}: (Computed) Annotations of the resource (map)
clusterId string
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: any}: (Computed) Labels of the resource (map)
name string
runType string: (Computed) Cluster Scan run type (string)
scanConfig GetClusterScanScanConfig: (Computed) Cluster Scan config (bool)
scanType string: (Computed) Cluster Scan type (string)
status string: (Computed) Cluster Scan status (string)

annotations Mapping[str, Any]: (Computed) Annotations of the resource (map)
cluster_id str
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, Any]: (Computed) Labels of the resource (map)
name str
run_type str: (Computed) Cluster Scan run type (string)
scan_config GetClusterScanScanConfig: (Computed) Cluster Scan config (bool)
scan_type str: (Computed) Cluster Scan type (string)
status str: (Computed) Cluster Scan status (string)

annotations Map<Any>: (Computed) Annotations of the resource (map)
clusterId String
id String: The provider-assigned unique ID for this managed resource.
labels Map<Any>: (Computed) Labels of the resource (map)
name String
runType String: (Computed) Cluster Scan run type (string)
scanConfig Property Map: (Computed) Cluster Scan config (bool)
scanType String: (Computed) Cluster Scan type (string)
status String: (Computed) Cluster Scan status (string)

Supporting Types

GetClusterScanScanConfig

CisScanConfig GetClusterScanScanConfigCisScanConfig: Cluster Cis Scan config (List maxitems:1)

CisScanConfig GetClusterScanScanConfigCisScanConfig: Cluster Cis Scan config (List maxitems:1)

cisScanConfig GetClusterScanScanConfigCisScanConfig: Cluster Cis Scan config (List maxitems:1)

cisScanConfig GetClusterScanScanConfigCisScanConfig: Cluster Cis Scan config (List maxitems:1)

cis_scan_config GetClusterScanScanConfigCisScanConfig: Cluster Cis Scan config (List maxitems:1)

cisScanConfig Property Map: Cluster Cis Scan config (List maxitems:1)

GetClusterScanScanConfigCisScanConfig

DebugMaster bool: Debug master. Default: false (bool)
DebugWorker bool: Debug worker. Default: false (bool)
OverrideBenchmarkVersion string: Override benchmark version (string)
OverrideSkips List<string>: Override skip (string)
Profile string: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

DebugMaster bool: Debug master. Default: false (bool)
DebugWorker bool: Debug worker. Default: false (bool)
OverrideBenchmarkVersion string: Override benchmark version (string)
OverrideSkips []string: Override skip (string)
Profile string: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

debugMaster Boolean: Debug master. Default: false (bool)
debugWorker Boolean: Debug worker. Default: false (bool)
overrideBenchmarkVersion String: Override benchmark version (string)
overrideSkips List<String>: Override skip (string)
profile String: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

debugMaster boolean: Debug master. Default: false (bool)
debugWorker boolean: Debug worker. Default: false (bool)
overrideBenchmarkVersion string: Override benchmark version (string)
overrideSkips string[]: Override skip (string)
profile string: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

debug_master bool: Debug master. Default: false (bool)
debug_worker bool: Debug worker. Default: false (bool)
override_benchmark_version str: Override benchmark version (string)
override_skips Sequence[str]: Override skip (string)
profile str: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

debugMaster Boolean: Debug master. Default: false (bool)
debugWorker Boolean: Debug worker. Default: false (bool)
overrideBenchmarkVersion String: Override benchmark version (string)
overrideSkips List<String>: Override skip (string)
profile String: Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

Package Details

Repository: Rancher2 pulumi/pulumi-rancher2
License: Apache-2.0
Notes: This Pulumi package is based on the rancher2 Terraform Provider.