1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getSecurityAssessmentSecurityFeatureAnalytics
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.DataSafe.getSecurityAssessmentSecurityFeatureAnalytics

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This data source provides the list of Security Assessment Security Feature Analytics in Oracle Cloud Infrastructure Data Safe service.

    Gets a list of Database security feature usage aggregated details in the specified compartment. This provides information about the overall security controls, by returning the counting number of the target databases using the security features.

    When you perform the ListSecurityFeatureAnalytics 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

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testSecurityAssessmentSecurityFeatureAnalytics = oci.DataSafe.getSecurityAssessmentSecurityFeatureAnalytics({
        compartmentId: compartmentId,
        accessLevel: securityAssessmentSecurityFeatureAnalyticAccessLevel,
        compartmentIdInSubtree: securityAssessmentSecurityFeatureAnalyticCompartmentIdInSubtree,
        targetId: testTarget.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_security_assessment_security_feature_analytics = oci.DataSafe.get_security_assessment_security_feature_analytics(compartment_id=compartment_id,
        access_level=security_assessment_security_feature_analytic_access_level,
        compartment_id_in_subtree=security_assessment_security_feature_analytic_compartment_id_in_subtree,
        target_id=test_target["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DataSafe"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := DataSafe.GetSecurityAssessmentSecurityFeatureAnalytics(ctx, &datasafe.GetSecurityAssessmentSecurityFeatureAnalyticsArgs{
    			CompartmentId:          compartmentId,
    			AccessLevel:            pulumi.StringRef(securityAssessmentSecurityFeatureAnalyticAccessLevel),
    			CompartmentIdInSubtree: pulumi.BoolRef(securityAssessmentSecurityFeatureAnalyticCompartmentIdInSubtree),
    			TargetId:               pulumi.StringRef(testTarget.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testSecurityAssessmentSecurityFeatureAnalytics = Oci.DataSafe.GetSecurityAssessmentSecurityFeatureAnalytics.Invoke(new()
        {
            CompartmentId = compartmentId,
            AccessLevel = securityAssessmentSecurityFeatureAnalyticAccessLevel,
            CompartmentIdInSubtree = securityAssessmentSecurityFeatureAnalyticCompartmentIdInSubtree,
            TargetId = testTarget.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.DataSafe.DataSafeFunctions;
    import com.pulumi.oci.DataSafe.inputs.GetSecurityAssessmentSecurityFeatureAnalyticsArgs;
    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) {
            final var testSecurityAssessmentSecurityFeatureAnalytics = DataSafeFunctions.getSecurityAssessmentSecurityFeatureAnalytics(GetSecurityAssessmentSecurityFeatureAnalyticsArgs.builder()
                .compartmentId(compartmentId)
                .accessLevel(securityAssessmentSecurityFeatureAnalyticAccessLevel)
                .compartmentIdInSubtree(securityAssessmentSecurityFeatureAnalyticCompartmentIdInSubtree)
                .targetId(testTarget.id())
                .build());
    
        }
    }
    
    variables:
      testSecurityAssessmentSecurityFeatureAnalytics:
        fn::invoke:
          Function: oci:DataSafe:getSecurityAssessmentSecurityFeatureAnalytics
          Arguments:
            compartmentId: ${compartmentId}
            accessLevel: ${securityAssessmentSecurityFeatureAnalyticAccessLevel}
            compartmentIdInSubtree: ${securityAssessmentSecurityFeatureAnalyticCompartmentIdInSubtree}
            targetId: ${testTarget.id}
    

    Using getSecurityAssessmentSecurityFeatureAnalytics

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSecurityAssessmentSecurityFeatureAnalytics(args: GetSecurityAssessmentSecurityFeatureAnalyticsArgs, opts?: InvokeOptions): Promise<GetSecurityAssessmentSecurityFeatureAnalyticsResult>
    function getSecurityAssessmentSecurityFeatureAnalyticsOutput(args: GetSecurityAssessmentSecurityFeatureAnalyticsOutputArgs, opts?: InvokeOptions): Output<GetSecurityAssessmentSecurityFeatureAnalyticsResult>
    def get_security_assessment_security_feature_analytics(access_level: Optional[str] = None,
                                                           compartment_id: Optional[str] = None,
                                                           compartment_id_in_subtree: Optional[bool] = None,
                                                           filters: Optional[Sequence[_datasafe.GetSecurityAssessmentSecurityFeatureAnalyticsFilter]] = None,
                                                           target_id: Optional[str] = None,
                                                           opts: Optional[InvokeOptions] = None) -> GetSecurityAssessmentSecurityFeatureAnalyticsResult
    def get_security_assessment_security_feature_analytics_output(access_level: Optional[pulumi.Input[str]] = None,
                                                           compartment_id: Optional[pulumi.Input[str]] = None,
                                                           compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                                                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetSecurityAssessmentSecurityFeatureAnalyticsFilterArgs]]]] = None,
                                                           target_id: Optional[pulumi.Input[str]] = None,
                                                           opts: Optional[InvokeOptions] = None) -> Output[GetSecurityAssessmentSecurityFeatureAnalyticsResult]
    func GetSecurityAssessmentSecurityFeatureAnalytics(ctx *Context, args *GetSecurityAssessmentSecurityFeatureAnalyticsArgs, opts ...InvokeOption) (*GetSecurityAssessmentSecurityFeatureAnalyticsResult, error)
    func GetSecurityAssessmentSecurityFeatureAnalyticsOutput(ctx *Context, args *GetSecurityAssessmentSecurityFeatureAnalyticsOutputArgs, opts ...InvokeOption) GetSecurityAssessmentSecurityFeatureAnalyticsResultOutput

    > Note: This function is named GetSecurityAssessmentSecurityFeatureAnalytics in the Go SDK.

    public static class GetSecurityAssessmentSecurityFeatureAnalytics 
    {
        public static Task<GetSecurityAssessmentSecurityFeatureAnalyticsResult> InvokeAsync(GetSecurityAssessmentSecurityFeatureAnalyticsArgs args, InvokeOptions? opts = null)
        public static Output<GetSecurityAssessmentSecurityFeatureAnalyticsResult> Invoke(GetSecurityAssessmentSecurityFeatureAnalyticsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSecurityAssessmentSecurityFeatureAnalyticsResult> getSecurityAssessmentSecurityFeatureAnalytics(GetSecurityAssessmentSecurityFeatureAnalyticsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DataSafe/getSecurityAssessmentSecurityFeatureAnalytics:getSecurityAssessmentSecurityFeatureAnalytics
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    A filter to return only resources that match the specified compartment OCID.
    AccessLevel string
    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.
    CompartmentIdInSubtree bool
    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.
    Filters List<GetSecurityAssessmentSecurityFeatureAnalyticsFilter>
    TargetId string
    A filter to return only items related to a specific target OCID.
    CompartmentId string
    A filter to return only resources that match the specified compartment OCID.
    AccessLevel string
    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.
    CompartmentIdInSubtree bool
    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.
    Filters []GetSecurityAssessmentSecurityFeatureAnalyticsFilter
    TargetId string
    A filter to return only items related to a specific target OCID.
    compartmentId String
    A filter to return only resources that match the specified compartment OCID.
    accessLevel String
    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.
    compartmentIdInSubtree Boolean
    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.
    filters List<GetSecurityAssessmentSecurityFeatureAnalyticsFilter>
    targetId String
    A filter to return only items related to a specific target OCID.
    compartmentId string
    A filter to return only resources that match the specified compartment OCID.
    accessLevel string
    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.
    compartmentIdInSubtree boolean
    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.
    filters GetSecurityAssessmentSecurityFeatureAnalyticsFilter[]
    targetId string
    A filter to return only items related to a specific target OCID.
    compartment_id str
    A filter to return only resources that match the specified compartment OCID.
    access_level str
    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.
    compartment_id_in_subtree bool
    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.
    filters Sequence[datasafe.GetSecurityAssessmentSecurityFeatureAnalyticsFilter]
    target_id str
    A filter to return only items related to a specific target OCID.
    compartmentId String
    A filter to return only resources that match the specified compartment OCID.
    accessLevel String
    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.
    compartmentIdInSubtree Boolean
    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.
    filters List<Property Map>
    targetId String
    A filter to return only items related to a specific target OCID.

    getSecurityAssessmentSecurityFeatureAnalytics Result

    The following output properties are available:

    compartmentId String
    id String
    The provider-assigned unique ID for this managed resource.
    securityFeatureAnalyticsCollections List<Property Map>
    The list of security_feature_analytics_collection.
    accessLevel String
    compartmentIdInSubtree Boolean
    filters List<Property Map>
    targetId String

    Supporting Types

    GetSecurityAssessmentSecurityFeatureAnalyticsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollection

    items List<Property Map>
    The array of database security feature analytics summary.

    GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItem

    Dimensions List<GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItemDimension>
    The scope of analytics data.
    MetricName string
    The name of the aggregation metric.
    SecurityAssessmentSecurityFeatureAnalyticCount string
    The total count for the aggregation metric.
    Dimensions []GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItemDimension
    The scope of analytics data.
    MetricName string
    The name of the aggregation metric.
    SecurityAssessmentSecurityFeatureAnalyticCount string
    The total count for the aggregation metric.
    dimensions List<GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItemDimension>
    The scope of analytics data.
    metricName String
    The name of the aggregation metric.
    securityAssessmentSecurityFeatureAnalyticCount String
    The total count for the aggregation metric.
    dimensions GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItemDimension[]
    The scope of analytics data.
    metricName string
    The name of the aggregation metric.
    securityAssessmentSecurityFeatureAnalyticCount string
    The total count for the aggregation metric.
    dimensions List<Property Map>
    The scope of analytics data.
    metricName String
    The name of the aggregation metric.
    securityAssessmentSecurityFeatureAnalyticCount String
    The total count for the aggregation metric.

    GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItemDimension

    SecurityFeature string
    The name of the security feature.
    SecurityFeature string
    The name of the security feature.
    securityFeature String
    The name of the security feature.
    securityFeature string
    The name of the security feature.
    security_feature str
    The name of the security feature.
    securityFeature String
    The name of the security feature.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi