dome9 1.40.3, Apr 14 25

dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9

dome9.Assessment

Explore with Pulumi AI

dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9

Example Usage

Basic usage:

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as dome9 from "@pulumi/dome9";

const test = new dome9.Assessment("test", {
    bundleId: BUNDLE_ID,
    dome9CloudAccountId: DOME9_CLOUD_ACCOUNT_ID,
    cloudAccountId: CLOUD_ACCOUNT_ID,
    cloudAccountType: CLOUD_ACCOUNT_TYPE,
    shouldMinimizeResult: SHOULD_MINIMIZE_RESULT,
    requestId: REQUEST_ID,
});

import pulumi
import pulumi_dome9 as dome9

test = dome9.Assessment("test",
    bundle_id=bundl_e__id,
    dome9_cloud_account_id=dome9__clou_d__accoun_t__id,
    cloud_account_id=clou_d__accoun_t__id,
    cloud_account_type=clou_d__accoun_t__type,
    should_minimize_result=shoul_d__minimiz_e__result,
    request_id=reques_t__id)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/dome9/dome9"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dome9.NewAssessment(ctx, "test", &dome9.AssessmentArgs{
			BundleId:             pulumi.Any(BUNDLE_ID),
			Dome9CloudAccountId:  pulumi.Any(DOME9_CLOUD_ACCOUNT_ID),
			CloudAccountId:       pulumi.Any(CLOUD_ACCOUNT_ID),
			CloudAccountType:     pulumi.Any(CLOUD_ACCOUNT_TYPE),
			ShouldMinimizeResult: pulumi.Any(SHOULD_MINIMIZE_RESULT),
			RequestId:            pulumi.Any(REQUEST_ID),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Dome9 = Pulumi.Dome9;

return await Deployment.RunAsync(() => 
{
    var test = new Dome9.Assessment("test", new()
    {
        BundleId = BUNDLE_ID,
        Dome9CloudAccountId = DOME9_CLOUD_ACCOUNT_ID,
        CloudAccountId = CLOUD_ACCOUNT_ID,
        CloudAccountType = CLOUD_ACCOUNT_TYPE,
        ShouldMinimizeResult = SHOULD_MINIMIZE_RESULT,
        RequestId = REQUEST_ID,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dome9.Assessment;
import com.pulumi.dome9.AssessmentArgs;
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 test = new Assessment("test", AssessmentArgs.builder()
            .bundleId(BUNDLE_ID)
            .dome9CloudAccountId(DOME9_CLOUD_ACCOUNT_ID)
            .cloudAccountId(CLOUD_ACCOUNT_ID)
            .cloudAccountType(CLOUD_ACCOUNT_TYPE)
            .shouldMinimizeResult(SHOULD_MINIMIZE_RESULT)
            .requestId(REQUEST_ID)
            .build());

    }
}

resources:
  test:
    type: dome9:Assessment
    properties:
      bundleId: ${BUNDLE_ID}
      dome9CloudAccountId: ${DOME9_CLOUD_ACCOUNT_ID}
      cloudAccountId: ${CLOUD_ACCOUNT_ID}
      cloudAccountType: ${CLOUD_ACCOUNT_TYPE}
      shouldMinimizeResult: ${SHOULD_MINIMIZE_RESULT}
      requestId: ${REQUEST_ID}

Create Assessment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

new Assessment(name: string, args: AssessmentArgs, opts?: CustomResourceOptions);

@overload
def Assessment(resource_name: str,
               args: AssessmentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Assessment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               bundle_id: Optional[float] = None,
               cloud_account_id: Optional[str] = None,
               cloud_account_type: Optional[str] = None,
               request_id: Optional[str] = None,
               description: Optional[str] = None,
               dome9_assessment_id: Optional[str] = None,
               dome9_cloud_account_id: Optional[str] = None,
               external_cloud_account_id: Optional[str] = None,
               name: Optional[str] = None,
               should_minimize_result: Optional[bool] = None)

func NewAssessment(ctx *Context, name string, args AssessmentArgs, opts ...ResourceOption) (*Assessment, error)

public Assessment(string name, AssessmentArgs args, CustomResourceOptions? opts = null)

public Assessment(String name, AssessmentArgs args)
public Assessment(String name, AssessmentArgs args, CustomResourceOptions options)

type: dome9:Assessment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AssessmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AssessmentArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AssessmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AssessmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AssessmentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML

var assessmentResource = new Dome9.Assessment("assessmentResource", new()
{
    BundleId = 0,
    CloudAccountId = "string",
    CloudAccountType = "string",
    RequestId = "string",
    Description = "string",
    Dome9AssessmentId = "string",
    Dome9CloudAccountId = "string",
    ExternalCloudAccountId = "string",
    Name = "string",
    ShouldMinimizeResult = false,
});

example, err := dome9.NewAssessment(ctx, "assessmentResource", &dome9.AssessmentArgs{
BundleId: pulumi.Float64(0),
CloudAccountId: pulumi.String("string"),
CloudAccountType: pulumi.String("string"),
RequestId: pulumi.String("string"),
Description: pulumi.String("string"),
Dome9AssessmentId: pulumi.String("string"),
Dome9CloudAccountId: pulumi.String("string"),
ExternalCloudAccountId: pulumi.String("string"),
Name: pulumi.String("string"),
ShouldMinimizeResult: pulumi.Bool(false),
})

var assessmentResource = new Assessment("assessmentResource", AssessmentArgs.builder()
    .bundleId(0)
    .cloudAccountId("string")
    .cloudAccountType("string")
    .requestId("string")
    .description("string")
    .dome9AssessmentId("string")
    .dome9CloudAccountId("string")
    .externalCloudAccountId("string")
    .name("string")
    .shouldMinimizeResult(false)
    .build());

assessment_resource = dome9.Assessment("assessmentResource",
    bundle_id=0,
    cloud_account_id="string",
    cloud_account_type="string",
    request_id="string",
    description="string",
    dome9_assessment_id="string",
    dome9_cloud_account_id="string",
    external_cloud_account_id="string",
    name="string",
    should_minimize_result=False)

const assessmentResource = new dome9.Assessment("assessmentResource", {
    bundleId: 0,
    cloudAccountId: "string",
    cloudAccountType: "string",
    requestId: "string",
    description: "string",
    dome9AssessmentId: "string",
    dome9CloudAccountId: "string",
    externalCloudAccountId: "string",
    name: "string",
    shouldMinimizeResult: false,
});

type: dome9:Assessment
properties:
    bundleId: 0
    cloudAccountId: string
    cloudAccountType: string
    description: string
    dome9AssessmentId: string
    dome9CloudAccountId: string
    externalCloudAccountId: string
    name: string
    requestId: string
    shouldMinimizeResult: false

Assessment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Assessment resource accepts the following input properties:

BundleId double: The ruleset id to run.
CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
RequestId string: Request id.
Description string: Description of the request.
Dome9AssessmentId string: Rule ID.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
ExternalCloudAccountId string: External cloud account id.
Name string: Name of the ruleset.
ShouldMinimizeResult bool: Should minimize result size. Default: true.

BundleId float64: The ruleset id to run.
CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
RequestId string: Request id.
Description string: Description of the request.
Dome9AssessmentId string: Rule ID.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
ExternalCloudAccountId string: External cloud account id.
Name string: Name of the ruleset.
ShouldMinimizeResult bool: Should minimize result size. Default: true.

bundleId Double: The ruleset id to run.
cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
requestId String: Request id.
description String: Description of the request.
dome9AssessmentId String: Rule ID.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
externalCloudAccountId String: External cloud account id.
name String: Name of the ruleset.
shouldMinimizeResult Boolean: Should minimize result size. Default: true.

bundleId number: The ruleset id to run.
cloudAccountId string: Cloud account id to run the ruleset on.
cloudAccountType string
requestId string: Request id.
description string: Description of the request.
dome9AssessmentId string: Rule ID.
dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
externalCloudAccountId string: External cloud account id.
name string: Name of the ruleset.
shouldMinimizeResult boolean: Should minimize result size. Default: true.

bundle_id float: The ruleset id to run.
cloud_account_id str: Cloud account id to run the ruleset on.
cloud_account_type str
request_id str: Request id.
description str: Description of the request.
dome9_assessment_id str: Rule ID.
dome9_cloud_account_id str: dome9 cloud account id to run the ruleset on.
external_cloud_account_id str: External cloud account id.
name str: Name of the ruleset.
should_minimize_result bool: Should minimize result size. Default: true.

bundleId Number: The ruleset id to run.
cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
requestId String: Request id.
description String: Description of the request.
dome9AssessmentId String: Rule ID.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
externalCloudAccountId String: External cloud account id.
name String: Name of the ruleset.
shouldMinimizeResult Boolean: Should minimize result size. Default: true.

Outputs

All input properties are implicitly available as output properties. Additionally, the Assessment resource produces the following output properties:

AdditionalFields Dictionary<string, string>: Additional fields.
AssessmentId string: Assessment id.
AssessmentPassed bool: Is assessment_passed. True/False.
ComparisonCustomId string: Comparison custom id.
CreatedTime string: Date of assessment.
DataSyncStatuses List<AssessmentDataSyncStatus>: Data sync status - list of entities.
Exclusions List<AssessmentExclusion>: List of exclusions associated with this assessment.
HasDataSyncStatusIssues bool: Is has data sync status issues. True/False.
HasErrors bool: Is assessment has errors. True/False.
Id string: The provider-assigned unique ID for this managed resource.
Remediations List<AssessmentRemediation>: List of remediations associated with this assessment.
Requests List<AssessmentRequest>: Request content.
Stats List<AssessmentStat>: Summary statistics for assessment.
Tests List<AssessmentTest>: List of all the tests that have been run.
TriggeredBy string: Reason for assessment.

AdditionalFields map[string]string: Additional fields.
AssessmentId string: Assessment id.
AssessmentPassed bool: Is assessment_passed. True/False.
ComparisonCustomId string: Comparison custom id.
CreatedTime string: Date of assessment.
DataSyncStatuses []AssessmentDataSyncStatus: Data sync status - list of entities.
Exclusions []AssessmentExclusion: List of exclusions associated with this assessment.
HasDataSyncStatusIssues bool: Is has data sync status issues. True/False.
HasErrors bool: Is assessment has errors. True/False.
Id string: The provider-assigned unique ID for this managed resource.
Remediations []AssessmentRemediation: List of remediations associated with this assessment.
Requests []AssessmentRequest: Request content.
Stats []AssessmentStat: Summary statistics for assessment.
Tests []AssessmentTest: List of all the tests that have been run.
TriggeredBy string: Reason for assessment.

additionalFields Map<String,String>: Additional fields.
assessmentId String: Assessment id.
assessmentPassed Boolean: Is assessment_passed. True/False.
comparisonCustomId String: Comparison custom id.
createdTime String: Date of assessment.
dataSyncStatuses List<AssessmentDataSyncStatus>: Data sync status - list of entities.
exclusions List<AssessmentExclusion>: List of exclusions associated with this assessment.
hasDataSyncStatusIssues Boolean: Is has data sync status issues. True/False.
hasErrors Boolean: Is assessment has errors. True/False.
id String: The provider-assigned unique ID for this managed resource.
remediations List<AssessmentRemediation>: List of remediations associated with this assessment.
requests List<AssessmentRequest>: Request content.
stats List<AssessmentStat>: Summary statistics for assessment.
tests List<AssessmentTest>: List of all the tests that have been run.
triggeredBy String: Reason for assessment.

additionalFields {[key: string]: string}: Additional fields.
assessmentId string: Assessment id.
assessmentPassed boolean: Is assessment_passed. True/False.
comparisonCustomId string: Comparison custom id.
createdTime string: Date of assessment.
dataSyncStatuses AssessmentDataSyncStatus[]: Data sync status - list of entities.
exclusions AssessmentExclusion[]: List of exclusions associated with this assessment.
hasDataSyncStatusIssues boolean: Is has data sync status issues. True/False.
hasErrors boolean: Is assessment has errors. True/False.
id string: The provider-assigned unique ID for this managed resource.
remediations AssessmentRemediation[]: List of remediations associated with this assessment.
requests AssessmentRequest[]: Request content.
stats AssessmentStat[]: Summary statistics for assessment.
tests AssessmentTest[]: List of all the tests that have been run.
triggeredBy string: Reason for assessment.

additional_fields Mapping[str, str]: Additional fields.
assessment_id str: Assessment id.
assessment_passed bool: Is assessment_passed. True/False.
comparison_custom_id str: Comparison custom id.
created_time str: Date of assessment.
data_sync_statuses Sequence[AssessmentDataSyncStatus]: Data sync status - list of entities.
exclusions Sequence[AssessmentExclusion]: List of exclusions associated with this assessment.
has_data_sync_status_issues bool: Is has data sync status issues. True/False.
has_errors bool: Is assessment has errors. True/False.
id str: The provider-assigned unique ID for this managed resource.
remediations Sequence[AssessmentRemediation]: List of remediations associated with this assessment.
requests Sequence[AssessmentRequest]: Request content.
stats Sequence[AssessmentStat]: Summary statistics for assessment.
tests Sequence[AssessmentTest]: List of all the tests that have been run.
triggered_by str: Reason for assessment.

additionalFields Map<String>: Additional fields.
assessmentId String: Assessment id.
assessmentPassed Boolean: Is assessment_passed. True/False.
comparisonCustomId String: Comparison custom id.
createdTime String: Date of assessment.
dataSyncStatuses List<Property Map>: Data sync status - list of entities.
exclusions List<Property Map>: List of exclusions associated with this assessment.
hasDataSyncStatusIssues Boolean: Is has data sync status issues. True/False.
hasErrors Boolean: Is assessment has errors. True/False.
id String: The provider-assigned unique ID for this managed resource.
remediations List<Property Map>: List of remediations associated with this assessment.
requests List<Property Map>: Request content.
stats List<Property Map>: Summary statistics for assessment.
tests List<Property Map>: List of all the tests that have been run.
triggeredBy String: Reason for assessment.

Look up Existing Assessment Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: AssessmentState, opts?: CustomResourceOptions): Assessment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_fields: Optional[Mapping[str, str]] = None,
        assessment_id: Optional[str] = None,
        assessment_passed: Optional[bool] = None,
        bundle_id: Optional[float] = None,
        cloud_account_id: Optional[str] = None,
        cloud_account_type: Optional[str] = None,
        comparison_custom_id: Optional[str] = None,
        created_time: Optional[str] = None,
        data_sync_statuses: Optional[Sequence[AssessmentDataSyncStatusArgs]] = None,
        description: Optional[str] = None,
        dome9_assessment_id: Optional[str] = None,
        dome9_cloud_account_id: Optional[str] = None,
        exclusions: Optional[Sequence[AssessmentExclusionArgs]] = None,
        external_cloud_account_id: Optional[str] = None,
        has_data_sync_status_issues: Optional[bool] = None,
        has_errors: Optional[bool] = None,
        name: Optional[str] = None,
        remediations: Optional[Sequence[AssessmentRemediationArgs]] = None,
        request_id: Optional[str] = None,
        requests: Optional[Sequence[AssessmentRequestArgs]] = None,
        should_minimize_result: Optional[bool] = None,
        stats: Optional[Sequence[AssessmentStatArgs]] = None,
        tests: Optional[Sequence[AssessmentTestArgs]] = None,
        triggered_by: Optional[str] = None) -> Assessment

func GetAssessment(ctx *Context, name string, id IDInput, state *AssessmentState, opts ...ResourceOption) (*Assessment, error)

public static Assessment Get(string name, Input<string> id, AssessmentState? state, CustomResourceOptions? opts = null)

public static Assessment get(String name, Output<String> id, AssessmentState state, CustomResourceOptions options)

resources:  _:    type: dome9:Assessment    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AdditionalFields Dictionary<string, string>: Additional fields.
AssessmentId string: Assessment id.
AssessmentPassed bool: Is assessment_passed. True/False.
BundleId double: The ruleset id to run.
CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
ComparisonCustomId string: Comparison custom id.
CreatedTime string: Date of assessment.
DataSyncStatuses List<AssessmentDataSyncStatus>: Data sync status - list of entities.
Description string: Description of the request.
Dome9AssessmentId string: Rule ID.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
Exclusions List<AssessmentExclusion>: List of exclusions associated with this assessment.
ExternalCloudAccountId string: External cloud account id.
HasDataSyncStatusIssues bool: Is has data sync status issues. True/False.
HasErrors bool: Is assessment has errors. True/False.
Name string: Name of the ruleset.
Remediations List<AssessmentRemediation>: List of remediations associated with this assessment.
RequestId string: Request id.
Requests List<AssessmentRequest>: Request content.
ShouldMinimizeResult bool: Should minimize result size. Default: true.
Stats List<AssessmentStat>: Summary statistics for assessment.
Tests List<AssessmentTest>: List of all the tests that have been run.
TriggeredBy string: Reason for assessment.

AdditionalFields map[string]string: Additional fields.
AssessmentId string: Assessment id.
AssessmentPassed bool: Is assessment_passed. True/False.
BundleId float64: The ruleset id to run.
CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
ComparisonCustomId string: Comparison custom id.
CreatedTime string: Date of assessment.
DataSyncStatuses []AssessmentDataSyncStatusArgs: Data sync status - list of entities.
Description string: Description of the request.
Dome9AssessmentId string: Rule ID.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
Exclusions []AssessmentExclusionArgs: List of exclusions associated with this assessment.
ExternalCloudAccountId string: External cloud account id.
HasDataSyncStatusIssues bool: Is has data sync status issues. True/False.
HasErrors bool: Is assessment has errors. True/False.
Name string: Name of the ruleset.
Remediations []AssessmentRemediationArgs: List of remediations associated with this assessment.
RequestId string: Request id.
Requests []AssessmentRequestArgs: Request content.
ShouldMinimizeResult bool: Should minimize result size. Default: true.
Stats []AssessmentStatArgs: Summary statistics for assessment.
Tests []AssessmentTestArgs: List of all the tests that have been run.
TriggeredBy string: Reason for assessment.

additionalFields Map<String,String>: Additional fields.
assessmentId String: Assessment id.
assessmentPassed Boolean: Is assessment_passed. True/False.
bundleId Double: The ruleset id to run.
cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
comparisonCustomId String: Comparison custom id.
createdTime String: Date of assessment.
dataSyncStatuses List<AssessmentDataSyncStatus>: Data sync status - list of entities.
description String: Description of the request.
dome9AssessmentId String: Rule ID.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
exclusions List<AssessmentExclusion>: List of exclusions associated with this assessment.
externalCloudAccountId String: External cloud account id.
hasDataSyncStatusIssues Boolean: Is has data sync status issues. True/False.
hasErrors Boolean: Is assessment has errors. True/False.
name String: Name of the ruleset.
remediations List<AssessmentRemediation>: List of remediations associated with this assessment.
requestId String: Request id.
requests List<AssessmentRequest>: Request content.
shouldMinimizeResult Boolean: Should minimize result size. Default: true.
stats List<AssessmentStat>: Summary statistics for assessment.
tests List<AssessmentTest>: List of all the tests that have been run.
triggeredBy String: Reason for assessment.

additionalFields {[key: string]: string}: Additional fields.
assessmentId string: Assessment id.
assessmentPassed boolean: Is assessment_passed. True/False.
bundleId number: The ruleset id to run.
cloudAccountId string: Cloud account id to run the ruleset on.
cloudAccountType string
comparisonCustomId string: Comparison custom id.
createdTime string: Date of assessment.
dataSyncStatuses AssessmentDataSyncStatus[]: Data sync status - list of entities.
description string: Description of the request.
dome9AssessmentId string: Rule ID.
dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
exclusions AssessmentExclusion[]: List of exclusions associated with this assessment.
externalCloudAccountId string: External cloud account id.
hasDataSyncStatusIssues boolean: Is has data sync status issues. True/False.
hasErrors boolean: Is assessment has errors. True/False.
name string: Name of the ruleset.
remediations AssessmentRemediation[]: List of remediations associated with this assessment.
requestId string: Request id.
requests AssessmentRequest[]: Request content.
shouldMinimizeResult boolean: Should minimize result size. Default: true.
stats AssessmentStat[]: Summary statistics for assessment.
tests AssessmentTest[]: List of all the tests that have been run.
triggeredBy string: Reason for assessment.

additional_fields Mapping[str, str]: Additional fields.
assessment_id str: Assessment id.
assessment_passed bool: Is assessment_passed. True/False.
bundle_id float: The ruleset id to run.
cloud_account_id str: Cloud account id to run the ruleset on.
cloud_account_type str
comparison_custom_id str: Comparison custom id.
created_time str: Date of assessment.
data_sync_statuses Sequence[AssessmentDataSyncStatusArgs]: Data sync status - list of entities.
description str: Description of the request.
dome9_assessment_id str: Rule ID.
dome9_cloud_account_id str: dome9 cloud account id to run the ruleset on.
exclusions Sequence[AssessmentExclusionArgs]: List of exclusions associated with this assessment.
external_cloud_account_id str: External cloud account id.
has_data_sync_status_issues bool: Is has data sync status issues. True/False.
has_errors bool: Is assessment has errors. True/False.
name str: Name of the ruleset.
remediations Sequence[AssessmentRemediationArgs]: List of remediations associated with this assessment.
request_id str: Request id.
requests Sequence[AssessmentRequestArgs]: Request content.
should_minimize_result bool: Should minimize result size. Default: true.
stats Sequence[AssessmentStatArgs]: Summary statistics for assessment.
tests Sequence[AssessmentTestArgs]: List of all the tests that have been run.
triggered_by str: Reason for assessment.

additionalFields Map<String>: Additional fields.
assessmentId String: Assessment id.
assessmentPassed Boolean: Is assessment_passed. True/False.
bundleId Number: The ruleset id to run.
cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
comparisonCustomId String: Comparison custom id.
createdTime String: Date of assessment.
dataSyncStatuses List<Property Map>: Data sync status - list of entities.
description String: Description of the request.
dome9AssessmentId String: Rule ID.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
exclusions List<Property Map>: List of exclusions associated with this assessment.
externalCloudAccountId String: External cloud account id.
hasDataSyncStatusIssues Boolean: Is has data sync status issues. True/False.
hasErrors Boolean: Is assessment has errors. True/False.
name String: Name of the ruleset.
remediations List<Property Map>: List of remediations associated with this assessment.
requestId String: Request id.
requests List<Property Map>: Request content.
shouldMinimizeResult Boolean: Should minimize result size. Default: true.
stats List<Property Map>: Summary statistics for assessment.
tests List<Property Map>: List of all the tests that have been run.
triggeredBy String: Reason for assessment.

Supporting Types

AssessmentDataSyncStatus
, AssessmentDataSyncStatusArgs

EntitiesWithPermissionIssues List<AssessmentDataSyncStatusEntitiesWithPermissionIssue>: List entities with permission issues.
EntityType string: Entity type.
GeneralFetchPermissionIssues bool: Is general fetch permission issues. True/False.
RecentlySuccessfulSync bool: Is recently successful sync. True/False.

EntitiesWithPermissionIssues []AssessmentDataSyncStatusEntitiesWithPermissionIssue: List entities with permission issues.
EntityType string: Entity type.
GeneralFetchPermissionIssues bool: Is general fetch permission issues. True/False.
RecentlySuccessfulSync bool: Is recently successful sync. True/False.

entitiesWithPermissionIssues List<AssessmentDataSyncStatusEntitiesWithPermissionIssue>: List entities with permission issues.
entityType String: Entity type.
generalFetchPermissionIssues Boolean: Is general fetch permission issues. True/False.
recentlySuccessfulSync Boolean: Is recently successful sync. True/False.

entitiesWithPermissionIssues AssessmentDataSyncStatusEntitiesWithPermissionIssue[]: List entities with permission issues.
entityType string: Entity type.
generalFetchPermissionIssues boolean: Is general fetch permission issues. True/False.
recentlySuccessfulSync boolean: Is recently successful sync. True/False.

entities_with_permission_issues Sequence[AssessmentDataSyncStatusEntitiesWithPermissionIssue]: List entities with permission issues.
entity_type str: Entity type.
general_fetch_permission_issues bool: Is general fetch permission issues. True/False.
recently_successful_sync bool: Is recently successful sync. True/False.

entitiesWithPermissionIssues List<Property Map>: List entities with permission issues.
entityType String: Entity type.
generalFetchPermissionIssues Boolean: Is general fetch permission issues. True/False.
recentlySuccessfulSync Boolean: Is recently successful sync. True/False.

AssessmentDataSyncStatusEntitiesWithPermissionIssue
, AssessmentDataSyncStatusEntitiesWithPermissionIssueArgs

CloudVendorIdentifier string: Entity cloud vendor identifier.
ExternalId string: Entity external id.
Name string: Name of the ruleset.

CloudVendorIdentifier string: Entity cloud vendor identifier.
ExternalId string: Entity external id.
Name string: Name of the ruleset.

cloudVendorIdentifier String: Entity cloud vendor identifier.
externalId String: Entity external id.
name String: Name of the ruleset.

cloudVendorIdentifier string: Entity cloud vendor identifier.
externalId string: Entity external id.
name string: Name of the ruleset.

cloud_vendor_identifier str: Entity cloud vendor identifier.
external_id str: Entity external id.
name str: Name of the ruleset.

cloudVendorIdentifier String: Entity cloud vendor identifier.
externalId String: Entity external id.
name String: Name of the ruleset.

AssessmentExclusion
, AssessmentExclusionArgs

CloudAccountIds List<string>: List of cloud account IDs to apply exclusion on.
Comment string: Comment text (free text).
DateRanges List<AssessmentExclusionDateRange>: Effective date range for the exclusion.
Id double: Rule ID.
LogicExpressions List<string>: The GSL logic expressions of the exclusion.
OrganizationalUnitIds List<string>: List of organizational unit IDs to apply exclusion on.
Platform string
Rules List<AssessmentExclusionRule>: List of rules to apply the exclusion on.
RulesetId double: Ruleset ID to apply exclusion on.

CloudAccountIds []string: List of cloud account IDs to apply exclusion on.
Comment string: Comment text (free text).
DateRanges []AssessmentExclusionDateRange: Effective date range for the exclusion.
Id float64: Rule ID.
LogicExpressions []string: The GSL logic expressions of the exclusion.
OrganizationalUnitIds []string: List of organizational unit IDs to apply exclusion on.
Platform string
Rules []AssessmentExclusionRule: List of rules to apply the exclusion on.
RulesetId float64: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
comment String: Comment text (free text).
dateRanges List<AssessmentExclusionDateRange>: Effective date range for the exclusion.
id Double: Rule ID.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<AssessmentExclusionRule>: List of rules to apply the exclusion on.
rulesetId Double: Ruleset ID to apply exclusion on.

cloudAccountIds string[]: List of cloud account IDs to apply exclusion on.
comment string: Comment text (free text).
dateRanges AssessmentExclusionDateRange[]: Effective date range for the exclusion.
id number: Rule ID.
logicExpressions string[]: The GSL logic expressions of the exclusion.
organizationalUnitIds string[]: List of organizational unit IDs to apply exclusion on.
platform string
rules AssessmentExclusionRule[]: List of rules to apply the exclusion on.
rulesetId number: Ruleset ID to apply exclusion on.

cloud_account_ids Sequence[str]: List of cloud account IDs to apply exclusion on.
comment str: Comment text (free text).
date_ranges Sequence[AssessmentExclusionDateRange]: Effective date range for the exclusion.
id float: Rule ID.
logic_expressions Sequence[str]: The GSL logic expressions of the exclusion.
organizational_unit_ids Sequence[str]: List of organizational unit IDs to apply exclusion on.
platform str
rules Sequence[AssessmentExclusionRule]: List of rules to apply the exclusion on.
ruleset_id float: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
comment String: Comment text (free text).
dateRanges List<Property Map>: Effective date range for the exclusion.
id Number: Rule ID.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<Property Map>: List of rules to apply the exclusion on.
rulesetId Number: Ruleset ID to apply exclusion on.

AssessmentExclusionDateRange
, AssessmentExclusionDateRangeArgs

From string: From date time.
To string: To date time.

From string: From date time.
To string: To date time.

from String: From date time.
to String: To date time.

from string: From date time.
to string: To date time.

from_ str: From date time.
to str: To date time.

from String: From date time.
to String: To date time.

AssessmentExclusionRule
, AssessmentExclusionRuleArgs

Id double: Rule ID.
LogicHash string: Rule logic hash.
Name string: Name of the ruleset.

Id float64: Rule ID.
LogicHash string: Rule logic hash.
Name string: Name of the ruleset.

id Double: Rule ID.
logicHash String: Rule logic hash.
name String: Name of the ruleset.

id number: Rule ID.
logicHash string: Rule logic hash.
name string: Name of the ruleset.

id float: Rule ID.
logic_hash str: Rule logic hash.
name str: Name of the ruleset.

id Number: Rule ID.
logicHash String: Rule logic hash.
name String: Name of the ruleset.

AssessmentRemediation
, AssessmentRemediationArgs

CloudAccountIds List<string>: List of cloud account IDs to apply exclusion on.
CloudBots List<string>: Cloud bots execution expressions.
Comment string: Comment text (free text).
DateRanges List<AssessmentRemediationDateRange>: Effective date range for the exclusion.
Id double: Rule ID.
LogicExpressions List<string>: The GSL logic expressions of the exclusion.
OrganizationalUnitIds List<string>: List of organizational unit IDs to apply exclusion on.
Platform string
Rules List<AssessmentRemediationRule>: List of rules to apply the exclusion on.
RulesetId double: Ruleset ID to apply exclusion on.

CloudAccountIds []string: List of cloud account IDs to apply exclusion on.
CloudBots []string: Cloud bots execution expressions.
Comment string: Comment text (free text).
DateRanges []AssessmentRemediationDateRange: Effective date range for the exclusion.
Id float64: Rule ID.
LogicExpressions []string: The GSL logic expressions of the exclusion.
OrganizationalUnitIds []string: List of organizational unit IDs to apply exclusion on.
Platform string
Rules []AssessmentRemediationRule: List of rules to apply the exclusion on.
RulesetId float64: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
cloudBots List<String>: Cloud bots execution expressions.
comment String: Comment text (free text).
dateRanges List<AssessmentRemediationDateRange>: Effective date range for the exclusion.
id Double: Rule ID.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<AssessmentRemediationRule>: List of rules to apply the exclusion on.
rulesetId Double: Ruleset ID to apply exclusion on.

cloudAccountIds string[]: List of cloud account IDs to apply exclusion on.
cloudBots string[]: Cloud bots execution expressions.
comment string: Comment text (free text).
dateRanges AssessmentRemediationDateRange[]: Effective date range for the exclusion.
id number: Rule ID.
logicExpressions string[]: The GSL logic expressions of the exclusion.
organizationalUnitIds string[]: List of organizational unit IDs to apply exclusion on.
platform string
rules AssessmentRemediationRule[]: List of rules to apply the exclusion on.
rulesetId number: Ruleset ID to apply exclusion on.

cloud_account_ids Sequence[str]: List of cloud account IDs to apply exclusion on.
cloud_bots Sequence[str]: Cloud bots execution expressions.
comment str: Comment text (free text).
date_ranges Sequence[AssessmentRemediationDateRange]: Effective date range for the exclusion.
id float: Rule ID.
logic_expressions Sequence[str]: The GSL logic expressions of the exclusion.
organizational_unit_ids Sequence[str]: List of organizational unit IDs to apply exclusion on.
platform str
rules Sequence[AssessmentRemediationRule]: List of rules to apply the exclusion on.
ruleset_id float: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
cloudBots List<String>: Cloud bots execution expressions.
comment String: Comment text (free text).
dateRanges List<Property Map>: Effective date range for the exclusion.
id Number: Rule ID.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<Property Map>: List of rules to apply the exclusion on.
rulesetId Number: Ruleset ID to apply exclusion on.

AssessmentRemediationDateRange
, AssessmentRemediationDateRangeArgs

From string: From date time.
To string: To date time.

From string: From date time.
To string: To date time.

from String: From date time.
to String: To date time.

from string: From date time.
to string: To date time.

from_ str: From date time.
to str: To date time.

from String: From date time.
to String: To date time.

AssessmentRemediationRule
, AssessmentRemediationRuleArgs

Id double: Rule ID.
LogicHash string: Rule logic hash.
Name string: Name of the ruleset.

Id float64: Rule ID.
LogicHash string: Rule logic hash.
Name string: Name of the ruleset.

id Double: Rule ID.
logicHash String: Rule logic hash.
name String: Name of the ruleset.

id number: Rule ID.
logicHash string: Rule logic hash.
name string: Name of the ruleset.

id float: Rule ID.
logic_hash str: Rule logic hash.
name str: Name of the ruleset.

id Number: Rule ID.
logicHash String: Rule logic hash.
name String: Name of the ruleset.

AssessmentRequest
, AssessmentRequestArgs

CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
Description string: Description of the request.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
ExternalCloudAccountId string: External cloud account id.
Id double: Rule ID.
IsTemplate bool: Is CloudGuard template ruleset.
Name string: Name of the ruleset.
RequestId string: Request id.
ShouldMinimizeResult bool: Should minimize result size. Default: true.

CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
Description string: Description of the request.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
ExternalCloudAccountId string: External cloud account id.
Id float64: Rule ID.
IsTemplate bool: Is CloudGuard template ruleset.
Name string: Name of the ruleset.
RequestId string: Request id.
ShouldMinimizeResult bool: Should minimize result size. Default: true.

cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
description String: Description of the request.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
externalCloudAccountId String: External cloud account id.
id Double: Rule ID.
isTemplate Boolean: Is CloudGuard template ruleset.
name String: Name of the ruleset.
requestId String: Request id.
shouldMinimizeResult Boolean: Should minimize result size. Default: true.

cloudAccountId string: Cloud account id to run the ruleset on.
cloudAccountType string
description string: Description of the request.
dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
externalCloudAccountId string: External cloud account id.
id number: Rule ID.
isTemplate boolean: Is CloudGuard template ruleset.
name string: Name of the ruleset.
requestId string: Request id.
shouldMinimizeResult boolean: Should minimize result size. Default: true.

cloud_account_id str: Cloud account id to run the ruleset on.
cloud_account_type str
description str: Description of the request.
dome9_cloud_account_id str: dome9 cloud account id to run the ruleset on.
external_cloud_account_id str: External cloud account id.
id float: Rule ID.
is_template bool: Is CloudGuard template ruleset.
name str: Name of the ruleset.
request_id str: Request id.
should_minimize_result bool: Should minimize result size. Default: true.

cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
description String: Description of the request.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
externalCloudAccountId String: External cloud account id.
id Number: Rule ID.
isTemplate Boolean: Is CloudGuard template ruleset.
name String: Name of the ruleset.
requestId String: Request id.
shouldMinimizeResult Boolean: Should minimize result size. Default: true.

AssessmentStat
, AssessmentStatArgs

Error double: Number of errors
ExcludedFailedTests double: Number of excluded tests that also failed.
ExcludedRules double: Number of rules that contains only excluded tests.
ExcludedRulesBySeverities List<AssessmentStatExcludedRulesBySeverity>: Excluded rules divided by severity.
ExcludedTests double: Number of excluded tests.
Failed double: Number of failed rules.
FailedEntities double: Number of failed entities.
FailedRulesBySeverities List<AssessmentStatFailedRulesBySeverity>: Failed rules divided by severity.
FailedTests double: Number of failed tests.
LogicallyTested double: Total number of tests performed.
Passed double: Number of passed rules.
PassedRulesBySeverities List<AssessmentStatPassedRulesBySeverity>: Passed rules divided by severity.

Error float64: Number of errors
ExcludedFailedTests float64: Number of excluded tests that also failed.
ExcludedRules float64: Number of rules that contains only excluded tests.
ExcludedRulesBySeverities []AssessmentStatExcludedRulesBySeverity: Excluded rules divided by severity.
ExcludedTests float64: Number of excluded tests.
Failed float64: Number of failed rules.
FailedEntities float64: Number of failed entities.
FailedRulesBySeverities []AssessmentStatFailedRulesBySeverity: Failed rules divided by severity.
FailedTests float64: Number of failed tests.
LogicallyTested float64: Total number of tests performed.
Passed float64: Number of passed rules.
PassedRulesBySeverities []AssessmentStatPassedRulesBySeverity: Passed rules divided by severity.

error Double: Number of errors
excludedFailedTests Double: Number of excluded tests that also failed.
excludedRules Double: Number of rules that contains only excluded tests.
excludedRulesBySeverities List<AssessmentStatExcludedRulesBySeverity>: Excluded rules divided by severity.
excludedTests Double: Number of excluded tests.
failed Double: Number of failed rules.
failedEntities Double: Number of failed entities.
failedRulesBySeverities List<AssessmentStatFailedRulesBySeverity>: Failed rules divided by severity.
failedTests Double: Number of failed tests.
logicallyTested Double: Total number of tests performed.
passed Double: Number of passed rules.
passedRulesBySeverities List<AssessmentStatPassedRulesBySeverity>: Passed rules divided by severity.

error number: Number of errors
excludedFailedTests number: Number of excluded tests that also failed.
excludedRules number: Number of rules that contains only excluded tests.
excludedRulesBySeverities AssessmentStatExcludedRulesBySeverity[]: Excluded rules divided by severity.
excludedTests number: Number of excluded tests.
failed number: Number of failed rules.
failedEntities number: Number of failed entities.
failedRulesBySeverities AssessmentStatFailedRulesBySeverity[]: Failed rules divided by severity.
failedTests number: Number of failed tests.
logicallyTested number: Total number of tests performed.
passed number: Number of passed rules.
passedRulesBySeverities AssessmentStatPassedRulesBySeverity[]: Passed rules divided by severity.

error float: Number of errors
excluded_failed_tests float: Number of excluded tests that also failed.
excluded_rules float: Number of rules that contains only excluded tests.
excluded_rules_by_severities Sequence[AssessmentStatExcludedRulesBySeverity]: Excluded rules divided by severity.
excluded_tests float: Number of excluded tests.
failed float: Number of failed rules.
failed_entities float: Number of failed entities.
failed_rules_by_severities Sequence[AssessmentStatFailedRulesBySeverity]: Failed rules divided by severity.
failed_tests float: Number of failed tests.
logically_tested float: Total number of tests performed.
passed float: Number of passed rules.
passed_rules_by_severities Sequence[AssessmentStatPassedRulesBySeverity]: Passed rules divided by severity.

error Number: Number of errors
excludedFailedTests Number: Number of excluded tests that also failed.
excludedRules Number: Number of rules that contains only excluded tests.
excludedRulesBySeverities List<Property Map>: Excluded rules divided by severity.
excludedTests Number: Number of excluded tests.
failed Number: Number of failed rules.
failedEntities Number: Number of failed entities.
failedRulesBySeverities List<Property Map>: Failed rules divided by severity.
failedTests Number: Number of failed tests.
logicallyTested Number: Total number of tests performed.
passed Number: Number of passed rules.
passedRulesBySeverities List<Property Map>: Passed rules divided by severity.

AssessmentStatExcludedRulesBySeverity
, AssessmentStatExcludedRulesBySeverityArgs

Critical double: Critical.
High double: High.
Informational double: Informational.
Low double: Low.
Medium double: Medium.

Critical float64: Critical.
High float64: High.
Informational float64: Informational.
Low float64: Low.
Medium float64: Medium.

critical Double: Critical.
high Double: High.
informational Double: Informational.
low Double: Low.
medium Double: Medium.

critical number: Critical.
high number: High.
informational number: Informational.
low number: Low.
medium number: Medium.

critical float: Critical.
high float: High.
informational float: Informational.
low float: Low.
medium float: Medium.

critical Number: Critical.
high Number: High.
informational Number: Informational.
low Number: Low.
medium Number: Medium.

AssessmentStatFailedRulesBySeverity
, AssessmentStatFailedRulesBySeverityArgs

Critical double: Critical.
High double: High.
Informational double: Informational.
Low double: Low.
Medium double: Medium.

Critical float64: Critical.
High float64: High.
Informational float64: Informational.
Low float64: Low.
Medium float64: Medium.

critical Double: Critical.
high Double: High.
informational Double: Informational.
low Double: Low.
medium Double: Medium.

critical number: Critical.
high number: High.
informational number: Informational.
low number: Low.
medium number: Medium.

critical float: Critical.
high float: High.
informational float: Informational.
low float: Low.
medium float: Medium.

critical Number: Critical.
high Number: High.
informational Number: Informational.
low Number: Low.
medium Number: Medium.

AssessmentStatPassedRulesBySeverity
, AssessmentStatPassedRulesBySeverityArgs

Critical double: Critical.
High double: High.
Informational double: Informational.
Low double: Low.
Medium double: Medium.

Critical float64: Critical.
High float64: High.
Informational float64: Informational.
Low float64: Low.
Medium float64: Medium.

critical Double: Critical.
high Double: High.
informational Double: Informational.
low Double: Low.
medium Double: Medium.

critical number: Critical.
high number: High.
informational number: Informational.
low number: Low.
medium number: Medium.

critical float: Critical.
high float: High.
informational float: Informational.
low float: Low.
medium float: Medium.

critical Number: Critical.
high Number: High.
informational Number: Informational.
low Number: Low.
medium Number: Medium.

AssessmentTest
, AssessmentTestArgs

EntityResults List<AssessmentTestEntityResult>: Entity results.
Error string: Number of errors
ExclusionStats List<AssessmentTestExclusionStat>: Exclusion stats.
NonComplyingCount double: Number of assets that has been non-complying to the test.
RelevantCount double: Number of assets that has been relevant to the test.
Rules List<AssessmentTestRule>: Rule.
TestPassed bool: Is test passed: true/false.
TestedCount double: Number of assets that has been excluded from the test.

EntityResults []AssessmentTestEntityResult: Entity results.
Error string: Number of errors
ExclusionStats []AssessmentTestExclusionStat: Exclusion stats.
NonComplyingCount float64: Number of assets that has been non-complying to the test.
RelevantCount float64: Number of assets that has been relevant to the test.
Rules []AssessmentTestRule: Rule.
TestPassed bool: Is test passed: true/false.
TestedCount float64: Number of assets that has been excluded from the test.

entityResults List<AssessmentTestEntityResult>: Entity results.
error String: Number of errors
exclusionStats List<AssessmentTestExclusionStat>: Exclusion stats.
nonComplyingCount Double: Number of assets that has been non-complying to the test.
relevantCount Double: Number of assets that has been relevant to the test.
rules List<AssessmentTestRule>: Rule.
testPassed Boolean: Is test passed: true/false.
testedCount Double: Number of assets that has been excluded from the test.

entityResults AssessmentTestEntityResult[]: Entity results.
error string: Number of errors
exclusionStats AssessmentTestExclusionStat[]: Exclusion stats.
nonComplyingCount number: Number of assets that has been non-complying to the test.
relevantCount number: Number of assets that has been relevant to the test.
rules AssessmentTestRule[]: Rule.
testPassed boolean: Is test passed: true/false.
testedCount number: Number of assets that has been excluded from the test.

entity_results Sequence[AssessmentTestEntityResult]: Entity results.
error str: Number of errors
exclusion_stats Sequence[AssessmentTestExclusionStat]: Exclusion stats.
non_complying_count float: Number of assets that has been non-complying to the test.
relevant_count float: Number of assets that has been relevant to the test.
rules Sequence[AssessmentTestRule]: Rule.
test_passed bool: Is test passed: true/false.
tested_count float: Number of assets that has been excluded from the test.

entityResults List<Property Map>: Entity results.
error String: Number of errors
exclusionStats List<Property Map>: Exclusion stats.
nonComplyingCount Number: Number of assets that has been non-complying to the test.
relevantCount Number: Number of assets that has been relevant to the test.
rules List<Property Map>: Rule.
testPassed Boolean: Is test passed: true/false.
testedCount Number: Number of assets that has been excluded from the test.

AssessmentTestEntityResult
, AssessmentTestEntityResultArgs

Error string: Number of errors
ExclusionId string: Guid, can be Null.
IsExcluded bool: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
IsRelevant bool: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
IsValid bool: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
RemediationId string: Guid, can be Null.
TestObjs List<AssessmentTestEntityResultTestObj>: The object that has been tested.
ValidationStatus string: Can be: Relevant, Valid, Excluded.

Error string: Number of errors
ExclusionId string: Guid, can be Null.
IsExcluded bool: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
IsRelevant bool: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
IsValid bool: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
RemediationId string: Guid, can be Null.
TestObjs []AssessmentTestEntityResultTestObj: The object that has been tested.
ValidationStatus string: Can be: Relevant, Valid, Excluded.

error String: Number of errors
exclusionId String: Guid, can be Null.
isExcluded Boolean: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
isRelevant Boolean: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
isValid Boolean: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediationId String: Guid, can be Null.
testObjs List<AssessmentTestEntityResultTestObj>: The object that has been tested.
validationStatus String: Can be: Relevant, Valid, Excluded.

error string: Number of errors
exclusionId string: Guid, can be Null.
isExcluded boolean: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
isRelevant boolean: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
isValid boolean: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediationId string: Guid, can be Null.
testObjs AssessmentTestEntityResultTestObj[]: The object that has been tested.
validationStatus string: Can be: Relevant, Valid, Excluded.

error str: Number of errors
exclusion_id str: Guid, can be Null.
is_excluded bool: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
is_relevant bool: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
is_valid bool: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediation_id str: Guid, can be Null.
test_objs Sequence[AssessmentTestEntityResultTestObj]: The object that has been tested.
validation_status str: Can be: Relevant, Valid, Excluded.

error String: Number of errors
exclusionId String: Guid, can be Null.
isExcluded Boolean: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
isRelevant Boolean: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
isValid Boolean: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediationId String: Guid, can be Null.
testObjs List<Property Map>: The object that has been tested.
validationStatus String: Can be: Relevant, Valid, Excluded.

AssessmentTestEntityResultTestObj
, AssessmentTestEntityResultTestObjArgs

CustomEntityComparisonHash string: Custom entity comparison hash of the object.
Dome9Id string: Dome9 id of the object.
EntityIndex double: Entity index of the object.
EntityType string: Entity type.
Id string: Rule ID.

CustomEntityComparisonHash string: Custom entity comparison hash of the object.
Dome9Id string: Dome9 id of the object.
EntityIndex float64: Entity index of the object.
EntityType string: Entity type.
Id string: Rule ID.

customEntityComparisonHash String: Custom entity comparison hash of the object.
dome9Id String: Dome9 id of the object.
entityIndex Double: Entity index of the object.
entityType String: Entity type.
id String: Rule ID.

customEntityComparisonHash string: Custom entity comparison hash of the object.
dome9Id string: Dome9 id of the object.
entityIndex number: Entity index of the object.
entityType string: Entity type.
id string: Rule ID.

custom_entity_comparison_hash str: Custom entity comparison hash of the object.
dome9_id str: Dome9 id of the object.
entity_index float: Entity index of the object.
entity_type str: Entity type.
id str: Rule ID.

customEntityComparisonHash String: Custom entity comparison hash of the object.
dome9Id String: Dome9 id of the object.
entityIndex Number: Entity index of the object.
entityType String: Entity type.
id String: Rule ID.

AssessmentTestExclusionStat
, AssessmentTestExclusionStatArgs

NonComplyingCount double: Number of assets that has been non-complying to the test.
RelevantCount double: Number of assets that has been relevant to the test.
TestedCount double: Number of assets that has been excluded from the test.

NonComplyingCount float64: Number of assets that has been non-complying to the test.
RelevantCount float64: Number of assets that has been relevant to the test.
TestedCount float64: Number of assets that has been excluded from the test.

nonComplyingCount Double: Number of assets that has been non-complying to the test.
relevantCount Double: Number of assets that has been relevant to the test.
testedCount Double: Number of assets that has been excluded from the test.

nonComplyingCount number: Number of assets that has been non-complying to the test.
relevantCount number: Number of assets that has been relevant to the test.
testedCount number: Number of assets that has been excluded from the test.

non_complying_count float: Number of assets that has been non-complying to the test.
relevant_count float: Number of assets that has been relevant to the test.
tested_count float: Number of assets that has been excluded from the test.

nonComplyingCount Number: Number of assets that has been non-complying to the test.
relevantCount Number: Number of assets that has been relevant to the test.
testedCount Number: Number of assets that has been excluded from the test.

AssessmentTestRule
, AssessmentTestRuleArgs

Category string: Rule category.
Cloudbots string: Rule cloudbots.
ComplianceTag string: Compliance tag.
ControlTitle string: Control title.
Description string: Description of the request.
Domain string: Rule domain.
IsDefault bool: Is default rule.
Labels List<string>: Rule labels.
Logic string: Rule logic.
LogicHash string: Rule logic hash.
Name string: Name of the ruleset.
Priority string: Rule priority.
Remediation string: Rule remediation.
RuleId string: Rule id.
Severity string: Rule severity.

Category string: Rule category.
Cloudbots string: Rule cloudbots.
ComplianceTag string: Compliance tag.
ControlTitle string: Control title.
Description string: Description of the request.
Domain string: Rule domain.
IsDefault bool: Is default rule.
Labels []string: Rule labels.
Logic string: Rule logic.
LogicHash string: Rule logic hash.
Name string: Name of the ruleset.
Priority string: Rule priority.
Remediation string: Rule remediation.
RuleId string: Rule id.
Severity string: Rule severity.

category String: Rule category.
cloudbots String: Rule cloudbots.
complianceTag String: Compliance tag.
controlTitle String: Control title.
description String: Description of the request.
domain String: Rule domain.
isDefault Boolean: Is default rule.
labels List<String>: Rule labels.
logic String: Rule logic.
logicHash String: Rule logic hash.
name String: Name of the ruleset.
priority String: Rule priority.
remediation String: Rule remediation.
ruleId String: Rule id.
severity String: Rule severity.

category string: Rule category.
cloudbots string: Rule cloudbots.
complianceTag string: Compliance tag.
controlTitle string: Control title.
description string: Description of the request.
domain string: Rule domain.
isDefault boolean: Is default rule.
labels string[]: Rule labels.
logic string: Rule logic.
logicHash string: Rule logic hash.
name string: Name of the ruleset.
priority string: Rule priority.
remediation string: Rule remediation.
ruleId string: Rule id.
severity string: Rule severity.

category str: Rule category.
cloudbots str: Rule cloudbots.
compliance_tag str: Compliance tag.
control_title str: Control title.
description str: Description of the request.
domain str: Rule domain.
is_default bool: Is default rule.
labels Sequence[str]: Rule labels.
logic str: Rule logic.
logic_hash str: Rule logic hash.
name str: Name of the ruleset.
priority str: Rule priority.
remediation str: Rule remediation.
rule_id str: Rule id.
severity str: Rule severity.

category String: Rule category.
cloudbots String: Rule cloudbots.
complianceTag String: Compliance tag.
controlTitle String: Control title.
description String: Description of the request.
domain String: Rule domain.
isDefault Boolean: Is default rule.
labels List<String>: Rule labels.
logic String: Rule logic.
logicHash String: Rule logic hash.
name String: Name of the ruleset.
priority String: Rule priority.
remediation String: Rule remediation.
ruleId String: Rule id.
severity String: Rule severity.

Package Details

Repository: dome9 dome9/terraform-provider-dome9
License
Notes: This Pulumi package is based on the dome9 Terraform Provider.

dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9

dome9/terraform-provider-dome9

dome9.Assessment

On this page

On this page

Example Usage

Create Assessment Resource

Constructor syntax

Parameters

Constructor example

Assessment Resource Properties

Inputs

Outputs

Look up Existing Assessment Resource

Supporting Types

AssessmentDataSyncStatus
, AssessmentDataSyncStatusArgs

AssessmentDataSyncStatusEntitiesWithPermissionIssue
, AssessmentDataSyncStatusEntitiesWithPermissionIssueArgs

AssessmentExclusion
, AssessmentExclusionArgs

AssessmentExclusionDateRange
, AssessmentExclusionDateRangeArgs

AssessmentExclusionRule
, AssessmentExclusionRuleArgs

AssessmentRemediation
, AssessmentRemediationArgs

AssessmentRemediationDateRange
, AssessmentRemediationDateRangeArgs

AssessmentRemediationRule
, AssessmentRemediationRuleArgs

AssessmentRequest
, AssessmentRequestArgs

AssessmentStat
, AssessmentStatArgs

AssessmentStatExcludedRulesBySeverity
, AssessmentStatExcludedRulesBySeverityArgs

AssessmentStatFailedRulesBySeverity
, AssessmentStatFailedRulesBySeverityArgs

AssessmentStatPassedRulesBySeverity
, AssessmentStatPassedRulesBySeverityArgs

AssessmentTest
, AssessmentTestArgs

AssessmentTestEntityResult
, AssessmentTestEntityResultArgs

AssessmentTestEntityResultTestObj
, AssessmentTestEntityResultTestObjArgs

AssessmentTestExclusionStat
, AssessmentTestExclusionStatArgs

AssessmentTestRule
, AssessmentTestRuleArgs

Package Details

On this page

On this page

dome9.Assessment

On this page

On this page

Example Usage

Create Assessment Resource

Constructor syntax

Parameters

Constructor example

Assessment Resource Properties

Inputs

Outputs

Look up Existing Assessment Resource

Supporting Types

AssessmentDataSyncStatus, AssessmentDataSyncStatusArgs

AssessmentDataSyncStatusEntitiesWithPermissionIssue, AssessmentDataSyncStatusEntitiesWithPermissionIssueArgs

AssessmentExclusion, AssessmentExclusionArgs

AssessmentExclusionDateRange, AssessmentExclusionDateRangeArgs

AssessmentExclusionRule, AssessmentExclusionRuleArgs

AssessmentRemediation, AssessmentRemediationArgs

AssessmentRemediationDateRange, AssessmentRemediationDateRangeArgs

AssessmentRemediationRule, AssessmentRemediationRuleArgs

AssessmentRequest, AssessmentRequestArgs

AssessmentStat, AssessmentStatArgs

AssessmentStatExcludedRulesBySeverity, AssessmentStatExcludedRulesBySeverityArgs

AssessmentStatFailedRulesBySeverity, AssessmentStatFailedRulesBySeverityArgs

AssessmentStatPassedRulesBySeverity, AssessmentStatPassedRulesBySeverityArgs

AssessmentTest, AssessmentTestArgs

AssessmentTestEntityResult, AssessmentTestEntityResultArgs

AssessmentTestEntityResultTestObj, AssessmentTestEntityResultTestObjArgs

AssessmentTestExclusionStat, AssessmentTestExclusionStatArgs

AssessmentTestRule, AssessmentTestRuleArgs

Package Details

On this page

On this page

AssessmentDataSyncStatus
, AssessmentDataSyncStatusArgs

AssessmentDataSyncStatusEntitiesWithPermissionIssue
, AssessmentDataSyncStatusEntitiesWithPermissionIssueArgs

AssessmentExclusion
, AssessmentExclusionArgs

AssessmentExclusionDateRange
, AssessmentExclusionDateRangeArgs

AssessmentExclusionRule
, AssessmentExclusionRuleArgs

AssessmentRemediation
, AssessmentRemediationArgs

AssessmentRemediationDateRange
, AssessmentRemediationDateRangeArgs

AssessmentRemediationRule
, AssessmentRemediationRuleArgs

AssessmentRequest
, AssessmentRequestArgs

AssessmentStat
, AssessmentStatArgs

AssessmentStatExcludedRulesBySeverity
, AssessmentStatExcludedRulesBySeverityArgs

AssessmentStatFailedRulesBySeverity
, AssessmentStatFailedRulesBySeverityArgs

AssessmentStatPassedRulesBySeverity
, AssessmentStatPassedRulesBySeverityArgs

AssessmentTest
, AssessmentTestArgs

AssessmentTestEntityResult
, AssessmentTestEntityResultArgs

AssessmentTestEntityResultTestObj
, AssessmentTestEntityResultTestObjArgs

AssessmentTestExclusionStat
, AssessmentTestExclusionStatArgs

AssessmentTestRule
, AssessmentTestRuleArgs