import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the User Assessment resource in Oracle Cloud Infrastructure Data Safe service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/data-safe/latest/UserAssessment * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/datasafe * * Creates a new saved user assessment for one or multiple targets in a compartment. It saves the latest assessments in the * specified compartment. If a scheduled is passed in, this operation persists the latest assessments that exist at the defined * date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testUserAssessment = new oci.datasafe.UserAssessment("test_user_assessment", { * compartmentId: compartmentId, * targetId: testTarget.id, * definedTags: { * "Operations.CostCenter": "42", * }, * description: userAssessmentDescription, * displayName: userAssessmentDisplayName, * freeformTags: { * Department: "Finance", * }, * isAssessmentScheduled: userAssessmentIsAssessmentScheduled === "true", * schedule: userAssessmentSchedule, * targetType: userAssessmentTargetType, * }); * ``` * * ## Import * * UserAssessments can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:DataSafe/userAssessment:UserAssessment test_user_assessment "id" * ``` */ export declare class UserAssessment extends pulumi.CustomResource { /** * Get an existing UserAssessment resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: UserAssessmentState, opts?: pulumi.CustomResourceOptions): UserAssessment; /** * Returns true if the given object is an instance of UserAssessment. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is UserAssessment; /** * (Updatable) The OCID of the compartment that contains the user assessment. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The description of the user assessment. */ readonly description: pulumi.Output; /** * (Updatable) The display name of the user assessment. */ readonly displayName: pulumi.Output; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ readonly ignoredAssessmentIds: pulumi.Output; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ readonly ignoredTargets: pulumi.Output; /** * (Updatable) Indicates whether the assessment is scheduled to run. */ readonly isAssessmentScheduled: pulumi.Output; /** * Indicates if the user assessment is set as a baseline. This is applicable only to saved user assessments. */ readonly isBaseline: pulumi.Output; /** * Indicates if the user assessment deviates from the baseline. */ readonly isDeviatedFromBaseline: pulumi.Output; /** * The OCID of the last user assessment baseline against which the latest assessment was compared. */ readonly lastComparedBaselineId: pulumi.Output; /** * Details about the current state of the user assessment. */ readonly lifecycleDetails: pulumi.Output; /** * (Updatable) To schedule the assessment for saving periodically, specify the schedule in this attribute. Create or schedule one assessment per compartment. If not defined, the assessment runs immediately. Format - ; * * Allowed version strings - "v1" v1's version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is '*'. When not, day of week must equal the given value can be either '*' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is '*'. When not, day of month must equal the given value */ readonly schedule: pulumi.Output; /** * The OCID of the user assessment that is responsible for creating this scheduled save assessment. */ readonly scheduleAssessmentId: pulumi.Output; /** * The current state of the user assessment. */ readonly state: pulumi.Output; /** * Map that contains maps of values. Example: `{"Operations": {"CostCenter": "42"}}` */ readonly statistics: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The OCID of target database group. */ readonly targetDatabaseGroupId: pulumi.Output; /** * The OCID of the target database or target database group on which user assessment is to be run. */ readonly targetId: pulumi.Output; /** * Array of database target OCIDs. */ readonly targetIds: pulumi.Output; /** * The type of user assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly targetType: pulumi.Output; /** * The date and time the user assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ readonly timeCreated: pulumi.Output; /** * The date and time the user assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ readonly timeLastAssessed: pulumi.Output; /** * The date and time the user assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ readonly timeUpdated: pulumi.Output; /** * Indicates whether the user assessment was created by the system or the user. */ readonly triggeredBy: pulumi.Output; /** * The type of the user assessment. The possible types are: */ readonly type: pulumi.Output; /** * Create a UserAssessment resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: UserAssessmentArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering UserAssessment resources. */ export interface UserAssessmentState { /** * (Updatable) The OCID of the compartment that contains the user assessment. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the user assessment. */ description?: pulumi.Input; /** * (Updatable) The display name of the user assessment. */ displayName?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ ignoredAssessmentIds?: pulumi.Input[] | undefined>; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ ignoredTargets?: pulumi.Input[] | undefined>; /** * (Updatable) Indicates whether the assessment is scheduled to run. */ isAssessmentScheduled?: pulumi.Input; /** * Indicates if the user assessment is set as a baseline. This is applicable only to saved user assessments. */ isBaseline?: pulumi.Input; /** * Indicates if the user assessment deviates from the baseline. */ isDeviatedFromBaseline?: pulumi.Input; /** * The OCID of the last user assessment baseline against which the latest assessment was compared. */ lastComparedBaselineId?: pulumi.Input; /** * Details about the current state of the user assessment. */ lifecycleDetails?: pulumi.Input; /** * (Updatable) To schedule the assessment for saving periodically, specify the schedule in this attribute. Create or schedule one assessment per compartment. If not defined, the assessment runs immediately. Format - ; * * Allowed version strings - "v1" v1's version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is '*'. When not, day of week must equal the given value can be either '*' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is '*'. When not, day of month must equal the given value */ schedule?: pulumi.Input; /** * The OCID of the user assessment that is responsible for creating this scheduled save assessment. */ scheduleAssessmentId?: pulumi.Input; /** * The current state of the user assessment. */ state?: pulumi.Input; /** * Map that contains maps of values. Example: `{"Operations": {"CostCenter": "42"}}` */ statistics?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The OCID of target database group. */ targetDatabaseGroupId?: pulumi.Input; /** * The OCID of the target database or target database group on which user assessment is to be run. */ targetId?: pulumi.Input; /** * Array of database target OCIDs. */ targetIds?: pulumi.Input[] | undefined>; /** * The type of user assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ targetType?: pulumi.Input; /** * The date and time the user assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated?: pulumi.Input; /** * The date and time the user assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastAssessed?: pulumi.Input; /** * The date and time the user assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated?: pulumi.Input; /** * Indicates whether the user assessment was created by the system or the user. */ triggeredBy?: pulumi.Input; /** * The type of the user assessment. The possible types are: */ type?: pulumi.Input; } /** * The set of arguments for constructing a UserAssessment resource. */ export interface UserAssessmentArgs { /** * (Updatable) The OCID of the compartment that contains the user assessment. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the user assessment. */ description?: pulumi.Input; /** * (Updatable) The display name of the user assessment. */ displayName?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Indicates whether the assessment is scheduled to run. */ isAssessmentScheduled?: pulumi.Input; /** * (Updatable) To schedule the assessment for saving periodically, specify the schedule in this attribute. Create or schedule one assessment per compartment. If not defined, the assessment runs immediately. Format - ; * * Allowed version strings - "v1" v1's version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is '*'. When not, day of week must equal the given value can be either '*' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is '*'. When not, day of month must equal the given value */ schedule?: pulumi.Input; /** * The OCID of the target database or target database group on which user assessment is to be run. */ targetId: pulumi.Input; /** * The type of user assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ targetType?: pulumi.Input; } //# sourceMappingURL=userAssessment.d.ts.map