CryptoAssessment¶
- class oci.data_safe.models.CryptoAssessment(**kwargs)¶
Bases:
objectA crypto assessment that provides insight into database cryptographic posture. The assessment evaluates data and network encryption, certificates, key management, backups, and quantum-readiness settings for a target database.
Attributes:
A constant which can be used with the lifecycle_state property of a CryptoAssessment.
A constant which can be used with the lifecycle_state property of a CryptoAssessment.
A constant which can be used with the lifecycle_state property of a CryptoAssessment.
A constant which can be used with the lifecycle_state property of a CryptoAssessment.
A constant which can be used with the lifecycle_state property of a CryptoAssessment.
A constant which can be used with the lifecycle_state property of a CryptoAssessment.
A constant which can be used with the posture_category property of a CryptoAssessment.
A constant which can be used with the posture_category property of a CryptoAssessment.
A constant which can be used with the posture_category property of a CryptoAssessment.
A constant which can be used with the target_type property of a CryptoAssessment.
A constant which can be used with the target_type property of a CryptoAssessment.
A constant which can be used with the triggered_by property of a CryptoAssessment.
A constant which can be used with the triggered_by property of a CryptoAssessment.
A constant which can be used with the type property of a CryptoAssessment.
A constant which can be used with the type property of a CryptoAssessment.
[Required] Gets the compartment_id of this CryptoAssessment.
Gets the crypto_posture of this CryptoAssessment.
Gets the crypto_provider of this CryptoAssessment.
Gets the database_architecture of this CryptoAssessment.
Gets the database_name of this CryptoAssessment.
Gets the database_version of this CryptoAssessment.
Gets the defined_tags of this CryptoAssessment.
Gets the description of this CryptoAssessment.
Gets the display_name of this CryptoAssessment.
Gets the freeform_tags of this CryptoAssessment.
[Required] Gets the id of this CryptoAssessment.
Gets the is_assessment_scheduled of this CryptoAssessment.
Gets the issue_count of this CryptoAssessment.
Gets the lifecycle_details of this CryptoAssessment.
[Required] Gets the lifecycle_state of this CryptoAssessment.
Gets the posture_category of this CryptoAssessment.
Gets the schedule of this CryptoAssessment.
Gets the system_tags of this CryptoAssessment.
Gets the target_database_group_id of this CryptoAssessment.
Gets the target_id of this CryptoAssessment.
[Required] Gets the target_type of this CryptoAssessment.
Gets the targets_with_issues_count of this CryptoAssessment.
[Required] Gets the time_created of this CryptoAssessment.
Gets the time_last_assessed of this CryptoAssessment.
[Required] Gets the time_updated of this CryptoAssessment.
Gets the triggered_by of this CryptoAssessment.
[Required] Gets the type of this CryptoAssessment.
Methods:
__init__(**kwargs)Initializes a new CryptoAssessment object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a CryptoAssessment. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a CryptoAssessment. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a CryptoAssessment. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a CryptoAssessment. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a CryptoAssessment. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a CryptoAssessment. This constant has a value of “UPDATING”
- POSTURE_CATEGORY_QUANTUM_CAPABLE = 'QUANTUM_CAPABLE'¶
A constant which can be used with the posture_category property of a CryptoAssessment. This constant has a value of “QUANTUM_CAPABLE”
- POSTURE_CATEGORY_QUANTUM_RESISTANT = 'QUANTUM_RESISTANT'¶
A constant which can be used with the posture_category property of a CryptoAssessment. This constant has a value of “QUANTUM_RESISTANT”
- POSTURE_CATEGORY_UPGRADE_RECOMMENDED = 'UPGRADE_RECOMMENDED'¶
A constant which can be used with the posture_category property of a CryptoAssessment. This constant has a value of “UPGRADE_RECOMMENDED”
- TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'¶
A constant which can be used with the target_type property of a CryptoAssessment. This constant has a value of “TARGET_DATABASE”
- TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'¶
A constant which can be used with the target_type property of a CryptoAssessment. This constant has a value of “TARGET_DATABASE_GROUP”
- TRIGGERED_BY_SYSTEM = 'SYSTEM'¶
A constant which can be used with the triggered_by property of a CryptoAssessment. This constant has a value of “SYSTEM”
- TRIGGERED_BY_USER = 'USER'¶
A constant which can be used with the triggered_by property of a CryptoAssessment. This constant has a value of “USER”
- TYPE_LATEST = 'LATEST'¶
A constant which can be used with the type property of a CryptoAssessment. This constant has a value of “LATEST”
- TYPE_SAVED = 'SAVED'¶
A constant which can be used with the type property of a CryptoAssessment. This constant has a value of “SAVED”
- __init__(**kwargs)¶
Initializes a new CryptoAssessment object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this CryptoAssessment.
display_name (str) – The value to assign to the display_name property of this CryptoAssessment.
description (str) – The value to assign to the description property of this CryptoAssessment.
compartment_id (str) – The value to assign to the compartment_id property of this CryptoAssessment.
time_created (datetime) – The value to assign to the time_created property of this CryptoAssessment.
time_updated (datetime) – The value to assign to the time_updated property of this CryptoAssessment.
time_last_assessed (datetime) – The value to assign to the time_last_assessed property of this CryptoAssessment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CryptoAssessment. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CryptoAssessment.
type (str) – The value to assign to the type property of this CryptoAssessment. Allowed values for this property are: “LATEST”, “SAVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
triggered_by (str) – The value to assign to the triggered_by property of this CryptoAssessment. Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
target_type (str) – The value to assign to the target_type property of this CryptoAssessment. Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
target_id (str) – The value to assign to the target_id property of this CryptoAssessment.
target_database_group_id (str) – The value to assign to the target_database_group_id property of this CryptoAssessment.
database_version (str) – The value to assign to the database_version property of this CryptoAssessment.
database_name (str) – The value to assign to the database_name property of this CryptoAssessment.
database_architecture (str) – The value to assign to the database_architecture property of this CryptoAssessment.
crypto_provider (str) – The value to assign to the crypto_provider property of this CryptoAssessment.
posture_category (str) – The value to assign to the posture_category property of this CryptoAssessment. Allowed values for this property are: “QUANTUM_RESISTANT”, “QUANTUM_CAPABLE”, “UPGRADE_RECOMMENDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
schedule (str) – The value to assign to the schedule property of this CryptoAssessment.
crypto_posture (oci.data_safe.models.CryptoPosture) – The value to assign to the crypto_posture property of this CryptoAssessment.
issue_count (int) – The value to assign to the issue_count property of this CryptoAssessment.
targets_with_issues_count (int) – The value to assign to the targets_with_issues_count property of this CryptoAssessment.
is_assessment_scheduled (bool) – The value to assign to the is_assessment_scheduled property of this CryptoAssessment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CryptoAssessment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CryptoAssessment.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CryptoAssessment.
- property compartment_id¶
[Required] Gets the compartment_id of this CryptoAssessment. The OCID of the compartment that contains the crypto assessment.
- Returns
The compartment_id of this CryptoAssessment.
- Return type
str
- property crypto_posture¶
Gets the crypto_posture of this CryptoAssessment.
- Returns
The crypto_posture of this CryptoAssessment.
- Return type
- property crypto_provider¶
Gets the crypto_provider of this CryptoAssessment. Cryptographic provider and version information observed on the target.
- Returns
The crypto_provider of this CryptoAssessment.
- Return type
str
- property database_architecture¶
Gets the database_architecture of this CryptoAssessment. The architecture of the assessed target database.
- Returns
The database_architecture of this CryptoAssessment.
- Return type
str
- property database_name¶
Gets the database_name of this CryptoAssessment. The name of the assessed target database.
- Returns
The database_name of this CryptoAssessment.
- Return type
str
- property database_version¶
Gets the database_version of this CryptoAssessment. The version of the assessed target database.
- Returns
The database_version of this CryptoAssessment.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CryptoAssessment. 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 CryptoAssessment.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CryptoAssessment. The description of the crypto assessment.
- Returns
The description of this CryptoAssessment.
- Return type
str
- property display_name¶
Gets the display_name of this CryptoAssessment. The display name of the crypto assessment.
- Returns
The display_name of this CryptoAssessment.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CryptoAssessment. 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 CryptoAssessment.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this CryptoAssessment. The OCID of the crypto assessment.
- Returns
The id of this CryptoAssessment.
- Return type
str
- property is_assessment_scheduled¶
Gets the is_assessment_scheduled of this CryptoAssessment. Indicates whether scheduled execution is active for this crypto assessment. When false, the schedule value is retained but scheduled execution is paused.
- Returns
The is_assessment_scheduled of this CryptoAssessment.
- Return type
bool
- property issue_count¶
Gets the issue_count of this CryptoAssessment. Number of crypto issues detected in this assessment.
- Returns
The issue_count of this CryptoAssessment.
- Return type
int
- property lifecycle_details¶
Gets the lifecycle_details of this CryptoAssessment. Details about the current lifecycle state of the crypto assessment.
- Returns
The lifecycle_details of this CryptoAssessment.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this CryptoAssessment. The current lifecycle state of the crypto assessment.
Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this CryptoAssessment.
- Return type
str
- property posture_category¶
Gets the posture_category of this CryptoAssessment. Overall posture category for the crypto assessment.
Allowed values for this property are: “QUANTUM_RESISTANT”, “QUANTUM_CAPABLE”, “UPGRADE_RECOMMENDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The posture_category of this CryptoAssessment.
- Return type
str
- property schedule¶
Gets the schedule of this CryptoAssessment. The schedule used to run the crypto assessment periodically. The schedule uses the format: <version-string>;<version-specific-schedule>
For v1, the version-specific schedule format is: <ss> <mm> <hh> <day-of-week> <day-of-month>
Specify either day-of-week for weekly schedules or day-of-month for monthly schedules. Do not specify both. For monthly schedules, day-of-month must be between 1 and 28. If the service generates a default monthly schedule for an assessment created on day 29, 30, or 31 of a month, it uses day 28.
- Returns
The schedule of this CryptoAssessment.
- Return type
str
- property system_tags¶
Gets the system_tags of this CryptoAssessment. 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”}}
- Returns
The system_tags of this CryptoAssessment.
- Return type
dict(str, dict(str, object))
- property target_database_group_id¶
Gets the target_database_group_id of this CryptoAssessment. The OCID of the target database group. This is returned when targetType is TARGET_DATABASE_GROUP.
- Returns
The target_database_group_id of this CryptoAssessment.
- Return type
str
- property target_id¶
Gets the target_id of this CryptoAssessment. The OCID of the target database.
- Returns
The target_id of this CryptoAssessment.
- Return type
str
- property target_type¶
[Required] Gets the target_type of this CryptoAssessment. The target type of the crypto assessment.
Allowed values for this property are: “TARGET_DATABASE”, “TARGET_DATABASE_GROUP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The target_type of this CryptoAssessment.
- Return type
str
- property targets_with_issues_count¶
Gets the targets_with_issues_count of this CryptoAssessment. Number of assessed targets with one or more crypto issues. For a target database assessment, this value is 1 when the target has issues and 0 otherwise. For a target database group assessment, this value is the number of targets in the group that have issues.
- Returns
The targets_with_issues_count of this CryptoAssessment.
- Return type
int
- property time_created¶
[Required] Gets the time_created of this CryptoAssessment. The date and time the crypto assessment was created, in RFC3339 format.
- Returns
The time_created of this CryptoAssessment.
- Return type
datetime
- property time_last_assessed¶
Gets the time_last_assessed of this CryptoAssessment. The date and time the crypto posture was last assessed, in RFC3339 format.
- Returns
The time_last_assessed of this CryptoAssessment.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this CryptoAssessment. The date and time the crypto assessment was last updated, in RFC3339 format.
- Returns
The time_updated of this CryptoAssessment.
- Return type
datetime
- property triggered_by¶
Gets the triggered_by of this CryptoAssessment. The actor that created the assessment.
Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The triggered_by of this CryptoAssessment.
- Return type
str
- property type¶
[Required] Gets the type of this CryptoAssessment. The type of this crypto assessment.
Allowed values for this property are: “LATEST”, “SAVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this CryptoAssessment.
- Return type
str