Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getDataMaskRule

This data source provides details about a specific Data Mask Rule resource in Oracle Cloud Infrastructure Cloud Guard service.

Returns a DataMaskRule identified by DataMaskRuleId

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDataMaskRule = Output.Create(Oci.CloudGuard.GetDataMaskRule.InvokeAsync(new Oci.CloudGuard.GetDataMaskRuleArgs
        {
            DataMaskRuleId = oci_cloud_guard_data_mask_rule.Test_data_mask_rule.Id,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := CloudGuard.GetDataMaskRule(ctx, &cloudguard.GetDataMaskRuleArgs{
			DataMaskRuleId: oci_cloud_guard_data_mask_rule.Test_data_mask_rule.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_data_mask_rule = oci.CloudGuard.get_data_mask_rule(data_mask_rule_id=oci_cloud_guard_data_mask_rule["test_data_mask_rule"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDataMaskRule = oci.CloudGuard.getDataMaskRule({
    dataMaskRuleId: oci_cloud_guard_data_mask_rule.test_data_mask_rule.id,
});

Coming soon!

Using getDataMaskRule

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 getDataMaskRule(args: GetDataMaskRuleArgs, opts?: InvokeOptions): Promise<GetDataMaskRuleResult>
function getDataMaskRuleOutput(args: GetDataMaskRuleOutputArgs, opts?: InvokeOptions): Output<GetDataMaskRuleResult>
def get_data_mask_rule(data_mask_rule_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDataMaskRuleResult
def get_data_mask_rule_output(data_mask_rule_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDataMaskRuleResult]
func GetDataMaskRule(ctx *Context, args *GetDataMaskRuleArgs, opts ...InvokeOption) (*GetDataMaskRuleResult, error)
func GetDataMaskRuleOutput(ctx *Context, args *GetDataMaskRuleOutputArgs, opts ...InvokeOption) GetDataMaskRuleResultOutput

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

public static class GetDataMaskRule 
{
    public static Task<GetDataMaskRuleResult> InvokeAsync(GetDataMaskRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetDataMaskRuleResult> Invoke(GetDataMaskRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDataMaskRuleResult> getDataMaskRule(GetDataMaskRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:CloudGuard/getDataMaskRule:getDataMaskRule
  Arguments:
    # Arguments dictionary

The following arguments are supported:

DataMaskRuleId string

OCID of dataMaskRule

DataMaskRuleId string

OCID of dataMaskRule

dataMaskRuleId String

OCID of dataMaskRule

dataMaskRuleId string

OCID of dataMaskRule

data_mask_rule_id str

OCID of dataMaskRule

dataMaskRuleId String

OCID of dataMaskRule

getDataMaskRule Result

The following output properties are available:

CompartmentId string

Compartment Identifier where the resource is created

DataMaskCategories List<string>

Data Mask Categories

DataMaskRuleId string
DataMaskRuleStatus string

The status of the dataMaskRule.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

The data mask rule description.

DisplayName string

Data Mask Rule Identifier, can be renamed

FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IamGroupId string

IAM Group id associated with the data mask rule

Id string

Unique identifier that is immutable on creation

LifecyleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

State string

The current state of the DataMaskRule.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetSelecteds List<GetDataMaskRuleTargetSelected>

Target Selection eg select ALL or select on basis of TargetResourceTypes or TargetIds.

TimeCreated string

The date and time the target was created. Format defined by RFC3339.

TimeUpdated string

The date and time the target was updated. Format defined by RFC3339.

CompartmentId string

Compartment Identifier where the resource is created

DataMaskCategories []string

Data Mask Categories

DataMaskRuleId string
DataMaskRuleStatus string

The status of the dataMaskRule.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

Description string

The data mask rule description.

DisplayName string

Data Mask Rule Identifier, can be renamed

FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IamGroupId string

IAM Group id associated with the data mask rule

Id string

Unique identifier that is immutable on creation

LifecyleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

State string

The current state of the DataMaskRule.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetSelecteds []GetDataMaskRuleTargetSelected

Target Selection eg select ALL or select on basis of TargetResourceTypes or TargetIds.

TimeCreated string

The date and time the target was created. Format defined by RFC3339.

TimeUpdated string

The date and time the target was updated. Format defined by RFC3339.

compartmentId String

Compartment Identifier where the resource is created

dataMaskCategories List<String>

Data Mask Categories

dataMaskRuleId String
dataMaskRuleStatus String

The status of the dataMaskRule.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

The data mask rule description.

displayName String

Data Mask Rule Identifier, can be renamed

freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

iamGroupId String

IAM Group id associated with the data mask rule

id String

Unique identifier that is immutable on creation

lifecyleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

state String

The current state of the DataMaskRule.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

targetSelecteds List<GetDataMaskRuleTargetSelected>

Target Selection eg select ALL or select on basis of TargetResourceTypes or TargetIds.

timeCreated String

The date and time the target was created. Format defined by RFC3339.

timeUpdated String

The date and time the target was updated. Format defined by RFC3339.

compartmentId string

Compartment Identifier where the resource is created

dataMaskCategories string[]

Data Mask Categories

dataMaskRuleId string
dataMaskRuleStatus string

The status of the dataMaskRule.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description string

The data mask rule description.

displayName string

Data Mask Rule Identifier, can be renamed

freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

iamGroupId string

IAM Group id associated with the data mask rule

id string

Unique identifier that is immutable on creation

lifecyleDetails string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

state string

The current state of the DataMaskRule.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

targetSelecteds GetDataMaskRuleTargetSelected[]

Target Selection eg select ALL or select on basis of TargetResourceTypes or TargetIds.

timeCreated string

The date and time the target was created. Format defined by RFC3339.

timeUpdated string

The date and time the target was updated. Format defined by RFC3339.

compartment_id str

Compartment Identifier where the resource is created

data_mask_categories Sequence[str]

Data Mask Categories

data_mask_rule_id str
data_mask_rule_status str

The status of the dataMaskRule.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description str

The data mask rule description.

display_name str

Data Mask Rule Identifier, can be renamed

freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

iam_group_id str

IAM Group id associated with the data mask rule

id str

Unique identifier that is immutable on creation

lifecyle_details str

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

state str

The current state of the DataMaskRule.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

target_selecteds GetDataMaskRuleTargetSelected]

Target Selection eg select ALL or select on basis of TargetResourceTypes or TargetIds.

time_created str

The date and time the target was created. Format defined by RFC3339.

time_updated str

The date and time the target was updated. Format defined by RFC3339.

compartmentId String

Compartment Identifier where the resource is created

dataMaskCategories List<String>

Data Mask Categories

dataMaskRuleId String
dataMaskRuleStatus String

The status of the dataMaskRule.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

description String

The data mask rule description.

displayName String

Data Mask Rule Identifier, can be renamed

freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

iamGroupId String

IAM Group id associated with the data mask rule

id String

Unique identifier that is immutable on creation

lifecyleDetails String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

state String

The current state of the DataMaskRule.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}

targetSelecteds List<Property Map>

Target Selection eg select ALL or select on basis of TargetResourceTypes or TargetIds.

timeCreated String

The date and time the target was created. Format defined by RFC3339.

timeUpdated String

The date and time the target was updated. Format defined by RFC3339.

Supporting Types

GetDataMaskRuleTargetSelected

Kind string

Target selection.

Values List<string>

Types of Targets

Kind string

Target selection.

Values []string

Types of Targets

kind String

Target selection.

values List<String>

Types of Targets

kind string

Target selection.

values string[]

Types of Targets

kind str

Target selection.

values Sequence[str]

Types of Targets

kind String

Target selection.

values List<String>

Types of Targets

Package Details

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

This Pulumi package is based on the oci Terraform Provider.