Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getMaskingAnalytic

This data source provides details about a specific Masking Analytic resource in Oracle Cloud Infrastructure Data Safe service.

Gets consolidated masking analytics data based on the specified query parameters.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testMaskingAnalytic = Oci.DataSafe.GetMaskingAnalytic.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        CompartmentIdInSubtree = @var.Masking_analytic_compartment_id_in_subtree,
        GroupBy = @var.Masking_analytic_group_by,
        MaskingPolicyId = oci_data_safe_masking_policy.Test_masking_policy.Id,
        TargetId = oci_cloud_guard_target.Test_target.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataSafe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.GetMaskingAnalytic(ctx, &datasafe.GetMaskingAnalyticArgs{
			CompartmentId:          _var.Compartment_id,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Masking_analytic_compartment_id_in_subtree),
			GroupBy:                pulumi.StringRef(_var.Masking_analytic_group_by),
			MaskingPolicyId:        pulumi.StringRef(oci_data_safe_masking_policy.Test_masking_policy.Id),
			TargetId:               pulumi.StringRef(oci_cloud_guard_target.Test_target.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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.GetMaskingAnalyticArgs;
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 testMaskingAnalytic = DataSafeFunctions.getMaskingAnalytic(GetMaskingAnalyticArgs.builder()
            .compartmentId(var_.compartment_id())
            .compartmentIdInSubtree(var_.masking_analytic_compartment_id_in_subtree())
            .groupBy(var_.masking_analytic_group_by())
            .maskingPolicyId(oci_data_safe_masking_policy.test_masking_policy().id())
            .targetId(oci_cloud_guard_target.test_target().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_masking_analytic = oci.DataSafe.get_masking_analytic(compartment_id=var["compartment_id"],
    compartment_id_in_subtree=var["masking_analytic_compartment_id_in_subtree"],
    group_by=var["masking_analytic_group_by"],
    masking_policy_id=oci_data_safe_masking_policy["test_masking_policy"]["id"],
    target_id=oci_cloud_guard_target["test_target"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMaskingAnalytic = oci.DataSafe.getMaskingAnalytic({
    compartmentId: _var.compartment_id,
    compartmentIdInSubtree: _var.masking_analytic_compartment_id_in_subtree,
    groupBy: _var.masking_analytic_group_by,
    maskingPolicyId: oci_data_safe_masking_policy.test_masking_policy.id,
    targetId: oci_cloud_guard_target.test_target.id,
});
variables:
  testMaskingAnalytic:
    Fn::Invoke:
      Function: oci:DataSafe:getMaskingAnalytic
      Arguments:
        compartmentId: ${var.compartment_id}
        compartmentIdInSubtree: ${var.masking_analytic_compartment_id_in_subtree}
        groupBy: ${var.masking_analytic_group_by}
        maskingPolicyId: ${oci_data_safe_masking_policy.test_masking_policy.id}
        targetId: ${oci_cloud_guard_target.test_target.id}

Using getMaskingAnalytic

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 getMaskingAnalytic(args: GetMaskingAnalyticArgs, opts?: InvokeOptions): Promise<GetMaskingAnalyticResult>
function getMaskingAnalyticOutput(args: GetMaskingAnalyticOutputArgs, opts?: InvokeOptions): Output<GetMaskingAnalyticResult>
def get_masking_analytic(compartment_id: Optional[str] = None,
                         compartment_id_in_subtree: Optional[bool] = None,
                         group_by: Optional[str] = None,
                         masking_policy_id: Optional[str] = None,
                         target_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetMaskingAnalyticResult
def get_masking_analytic_output(compartment_id: Optional[pulumi.Input[str]] = None,
                         compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                         group_by: Optional[pulumi.Input[str]] = None,
                         masking_policy_id: Optional[pulumi.Input[str]] = None,
                         target_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetMaskingAnalyticResult]
func GetMaskingAnalytic(ctx *Context, args *GetMaskingAnalyticArgs, opts ...InvokeOption) (*GetMaskingAnalyticResult, error)
func GetMaskingAnalyticOutput(ctx *Context, args *GetMaskingAnalyticOutputArgs, opts ...InvokeOption) GetMaskingAnalyticResultOutput

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

public static class GetMaskingAnalytic 
{
    public static Task<GetMaskingAnalyticResult> InvokeAsync(GetMaskingAnalyticArgs args, InvokeOptions? opts = null)
    public static Output<GetMaskingAnalyticResult> Invoke(GetMaskingAnalyticInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMaskingAnalyticResult> getMaskingAnalytic(GetMaskingAnalyticArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataSafe/getMaskingAnalytic:getMaskingAnalytic
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

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.

GroupBy string

Attribute by which the masking analytics data should be grouped.

MaskingPolicyId string

A filter to return only the resources that match the specified masking policy OCID.

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.

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.

GroupBy string

Attribute by which the masking analytics data should be grouped.

MaskingPolicyId string

A filter to return only the resources that match the specified masking policy OCID.

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.

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.

groupBy String

Attribute by which the masking analytics data should be grouped.

maskingPolicyId String

A filter to return only the resources that match the specified masking policy OCID.

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.

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.

groupBy string

Attribute by which the masking analytics data should be grouped.

maskingPolicyId string

A filter to return only the resources that match the specified masking policy OCID.

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.

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.

group_by str

Attribute by which the masking analytics data should be grouped.

masking_policy_id str

A filter to return only the resources that match the specified masking policy OCID.

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.

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.

groupBy String

Attribute by which the masking analytics data should be grouped.

maskingPolicyId String

A filter to return only the resources that match the specified masking policy OCID.

targetId String

A filter to return only items related to a specific target OCID.

getMaskingAnalytic Result

The following output properties are available:

CompartmentId string
Id string

The provider-assigned unique ID for this managed resource.

Items List<GetMaskingAnalyticItem>

An array of masking analytics summary objects.

CompartmentIdInSubtree bool
GroupBy string
MaskingPolicyId string
TargetId string

The OCID of the target database.

CompartmentId string
Id string

The provider-assigned unique ID for this managed resource.

Items []GetMaskingAnalyticItem

An array of masking analytics summary objects.

CompartmentIdInSubtree bool
GroupBy string
MaskingPolicyId string
TargetId string

The OCID of the target database.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

items List<GetMaskingAnalyticItem>

An array of masking analytics summary objects.

compartmentIdInSubtree Boolean
groupBy String
maskingPolicyId String
targetId String

The OCID of the target database.

compartmentId string
id string

The provider-assigned unique ID for this managed resource.

items GetMaskingAnalyticItem[]

An array of masking analytics summary objects.

compartmentIdInSubtree boolean
groupBy string
maskingPolicyId string
targetId string

The OCID of the target database.

compartment_id str
id str

The provider-assigned unique ID for this managed resource.

items GetMaskingAnalyticItem]

An array of masking analytics summary objects.

compartment_id_in_subtree bool
group_by str
masking_policy_id str
target_id str

The OCID of the target database.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

items List<Property Map>

An array of masking analytics summary objects.

compartmentIdInSubtree Boolean
groupBy String
maskingPolicyId String
targetId String

The OCID of the target database.

Supporting Types

GetMaskingAnalyticItem

Count string

The total count for the aggregation metric.

Dimensions List<GetMaskingAnalyticItemDimension>

The scope of analytics data.

MetricName string

The name of the aggregation metric.

Count string

The total count for the aggregation metric.

Dimensions []GetMaskingAnalyticItemDimension

The scope of analytics data.

MetricName string

The name of the aggregation metric.

count String

The total count for the aggregation metric.

dimensions List<GetMaskingAnalyticItemDimension>

The scope of analytics data.

metricName String

The name of the aggregation metric.

count string

The total count for the aggregation metric.

dimensions GetMaskingAnalyticItemDimension[]

The scope of analytics data.

metricName string

The name of the aggregation metric.

count str

The total count for the aggregation metric.

dimensions GetMaskingAnalyticItemDimension]

The scope of analytics data.

metric_name str

The name of the aggregation metric.

count 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.

GetMaskingAnalyticItemDimension

PolicyId string

The OCID of the masking policy..

TargetId string

A filter to return only items related to a specific target OCID.

PolicyId string

The OCID of the masking policy..

TargetId string

A filter to return only items related to a specific target OCID.

policyId String

The OCID of the masking policy..

targetId String

A filter to return only items related to a specific target OCID.

policyId string

The OCID of the masking policy..

targetId string

A filter to return only items related to a specific target OCID.

policy_id str

The OCID of the masking policy..

target_id str

A filter to return only items related to a specific target OCID.

policyId String

The OCID of the masking policy..

targetId String

A filter to return only items related to a specific target OCID.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.