CreateSecurityAssessmentDetails¶

class oci.data_safe.models.CreateSecurityAssessmentDetails(**kwargs)¶

Bases: object

The details used to save a security assessment.

Methods

__init__(**kwargs) Initializes a new CreateSecurityAssessmentDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateSecurityAssessmentDetails.
`defined_tags`	Gets the defined_tags of this CreateSecurityAssessmentDetails.
`description`	Gets the description of this CreateSecurityAssessmentDetails.
`display_name`	Gets the display_name of this CreateSecurityAssessmentDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSecurityAssessmentDetails.
`is_assessment_scheduled`	Gets the is_assessment_scheduled of this CreateSecurityAssessmentDetails.
`schedule`	Gets the schedule of this CreateSecurityAssessmentDetails.
`target_id`	[Required] Gets the target_id of this CreateSecurityAssessmentDetails.

__init__(**kwargs)¶

Initializes a new CreateSecurityAssessmentDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateSecurityAssessmentDetails.
display_name (str) – The value to assign to the display_name property of this CreateSecurityAssessmentDetails.
description (str) – The value to assign to the description property of this CreateSecurityAssessmentDetails.
target_id (str) – The value to assign to the target_id property of this CreateSecurityAssessmentDetails.
is_assessment_scheduled (bool) – The value to assign to the is_assessment_scheduled property of this CreateSecurityAssessmentDetails.
schedule (str) – The value to assign to the schedule property of this CreateSecurityAssessmentDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSecurityAssessmentDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSecurityAssessmentDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateSecurityAssessmentDetails. The OCID of the compartment that contains the security assessment.

Returns:	The compartment_id of this CreateSecurityAssessmentDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateSecurityAssessmentDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this CreateSecurityAssessmentDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateSecurityAssessmentDetails. Description of the security assessment.

Returns:	The description of this CreateSecurityAssessmentDetails.
Return type:	str

display_name¶

Gets the display_name of this CreateSecurityAssessmentDetails. The display name of the security assessment.

Returns:	The display_name of this CreateSecurityAssessmentDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateSecurityAssessmentDetails. 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

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this CreateSecurityAssessmentDetails.
Return type:	dict(str, str)

is_assessment_scheduled¶

Gets the is_assessment_scheduled of this CreateSecurityAssessmentDetails. Indicates whether the assessment is scheduled to run.

Returns:	The is_assessment_scheduled of this CreateSecurityAssessmentDetails.
Return type:	bool

schedule¶

Gets the schedule of this CreateSecurityAssessmentDetails. To schedule the assessment for running periodically, specify the schedule in this attribute. Create or schedule one assessment per compartment. If not defined, the assessment runs immediately. Format - <version-string>;<version-specific-schedule>

Allowed version strings - “v1” v1’s version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) <day-of-week> 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 <day-of-month> 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

Returns:	The schedule of this CreateSecurityAssessmentDetails.
Return type:	str

target_id¶

[Required] Gets the target_id of this CreateSecurityAssessmentDetails. The OCID of the target database on which security assessment is to be run.

Returns:	The target_id of this CreateSecurityAssessmentDetails.
Return type:	str