Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getCompatibleFormatsForSensitiveType
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.getCompatibleFormatsForSensitiveType

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Compatible Formats For Sensitive Type resource in Oracle Cloud Infrastructure Data Safe service.

Gets a list of library masking formats compatible with the existing sensitive types. For each sensitive type, it returns the assigned default masking format as well as the other library masking formats that have the sensitiveTypeIds attribute containing the OCID of the sensitive type.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCompatibleFormatsForSensitiveType = oci.DataSafe.getCompatibleFormatsForSensitiveType({
    compartmentId: compartmentId,
    accessLevel: compatibleFormatsForSensitiveTypeAccessLevel,
    compartmentIdInSubtree: compatibleFormatsForSensitiveTypeCompartmentIdInSubtree,
});
Copy
import pulumi
import pulumi_oci as oci

test_compatible_formats_for_sensitive_type = oci.DataSafe.get_compatible_formats_for_sensitive_type(compartment_id=compartment_id,
    access_level=compatible_formats_for_sensitive_type_access_level,
    compartment_id_in_subtree=compatible_formats_for_sensitive_type_compartment_id_in_subtree)
Copy
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.GetCompatibleFormatsForSensitiveType(ctx, &datasafe.GetCompatibleFormatsForSensitiveTypeArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(compatibleFormatsForSensitiveTypeAccessLevel),
			CompartmentIdInSubtree: pulumi.BoolRef(compatibleFormatsForSensitiveTypeCompartmentIdInSubtree),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCompatibleFormatsForSensitiveType = Oci.DataSafe.GetCompatibleFormatsForSensitiveType.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = compatibleFormatsForSensitiveTypeAccessLevel,
        CompartmentIdInSubtree = compatibleFormatsForSensitiveTypeCompartmentIdInSubtree,
    });

});
Copy
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.GetCompatibleFormatsForSensitiveTypeArgs;
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 testCompatibleFormatsForSensitiveType = DataSafeFunctions.getCompatibleFormatsForSensitiveType(GetCompatibleFormatsForSensitiveTypeArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(compatibleFormatsForSensitiveTypeAccessLevel)
            .compartmentIdInSubtree(compatibleFormatsForSensitiveTypeCompartmentIdInSubtree)
            .build());

    }
}
Copy
variables:
  testCompatibleFormatsForSensitiveType:
    fn::invoke:
      function: oci:DataSafe:getCompatibleFormatsForSensitiveType
      arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${compatibleFormatsForSensitiveTypeAccessLevel}
        compartmentIdInSubtree: ${compatibleFormatsForSensitiveTypeCompartmentIdInSubtree}
Copy

Using getCompatibleFormatsForSensitiveType

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 getCompatibleFormatsForSensitiveType(args: GetCompatibleFormatsForSensitiveTypeArgs, opts?: InvokeOptions): Promise<GetCompatibleFormatsForSensitiveTypeResult>
function getCompatibleFormatsForSensitiveTypeOutput(args: GetCompatibleFormatsForSensitiveTypeOutputArgs, opts?: InvokeOptions): Output<GetCompatibleFormatsForSensitiveTypeResult>
Copy
def get_compatible_formats_for_sensitive_type(access_level: Optional[str] = None,
                                              compartment_id: Optional[str] = None,
                                              compartment_id_in_subtree: Optional[bool] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetCompatibleFormatsForSensitiveTypeResult
def get_compatible_formats_for_sensitive_type_output(access_level: Optional[pulumi.Input[str]] = None,
                                              compartment_id: Optional[pulumi.Input[str]] = None,
                                              compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetCompatibleFormatsForSensitiveTypeResult]
Copy
func GetCompatibleFormatsForSensitiveType(ctx *Context, args *GetCompatibleFormatsForSensitiveTypeArgs, opts ...InvokeOption) (*GetCompatibleFormatsForSensitiveTypeResult, error)
func GetCompatibleFormatsForSensitiveTypeOutput(ctx *Context, args *GetCompatibleFormatsForSensitiveTypeOutputArgs, opts ...InvokeOption) GetCompatibleFormatsForSensitiveTypeResultOutput
Copy

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

public static class GetCompatibleFormatsForSensitiveType 
{
    public static Task<GetCompatibleFormatsForSensitiveTypeResult> InvokeAsync(GetCompatibleFormatsForSensitiveTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetCompatibleFormatsForSensitiveTypeResult> Invoke(GetCompatibleFormatsForSensitiveTypeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCompatibleFormatsForSensitiveTypeResult> getCompatibleFormatsForSensitiveType(GetCompatibleFormatsForSensitiveTypeArgs args, InvokeOptions options)
public static Output<GetCompatibleFormatsForSensitiveTypeResult> getCompatibleFormatsForSensitiveType(GetCompatibleFormatsForSensitiveTypeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:DataSafe/getCompatibleFormatsForSensitiveType:getCompatibleFormatsForSensitiveType
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. 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.
CompartmentId This property is required. 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.
compartmentId This property is required. 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.
compartmentId This property is required. 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.
compartment_id This property is required. 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.
compartmentId This property is required. 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.

getCompatibleFormatsForSensitiveType Result

The following output properties are available:

CompartmentId string
FormatsForSensitiveTypes List<GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveType>
An array of library masking formats compatible with the existing sensitive types.
Id string
The provider-assigned unique ID for this managed resource.
AccessLevel string
CompartmentIdInSubtree bool
CompartmentId string
FormatsForSensitiveTypes []GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveType
An array of library masking formats compatible with the existing sensitive types.
Id string
The provider-assigned unique ID for this managed resource.
AccessLevel string
CompartmentIdInSubtree bool
compartmentId String
formatsForSensitiveTypes List<GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveType>
An array of library masking formats compatible with the existing sensitive types.
id String
The provider-assigned unique ID for this managed resource.
accessLevel String
compartmentIdInSubtree Boolean
compartmentId string
formatsForSensitiveTypes GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveType[]
An array of library masking formats compatible with the existing sensitive types.
id string
The provider-assigned unique ID for this managed resource.
accessLevel string
compartmentIdInSubtree boolean
compartment_id str
formats_for_sensitive_types Sequence[datasafe.GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveType]
An array of library masking formats compatible with the existing sensitive types.
id str
The provider-assigned unique ID for this managed resource.
access_level str
compartment_id_in_subtree bool
compartmentId String
formatsForSensitiveTypes List<Property Map>
An array of library masking formats compatible with the existing sensitive types.
id String
The provider-assigned unique ID for this managed resource.
accessLevel String
compartmentIdInSubtree Boolean

Supporting Types

GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveType

MaskingFormats This property is required. List<GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat>
An array of the library masking formats compatible with the sensitive type.
SensitiveTypeId This property is required. string
The OCID of the sensitive type.
MaskingFormats This property is required. []GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat
An array of the library masking formats compatible with the sensitive type.
SensitiveTypeId This property is required. string
The OCID of the sensitive type.
maskingFormats This property is required. List<GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat>
An array of the library masking formats compatible with the sensitive type.
sensitiveTypeId This property is required. String
The OCID of the sensitive type.
maskingFormats This property is required. GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat[]
An array of the library masking formats compatible with the sensitive type.
sensitiveTypeId This property is required. string
The OCID of the sensitive type.
masking_formats This property is required. Sequence[datasafe.GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat]
An array of the library masking formats compatible with the sensitive type.
sensitive_type_id This property is required. str
The OCID of the sensitive type.
maskingFormats This property is required. List<Property Map>
An array of the library masking formats compatible with the sensitive type.
sensitiveTypeId This property is required. String
The OCID of the sensitive type.

GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat

Description This property is required. string
The description of the masking format.
Id This property is required. string
The OCID of the masking format.
Name This property is required. string
The name of the masking format.
Description This property is required. string
The description of the masking format.
Id This property is required. string
The OCID of the masking format.
Name This property is required. string
The name of the masking format.
description This property is required. String
The description of the masking format.
id This property is required. String
The OCID of the masking format.
name This property is required. String
The name of the masking format.
description This property is required. string
The description of the masking format.
id This property is required. string
The OCID of the masking format.
name This property is required. string
The name of the masking format.
description This property is required. str
The description of the masking format.
id This property is required. str
The OCID of the masking format.
name This property is required. str
The name of the masking format.
description This property is required. String
The description of the masking format.
id This property is required. String
The OCID of the masking format.
name This property is required. String
The name of the masking format.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci