pulumi-oci 3.5.0a1756363728__py3-none-any.whl → 3.6.0__py3-none-any.whl

pulumi_oci/datasafe/get_security_assessment_template_analytics.py

@@ -0,0 +1,362 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from . import outputs
+from ._inputs import *
+
+__all__ = [
+    'GetSecurityAssessmentTemplateAnalyticsResult',
+    'AwaitableGetSecurityAssessmentTemplateAnalyticsResult',
+    'get_security_assessment_template_analytics',
+    'get_security_assessment_template_analytics_output',
+]
+
+@pulumi.output_type
+class GetSecurityAssessmentTemplateAnalyticsResult:
+    """
+    A collection of values returned by getSecurityAssessmentTemplateAnalytics.
+    """
+    def __init__(__self__, access_level=None, compartment_id=None, compartment_id_in_subtree=None, filters=None, id=None, is_compared=None, is_compliant=None, is_group=None, target_database_group_id=None, target_id=None, template_analytics_collections=None, template_assessment_id=None, template_baseline_assessment_id=None):
+        if access_level and not isinstance(access_level, str):
+            raise TypeError("Expected argument 'access_level' to be a str")
+        pulumi.set(__self__, "access_level", access_level)
+        if compartment_id and not isinstance(compartment_id, str):
+            raise TypeError("Expected argument 'compartment_id' to be a str")
+        pulumi.set(__self__, "compartment_id", compartment_id)
+        if compartment_id_in_subtree and not isinstance(compartment_id_in_subtree, bool):
+            raise TypeError("Expected argument 'compartment_id_in_subtree' to be a bool")
+        pulumi.set(__self__, "compartment_id_in_subtree", compartment_id_in_subtree)
+        if filters and not isinstance(filters, list):
+            raise TypeError("Expected argument 'filters' to be a list")
+        pulumi.set(__self__, "filters", filters)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if is_compared and not isinstance(is_compared, bool):
+            raise TypeError("Expected argument 'is_compared' to be a bool")
+        pulumi.set(__self__, "is_compared", is_compared)
+        if is_compliant and not isinstance(is_compliant, bool):
+            raise TypeError("Expected argument 'is_compliant' to be a bool")
+        pulumi.set(__self__, "is_compliant", is_compliant)
+        if is_group and not isinstance(is_group, bool):
+            raise TypeError("Expected argument 'is_group' to be a bool")
+        pulumi.set(__self__, "is_group", is_group)
+        if target_database_group_id and not isinstance(target_database_group_id, str):
+            raise TypeError("Expected argument 'target_database_group_id' to be a str")
+        pulumi.set(__self__, "target_database_group_id", target_database_group_id)
+        if target_id and not isinstance(target_id, str):
+            raise TypeError("Expected argument 'target_id' to be a str")
+        pulumi.set(__self__, "target_id", target_id)
+        if template_analytics_collections and not isinstance(template_analytics_collections, list):
+            raise TypeError("Expected argument 'template_analytics_collections' to be a list")
+        pulumi.set(__self__, "template_analytics_collections", template_analytics_collections)
+        if template_assessment_id and not isinstance(template_assessment_id, str):
+            raise TypeError("Expected argument 'template_assessment_id' to be a str")
+        pulumi.set(__self__, "template_assessment_id", template_assessment_id)
+        if template_baseline_assessment_id and not isinstance(template_baseline_assessment_id, str):
+            raise TypeError("Expected argument 'template_baseline_assessment_id' to be a str")
+        pulumi.set(__self__, "template_baseline_assessment_id", template_baseline_assessment_id)
+
+    @_builtins.property
+    @pulumi.getter(name="accessLevel")
+    def access_level(self) -> Optional[_builtins.str]:
+        return pulumi.get(self, "access_level")
+
+    @_builtins.property
+    @pulumi.getter(name="compartmentId")
+    def compartment_id(self) -> _builtins.str:
+        return pulumi.get(self, "compartment_id")
+
+    @_builtins.property
+    @pulumi.getter(name="compartmentIdInSubtree")
+    def compartment_id_in_subtree(self) -> Optional[_builtins.bool]:
+        return pulumi.get(self, "compartment_id_in_subtree")
+
+    @_builtins.property
+    @pulumi.getter
+    def filters(self) -> Optional[Sequence['outputs.GetSecurityAssessmentTemplateAnalyticsFilterResult']]:
+        return pulumi.get(self, "filters")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter(name="isCompared")
+    def is_compared(self) -> Optional[_builtins.bool]:
+        """
+        Indicates whether or not the comparison between the latest assessment and the template baseline assessment is done. If the value is false, it means the comparison is not done yet.
+        """
+        return pulumi.get(self, "is_compared")
+
+    @_builtins.property
+    @pulumi.getter(name="isCompliant")
+    def is_compliant(self) -> Optional[_builtins.bool]:
+        """
+        Indicates whether or not the latest assessment is compliant with the template baseline assessment. If the value is false, it means there is drift in the comparison report and the totalChecksFailed field will have a non-zero value.
+        """
+        return pulumi.get(self, "is_compliant")
+
+    @_builtins.property
+    @pulumi.getter(name="isGroup")
+    def is_group(self) -> Optional[_builtins.bool]:
+        """
+        Indicates whether or not the template security assessment is applied to a target group.  If the value is false, it means the template security assessment is applied to a individual target.
+        """
+        return pulumi.get(self, "is_group")
+
+    @_builtins.property
+    @pulumi.getter(name="targetDatabaseGroupId")
+    def target_database_group_id(self) -> Optional[_builtins.str]:
+        """
+        The OCID of the target database group that the group assessment is created for.  This field will be in the response if the template was applied on a target group.
+        """
+        return pulumi.get(self, "target_database_group_id")
+
+    @_builtins.property
+    @pulumi.getter(name="targetId")
+    def target_id(self) -> Optional[_builtins.str]:
+        """
+        The OCID of the target database. This field will be in the response if the template was applied on an individual target.
+        """
+        return pulumi.get(self, "target_id")
+
+    @_builtins.property
+    @pulumi.getter(name="templateAnalyticsCollections")
+    def template_analytics_collections(self) -> Sequence['outputs.GetSecurityAssessmentTemplateAnalyticsTemplateAnalyticsCollectionResult']:
+        """
+        The list of template_analytics_collection.
+        """
+        return pulumi.get(self, "template_analytics_collections")
+
+    @_builtins.property
+    @pulumi.getter(name="templateAssessmentId")
+    def template_assessment_id(self) -> Optional[_builtins.str]:
+        """
+        The OCID of the security assessment of type TEMPLATE.
+        """
+        return pulumi.get(self, "template_assessment_id")
+
+    @_builtins.property
+    @pulumi.getter(name="templateBaselineAssessmentId")
+    def template_baseline_assessment_id(self) -> Optional[_builtins.str]:
+        """
+        The OCID of the security assessment of type TEMPLATE_BASELINE.
+        """
+        return pulumi.get(self, "template_baseline_assessment_id")
+
+
+class AwaitableGetSecurityAssessmentTemplateAnalyticsResult(GetSecurityAssessmentTemplateAnalyticsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetSecurityAssessmentTemplateAnalyticsResult(
+            access_level=self.access_level,
+            compartment_id=self.compartment_id,
+            compartment_id_in_subtree=self.compartment_id_in_subtree,
+            filters=self.filters,
+            id=self.id,
+            is_compared=self.is_compared,
+            is_compliant=self.is_compliant,
+            is_group=self.is_group,
+            target_database_group_id=self.target_database_group_id,
+            target_id=self.target_id,
+            template_analytics_collections=self.template_analytics_collections,
+            template_assessment_id=self.template_assessment_id,
+            template_baseline_assessment_id=self.template_baseline_assessment_id)
+
+
+def get_security_assessment_template_analytics(access_level: Optional[_builtins.str] = None,
+                                               compartment_id: Optional[_builtins.str] = None,
+                                               compartment_id_in_subtree: Optional[_builtins.bool] = None,
+                                               filters: Optional[Sequence[Union['GetSecurityAssessmentTemplateAnalyticsFilterArgs', 'GetSecurityAssessmentTemplateAnalyticsFilterArgsDict']]] = None,
+                                               is_compared: Optional[_builtins.bool] = None,
+                                               is_compliant: Optional[_builtins.bool] = None,
+                                               is_group: Optional[_builtins.bool] = None,
+                                               target_database_group_id: Optional[_builtins.str] = None,
+                                               target_id: Optional[_builtins.str] = None,
+                                               template_assessment_id: Optional[_builtins.str] = None,
+                                               template_baseline_assessment_id: Optional[_builtins.str] = None,
+                                               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSecurityAssessmentTemplateAnalyticsResult:
+    """
+    This data source provides the list of Security Assessment Template Analytics in Oracle Cloud Infrastructure Data Safe service.
+
+    Gets a list of template aggregated details in the specified compartment. This provides information about the
+    overall template usage, by returning the count of the target databases/target groups using the templates. It also provides information
+    about the statistics for the template baseline and the comparison related. If the comparison is done, it will show if there is any drift,
+    and how many checks have drifts.
+    The dimension field - isGroup identifies if the targetId belongs to a target group or a individual target.
+    The dimension field - isCompared identifies if the comparison between the latest assessment and the template baseline assessment is done or not.
+    The dimension field - isCompliant identifies if the latest assessment is compliant with the template baseline assessment or not.
+    The dimension field - totalChecksFailed identifies how many checks in the template have drifts in the comparison.
+
+    When you perform the ListTemplateAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the
+    parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT
+    permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the
+    root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by
+    compartmentId, then "Not Authorized" is returned.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_security_assessment_template_analytics = oci.DataSafe.get_security_assessment_template_analytics(compartment_id=compartment_id,
+        access_level=security_assessment_template_analytic_access_level,
+        compartment_id_in_subtree=security_assessment_template_analytic_compartment_id_in_subtree,
+        is_compared=security_assessment_template_analytic_is_compared,
+        is_compliant=security_assessment_template_analytic_is_compliant,
+        is_group=security_assessment_template_analytic_is_group,
+        target_database_group_id=test_target_database_group["id"],
+        target_id=test_target["id"],
+        template_assessment_id=test_template_assessment["id"],
+        template_baseline_assessment_id=test_template_baseline_assessment["id"])
+    ```
+
+
+    :param _builtins.str access_level: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
+    :param _builtins.str compartment_id: A filter to return only resources that match the specified compartment OCID.
+    :param _builtins.bool compartment_id_in_subtree: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
+    :param _builtins.bool is_compared: A filter to return only the statistics where the comparison between the latest assessment and the template baseline assessment is done.
+    :param _builtins.bool is_compliant: A filter to return only the statistics where the latest assessment is compliant with the template baseline assessment.
+    :param _builtins.bool is_group: A filter to return only the target group related information if the OCID belongs to a target group.
+    :param _builtins.str target_database_group_id: A filter to return the target database group that matches the specified OCID.
+    :param _builtins.str target_id: A filter to return only items related to a specific target OCID.
+    :param _builtins.str template_assessment_id: The OCID of the security assessment of type TEMPLATE.
+    :param _builtins.str template_baseline_assessment_id: The OCID of the security assessment of type TEMPLATE_BASELINE.
+    """
+    __args__ = dict()
+    __args__['accessLevel'] = access_level
+    __args__['compartmentId'] = compartment_id
+    __args__['compartmentIdInSubtree'] = compartment_id_in_subtree
+    __args__['filters'] = filters
+    __args__['isCompared'] = is_compared
+    __args__['isCompliant'] = is_compliant
+    __args__['isGroup'] = is_group
+    __args__['targetDatabaseGroupId'] = target_database_group_id
+    __args__['targetId'] = target_id
+    __args__['templateAssessmentId'] = template_assessment_id
+    __args__['templateBaselineAssessmentId'] = template_baseline_assessment_id
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('oci:DataSafe/getSecurityAssessmentTemplateAnalytics:getSecurityAssessmentTemplateAnalytics', __args__, opts=opts, typ=GetSecurityAssessmentTemplateAnalyticsResult).value
+
+    return AwaitableGetSecurityAssessmentTemplateAnalyticsResult(
+        access_level=pulumi.get(__ret__, 'access_level'),
+        compartment_id=pulumi.get(__ret__, 'compartment_id'),
+        compartment_id_in_subtree=pulumi.get(__ret__, 'compartment_id_in_subtree'),
+        filters=pulumi.get(__ret__, 'filters'),
+        id=pulumi.get(__ret__, 'id'),
+        is_compared=pulumi.get(__ret__, 'is_compared'),
+        is_compliant=pulumi.get(__ret__, 'is_compliant'),
+        is_group=pulumi.get(__ret__, 'is_group'),
+        target_database_group_id=pulumi.get(__ret__, 'target_database_group_id'),
+        target_id=pulumi.get(__ret__, 'target_id'),
+        template_analytics_collections=pulumi.get(__ret__, 'template_analytics_collections'),
+        template_assessment_id=pulumi.get(__ret__, 'template_assessment_id'),
+        template_baseline_assessment_id=pulumi.get(__ret__, 'template_baseline_assessment_id'))
+def get_security_assessment_template_analytics_output(access_level: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                                      compartment_id: Optional[pulumi.Input[_builtins.str]] = None,
+                                                      compartment_id_in_subtree: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                                                      filters: Optional[pulumi.Input[Optional[Sequence[Union['GetSecurityAssessmentTemplateAnalyticsFilterArgs', 'GetSecurityAssessmentTemplateAnalyticsFilterArgsDict']]]]] = None,
+                                                      is_compared: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                                                      is_compliant: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                                                      is_group: Optional[pulumi.Input[Optional[_builtins.bool]]] = None,
+                                                      target_database_group_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                                      target_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                                      template_assessment_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                                      template_baseline_assessment_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetSecurityAssessmentTemplateAnalyticsResult]:
+    """
+    This data source provides the list of Security Assessment Template Analytics in Oracle Cloud Infrastructure Data Safe service.
+
+    Gets a list of template aggregated details in the specified compartment. This provides information about the
+    overall template usage, by returning the count of the target databases/target groups using the templates. It also provides information
+    about the statistics for the template baseline and the comparison related. If the comparison is done, it will show if there is any drift,
+    and how many checks have drifts.
+    The dimension field - isGroup identifies if the targetId belongs to a target group or a individual target.
+    The dimension field - isCompared identifies if the comparison between the latest assessment and the template baseline assessment is done or not.
+    The dimension field - isCompliant identifies if the latest assessment is compliant with the template baseline assessment or not.
+    The dimension field - totalChecksFailed identifies how many checks in the template have drifts in the comparison.
+
+    When you perform the ListTemplateAnalytics operation, if the parameter compartmentIdInSubtree is set to "true," and if the
+    parameter accessLevel is set to ACCESSIBLE, then the operation returns statistics from the compartments in which the requestor has INSPECT
+    permissions on at least one resource, directly or indirectly (in subcompartments). If the operation is performed at the
+    root compartment and the requestor does not have access to at least one subcompartment of the compartment specified by
+    compartmentId, then "Not Authorized" is returned.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_oci as oci
+
+    test_security_assessment_template_analytics = oci.DataSafe.get_security_assessment_template_analytics(compartment_id=compartment_id,
+        access_level=security_assessment_template_analytic_access_level,
+        compartment_id_in_subtree=security_assessment_template_analytic_compartment_id_in_subtree,
+        is_compared=security_assessment_template_analytic_is_compared,
+        is_compliant=security_assessment_template_analytic_is_compliant,
+        is_group=security_assessment_template_analytic_is_group,
+        target_database_group_id=test_target_database_group["id"],
+        target_id=test_target["id"],
+        template_assessment_id=test_template_assessment["id"],
+        template_baseline_assessment_id=test_template_baseline_assessment["id"])
+    ```
+
+
+    :param _builtins.str access_level: Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
+    :param _builtins.str compartment_id: A filter to return only resources that match the specified compartment OCID.
+    :param _builtins.bool compartment_id_in_subtree: Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
+    :param _builtins.bool is_compared: A filter to return only the statistics where the comparison between the latest assessment and the template baseline assessment is done.
+    :param _builtins.bool is_compliant: A filter to return only the statistics where the latest assessment is compliant with the template baseline assessment.
+    :param _builtins.bool is_group: A filter to return only the target group related information if the OCID belongs to a target group.
+    :param _builtins.str target_database_group_id: A filter to return the target database group that matches the specified OCID.
+    :param _builtins.str target_id: A filter to return only items related to a specific target OCID.
+    :param _builtins.str template_assessment_id: The OCID of the security assessment of type TEMPLATE.
+    :param _builtins.str template_baseline_assessment_id: The OCID of the security assessment of type TEMPLATE_BASELINE.
+    """
+    __args__ = dict()
+    __args__['accessLevel'] = access_level
+    __args__['compartmentId'] = compartment_id
+    __args__['compartmentIdInSubtree'] = compartment_id_in_subtree
+    __args__['filters'] = filters
+    __args__['isCompared'] = is_compared
+    __args__['isCompliant'] = is_compliant
+    __args__['isGroup'] = is_group
+    __args__['targetDatabaseGroupId'] = target_database_group_id
+    __args__['targetId'] = target_id
+    __args__['templateAssessmentId'] = template_assessment_id
+    __args__['templateBaselineAssessmentId'] = template_baseline_assessment_id
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('oci:DataSafe/getSecurityAssessmentTemplateAnalytics:getSecurityAssessmentTemplateAnalytics', __args__, opts=opts, typ=GetSecurityAssessmentTemplateAnalyticsResult)
+    return __ret__.apply(lambda __response__: GetSecurityAssessmentTemplateAnalyticsResult(
+        access_level=pulumi.get(__response__, 'access_level'),
+        compartment_id=pulumi.get(__response__, 'compartment_id'),
+        compartment_id_in_subtree=pulumi.get(__response__, 'compartment_id_in_subtree'),
+        filters=pulumi.get(__response__, 'filters'),
+        id=pulumi.get(__response__, 'id'),
+        is_compared=pulumi.get(__response__, 'is_compared'),
+        is_compliant=pulumi.get(__response__, 'is_compliant'),
+        is_group=pulumi.get(__response__, 'is_group'),
+        target_database_group_id=pulumi.get(__response__, 'target_database_group_id'),
+        target_id=pulumi.get(__response__, 'target_id'),
+        template_analytics_collections=pulumi.get(__response__, 'template_analytics_collections'),
+        template_assessment_id=pulumi.get(__response__, 'template_assessment_id'),
+        template_baseline_assessment_id=pulumi.get(__response__, 'template_baseline_assessment_id')))