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

oci.DataSafe.getMaskingReportMaskedColumns

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 Masking Reports Masked Columns in Oracle Cloud Infrastructure Data Safe service.

    Gets a list of masked columns present in the specified masking report and based on the specified query parameters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testMaskingReportsMaskedColumns = oci.DataSafe.getMaskingReportMaskedColumns({
        maskingReportId: testMaskingReport.id,
        columnNames: maskingReportsMaskedColumnColumnName,
        maskingColumnGroups: maskingReportsMaskedColumnMaskingColumnGroup,
        objects: maskingReportsMaskedColumnObject,
        objectTypes: maskingReportsMaskedColumnObjectType,
        schemaNames: maskingReportsMaskedColumnSchemaName,
        sensitiveTypeId: testSensitiveType.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_masking_reports_masked_columns = oci.DataSafe.get_masking_report_masked_columns(masking_report_id=test_masking_report["id"],
        column_names=masking_reports_masked_column_column_name,
        masking_column_groups=masking_reports_masked_column_masking_column_group,
        objects=masking_reports_masked_column_object,
        object_types=masking_reports_masked_column_object_type,
        schema_names=masking_reports_masked_column_schema_name,
        sensitive_type_id=test_sensitive_type["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.GetMaskingReportMaskedColumns(ctx, &datasafe.GetMaskingReportMaskedColumnsArgs{
    			MaskingReportId:     testMaskingReport.Id,
    			ColumnNames:         maskingReportsMaskedColumnColumnName,
    			MaskingColumnGroups: maskingReportsMaskedColumnMaskingColumnGroup,
    			Objects:             maskingReportsMaskedColumnObject,
    			ObjectTypes:         maskingReportsMaskedColumnObjectType,
    			SchemaNames:         maskingReportsMaskedColumnSchemaName,
    			SensitiveTypeId:     pulumi.StringRef(testSensitiveType.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 testMaskingReportsMaskedColumns = Oci.DataSafe.GetMaskingReportMaskedColumns.Invoke(new()
        {
            MaskingReportId = testMaskingReport.Id,
            ColumnNames = maskingReportsMaskedColumnColumnName,
            MaskingColumnGroups = maskingReportsMaskedColumnMaskingColumnGroup,
            Objects = maskingReportsMaskedColumnObject,
            ObjectTypes = maskingReportsMaskedColumnObjectType,
            SchemaNames = maskingReportsMaskedColumnSchemaName,
            SensitiveTypeId = testSensitiveType.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.GetMaskingReportMaskedColumnsArgs;
    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 testMaskingReportsMaskedColumns = DataSafeFunctions.getMaskingReportMaskedColumns(GetMaskingReportMaskedColumnsArgs.builder()
                .maskingReportId(testMaskingReport.id())
                .columnNames(maskingReportsMaskedColumnColumnName)
                .maskingColumnGroups(maskingReportsMaskedColumnMaskingColumnGroup)
                .objects(maskingReportsMaskedColumnObject)
                .objectTypes(maskingReportsMaskedColumnObjectType)
                .schemaNames(maskingReportsMaskedColumnSchemaName)
                .sensitiveTypeId(testSensitiveType.id())
                .build());
    
        }
    }
    
    variables:
      testMaskingReportsMaskedColumns:
        fn::invoke:
          Function: oci:DataSafe:getMaskingReportMaskedColumns
          Arguments:
            maskingReportId: ${testMaskingReport.id}
            columnNames: ${maskingReportsMaskedColumnColumnName}
            maskingColumnGroups: ${maskingReportsMaskedColumnMaskingColumnGroup}
            objects: ${maskingReportsMaskedColumnObject}
            objectTypes: ${maskingReportsMaskedColumnObjectType}
            schemaNames: ${maskingReportsMaskedColumnSchemaName}
            sensitiveTypeId: ${testSensitiveType.id}
    

    Using getMaskingReportMaskedColumns

    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 getMaskingReportMaskedColumns(args: GetMaskingReportMaskedColumnsArgs, opts?: InvokeOptions): Promise<GetMaskingReportMaskedColumnsResult>
    function getMaskingReportMaskedColumnsOutput(args: GetMaskingReportMaskedColumnsOutputArgs, opts?: InvokeOptions): Output<GetMaskingReportMaskedColumnsResult>
    def get_masking_report_masked_columns(column_names: Optional[Sequence[str]] = None,
                                          filters: Optional[Sequence[_datasafe.GetMaskingReportMaskedColumnsFilter]] = None,
                                          masking_column_groups: Optional[Sequence[str]] = None,
                                          masking_report_id: Optional[str] = None,
                                          object_types: Optional[Sequence[str]] = None,
                                          objects: Optional[Sequence[str]] = None,
                                          schema_names: Optional[Sequence[str]] = None,
                                          sensitive_type_id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetMaskingReportMaskedColumnsResult
    def get_masking_report_masked_columns_output(column_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetMaskingReportMaskedColumnsFilterArgs]]]] = None,
                                          masking_column_groups: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                          masking_report_id: Optional[pulumi.Input[str]] = None,
                                          object_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                          objects: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                          schema_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                          sensitive_type_id: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetMaskingReportMaskedColumnsResult]
    func GetMaskingReportMaskedColumns(ctx *Context, args *GetMaskingReportMaskedColumnsArgs, opts ...InvokeOption) (*GetMaskingReportMaskedColumnsResult, error)
    func GetMaskingReportMaskedColumnsOutput(ctx *Context, args *GetMaskingReportMaskedColumnsOutputArgs, opts ...InvokeOption) GetMaskingReportMaskedColumnsResultOutput

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

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

    The following arguments are supported:

    MaskingReportId string
    The OCID of the masking report.
    ColumnNames List<string>
    A filter to return only a specific column based on column name.
    Filters List<GetMaskingReportMaskedColumnsFilter>
    MaskingColumnGroups List<string>
    A filter to return only the resources that match the specified masking column group.
    ObjectTypes List<string>
    A filter to return only items related to a specific object type.
    Objects List<string>
    A filter to return only items related to a specific object name.
    SchemaNames List<string>
    A filter to return only items related to specific schema name.
    SensitiveTypeId string
    A filter to return only items related to a specific sensitive type OCID.
    MaskingReportId string
    The OCID of the masking report.
    ColumnNames []string
    A filter to return only a specific column based on column name.
    Filters []GetMaskingReportMaskedColumnsFilter
    MaskingColumnGroups []string
    A filter to return only the resources that match the specified masking column group.
    ObjectTypes []string
    A filter to return only items related to a specific object type.
    Objects []string
    A filter to return only items related to a specific object name.
    SchemaNames []string
    A filter to return only items related to specific schema name.
    SensitiveTypeId string
    A filter to return only items related to a specific sensitive type OCID.
    maskingReportId String
    The OCID of the masking report.
    columnNames List<String>
    A filter to return only a specific column based on column name.
    filters List<GetMaskingReportMaskedColumnsFilter>
    maskingColumnGroups List<String>
    A filter to return only the resources that match the specified masking column group.
    objectTypes List<String>
    A filter to return only items related to a specific object type.
    objects List<String>
    A filter to return only items related to a specific object name.
    schemaNames List<String>
    A filter to return only items related to specific schema name.
    sensitiveTypeId String
    A filter to return only items related to a specific sensitive type OCID.
    maskingReportId string
    The OCID of the masking report.
    columnNames string[]
    A filter to return only a specific column based on column name.
    filters GetMaskingReportMaskedColumnsFilter[]
    maskingColumnGroups string[]
    A filter to return only the resources that match the specified masking column group.
    objectTypes string[]
    A filter to return only items related to a specific object type.
    objects string[]
    A filter to return only items related to a specific object name.
    schemaNames string[]
    A filter to return only items related to specific schema name.
    sensitiveTypeId string
    A filter to return only items related to a specific sensitive type OCID.
    masking_report_id str
    The OCID of the masking report.
    column_names Sequence[str]
    A filter to return only a specific column based on column name.
    filters Sequence[datasafe.GetMaskingReportMaskedColumnsFilter]
    masking_column_groups Sequence[str]
    A filter to return only the resources that match the specified masking column group.
    object_types Sequence[str]
    A filter to return only items related to a specific object type.
    objects Sequence[str]
    A filter to return only items related to a specific object name.
    schema_names Sequence[str]
    A filter to return only items related to specific schema name.
    sensitive_type_id str
    A filter to return only items related to a specific sensitive type OCID.
    maskingReportId String
    The OCID of the masking report.
    columnNames List<String>
    A filter to return only a specific column based on column name.
    filters List<Property Map>
    maskingColumnGroups List<String>
    A filter to return only the resources that match the specified masking column group.
    objectTypes List<String>
    A filter to return only items related to a specific object type.
    objects List<String>
    A filter to return only items related to a specific object name.
    schemaNames List<String>
    A filter to return only items related to specific schema name.
    sensitiveTypeId String
    A filter to return only items related to a specific sensitive type OCID.

    getMaskingReportMaskedColumns Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    MaskedColumnCollections List<GetMaskingReportMaskedColumnsMaskedColumnCollection>
    The list of masked_column_collection.
    MaskingReportId string
    ColumnNames List<string>
    The name of the masked column.
    Filters List<GetMaskingReportMaskedColumnsFilter>
    MaskingColumnGroups List<string>
    The masking group of the masked column.
    ObjectTypes List<string>
    The type of the object (table or editioning view) that contains the masked column.
    Objects List<string>
    The name of the object (table or editioning view) that contains the masked column.
    SchemaNames List<string>
    The name of the schema that contains the masked column.
    SensitiveTypeId string
    The OCID of the sensitive type associated with the masked column.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaskedColumnCollections []GetMaskingReportMaskedColumnsMaskedColumnCollection
    The list of masked_column_collection.
    MaskingReportId string
    ColumnNames []string
    The name of the masked column.
    Filters []GetMaskingReportMaskedColumnsFilter
    MaskingColumnGroups []string
    The masking group of the masked column.
    ObjectTypes []string
    The type of the object (table or editioning view) that contains the masked column.
    Objects []string
    The name of the object (table or editioning view) that contains the masked column.
    SchemaNames []string
    The name of the schema that contains the masked column.
    SensitiveTypeId string
    The OCID of the sensitive type associated with the masked column.
    id String
    The provider-assigned unique ID for this managed resource.
    maskedColumnCollections List<GetMaskingReportMaskedColumnsMaskedColumnCollection>
    The list of masked_column_collection.
    maskingReportId String
    columnNames List<String>
    The name of the masked column.
    filters List<GetMaskingReportMaskedColumnsFilter>
    maskingColumnGroups List<String>
    The masking group of the masked column.
    objectTypes List<String>
    The type of the object (table or editioning view) that contains the masked column.
    objects List<String>
    The name of the object (table or editioning view) that contains the masked column.
    schemaNames List<String>
    The name of the schema that contains the masked column.
    sensitiveTypeId String
    The OCID of the sensitive type associated with the masked column.
    id string
    The provider-assigned unique ID for this managed resource.
    maskedColumnCollections GetMaskingReportMaskedColumnsMaskedColumnCollection[]
    The list of masked_column_collection.
    maskingReportId string
    columnNames string[]
    The name of the masked column.
    filters GetMaskingReportMaskedColumnsFilter[]
    maskingColumnGroups string[]
    The masking group of the masked column.
    objectTypes string[]
    The type of the object (table or editioning view) that contains the masked column.
    objects string[]
    The name of the object (table or editioning view) that contains the masked column.
    schemaNames string[]
    The name of the schema that contains the masked column.
    sensitiveTypeId string
    The OCID of the sensitive type associated with the masked column.
    id str
    The provider-assigned unique ID for this managed resource.
    masked_column_collections Sequence[datasafe.GetMaskingReportMaskedColumnsMaskedColumnCollection]
    The list of masked_column_collection.
    masking_report_id str
    column_names Sequence[str]
    The name of the masked column.
    filters Sequence[datasafe.GetMaskingReportMaskedColumnsFilter]
    masking_column_groups Sequence[str]
    The masking group of the masked column.
    object_types Sequence[str]
    The type of the object (table or editioning view) that contains the masked column.
    objects Sequence[str]
    The name of the object (table or editioning view) that contains the masked column.
    schema_names Sequence[str]
    The name of the schema that contains the masked column.
    sensitive_type_id str
    The OCID of the sensitive type associated with the masked column.
    id String
    The provider-assigned unique ID for this managed resource.
    maskedColumnCollections List<Property Map>
    The list of masked_column_collection.
    maskingReportId String
    columnNames List<String>
    The name of the masked column.
    filters List<Property Map>
    maskingColumnGroups List<String>
    The masking group of the masked column.
    objectTypes List<String>
    The type of the object (table or editioning view) that contains the masked column.
    objects List<String>
    The name of the object (table or editioning view) that contains the masked column.
    schemaNames List<String>
    The name of the schema that contains the masked column.
    sensitiveTypeId String
    The OCID of the sensitive type associated with the masked column.

    Supporting Types

    GetMaskingReportMaskedColumnsFilter

    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

    GetMaskingReportMaskedColumnsMaskedColumnCollection

    Items List<GetMaskingReportMaskedColumnsMaskedColumnCollectionItem>
    An array of masking column summary objects.
    Items []GetMaskingReportMaskedColumnsMaskedColumnCollectionItem
    An array of masking column summary objects.
    items List<GetMaskingReportMaskedColumnsMaskedColumnCollectionItem>
    An array of masking column summary objects.
    items GetMaskingReportMaskedColumnsMaskedColumnCollectionItem[]
    An array of masking column summary objects.
    items List<Property Map>
    An array of masking column summary objects.

    GetMaskingReportMaskedColumnsMaskedColumnCollectionItem

    ColumnName string
    A filter to return only a specific column based on column name.
    Key string
    The unique key that identifies the masked column. It's numeric and unique within a masking policy.
    MaskingColumnGroup string
    A filter to return only the resources that match the specified masking column group.
    MaskingFormatUsed string
    The masking format used for masking the column.
    Object string
    A filter to return only items related to a specific object name.
    ObjectType string
    A filter to return only items related to a specific object type.
    ParentColumnKey string
    The unique key that identifies the parent column of the masked column.
    SchemaName string
    A filter to return only items related to specific schema name.
    SensitiveTypeId string
    A filter to return only items related to a specific sensitive type OCID.
    TotalMaskedValues string
    The total number of values masked in the column.
    ColumnName string
    A filter to return only a specific column based on column name.
    Key string
    The unique key that identifies the masked column. It's numeric and unique within a masking policy.
    MaskingColumnGroup string
    A filter to return only the resources that match the specified masking column group.
    MaskingFormatUsed string
    The masking format used for masking the column.
    Object string
    A filter to return only items related to a specific object name.
    ObjectType string
    A filter to return only items related to a specific object type.
    ParentColumnKey string
    The unique key that identifies the parent column of the masked column.
    SchemaName string
    A filter to return only items related to specific schema name.
    SensitiveTypeId string
    A filter to return only items related to a specific sensitive type OCID.
    TotalMaskedValues string
    The total number of values masked in the column.
    columnName String
    A filter to return only a specific column based on column name.
    key String
    The unique key that identifies the masked column. It's numeric and unique within a masking policy.
    maskingColumnGroup String
    A filter to return only the resources that match the specified masking column group.
    maskingFormatUsed String
    The masking format used for masking the column.
    object String
    A filter to return only items related to a specific object name.
    objectType String
    A filter to return only items related to a specific object type.
    parentColumnKey String
    The unique key that identifies the parent column of the masked column.
    schemaName String
    A filter to return only items related to specific schema name.
    sensitiveTypeId String
    A filter to return only items related to a specific sensitive type OCID.
    totalMaskedValues String
    The total number of values masked in the column.
    columnName string
    A filter to return only a specific column based on column name.
    key string
    The unique key that identifies the masked column. It's numeric and unique within a masking policy.
    maskingColumnGroup string
    A filter to return only the resources that match the specified masking column group.
    maskingFormatUsed string
    The masking format used for masking the column.
    object string
    A filter to return only items related to a specific object name.
    objectType string
    A filter to return only items related to a specific object type.
    parentColumnKey string
    The unique key that identifies the parent column of the masked column.
    schemaName string
    A filter to return only items related to specific schema name.
    sensitiveTypeId string
    A filter to return only items related to a specific sensitive type OCID.
    totalMaskedValues string
    The total number of values masked in the column.
    column_name str
    A filter to return only a specific column based on column name.
    key str
    The unique key that identifies the masked column. It's numeric and unique within a masking policy.
    masking_column_group str
    A filter to return only the resources that match the specified masking column group.
    masking_format_used str
    The masking format used for masking the column.
    object str
    A filter to return only items related to a specific object name.
    object_type str
    A filter to return only items related to a specific object type.
    parent_column_key str
    The unique key that identifies the parent column of the masked column.
    schema_name str
    A filter to return only items related to specific schema name.
    sensitive_type_id str
    A filter to return only items related to a specific sensitive type OCID.
    total_masked_values str
    The total number of values masked in the column.
    columnName String
    A filter to return only a specific column based on column name.
    key String
    The unique key that identifies the masked column. It's numeric and unique within a masking policy.
    maskingColumnGroup String
    A filter to return only the resources that match the specified masking column group.
    maskingFormatUsed String
    The masking format used for masking the column.
    object String
    A filter to return only items related to a specific object name.
    objectType String
    A filter to return only items related to a specific object type.
    parentColumnKey String
    The unique key that identifies the parent column of the masked column.
    schemaName String
    A filter to return only items related to specific schema name.
    sensitiveTypeId String
    A filter to return only items related to a specific sensitive type OCID.
    totalMaskedValues String
    The total number of values masked in the column.

    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