1. Packages
  2. Prismacloud Provider
  3. API Docs
  4. getDatapattern
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks

prismacloud.getDatapattern

Explore with Pulumi AI

Retrieve information on a specific data pattern.

Example Usage

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

const example = prismacloud.getDatapattern({
    name: "My Data Pattern",
});
Copy
import pulumi
import pulumi_prismacloud as prismacloud

example = prismacloud.get_datapattern(name="My Data Pattern")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prismacloud/prismacloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := prismacloud.LookupDatapattern(ctx, &prismacloud.LookupDatapatternArgs{
			Name: pulumi.StringRef("My Data Pattern"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prismacloud = Pulumi.Prismacloud;

return await Deployment.RunAsync(() => 
{
    var example = Prismacloud.GetDatapattern.Invoke(new()
    {
        Name = "My Data Pattern",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prismacloud.PrismacloudFunctions;
import com.pulumi.prismacloud.inputs.GetDatapatternArgs;
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 example = PrismacloudFunctions.getDatapattern(GetDatapatternArgs.builder()
            .name("My Data Pattern")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: prismacloud:getDatapattern
      arguments:
        name: My Data Pattern
Copy

Using getDatapattern

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 getDatapattern(args: GetDatapatternArgs, opts?: InvokeOptions): Promise<GetDatapatternResult>
function getDatapatternOutput(args: GetDatapatternOutputArgs, opts?: InvokeOptions): Output<GetDatapatternResult>
Copy
def get_datapattern(id: Optional[str] = None,
                    name: Optional[str] = None,
                    pattern_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDatapatternResult
def get_datapattern_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    pattern_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDatapatternResult]
Copy
func LookupDatapattern(ctx *Context, args *LookupDatapatternArgs, opts ...InvokeOption) (*LookupDatapatternResult, error)
func LookupDatapatternOutput(ctx *Context, args *LookupDatapatternOutputArgs, opts ...InvokeOption) LookupDatapatternResultOutput
Copy

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

public static class GetDatapattern 
{
    public static Task<GetDatapatternResult> InvokeAsync(GetDatapatternArgs args, InvokeOptions? opts = null)
    public static Output<GetDatapatternResult> Invoke(GetDatapatternInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatapatternResult> getDatapattern(GetDatapatternArgs args, InvokeOptions options)
public static Output<GetDatapatternResult> getDatapattern(GetDatapatternArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: prismacloud:index/getDatapattern:getDatapattern
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
Name string
Pattern name.
PatternId string
Pattern ID.
Id string
Name string
Pattern name.
PatternId string
Pattern ID.
id String
name String
Pattern name.
patternId String
Pattern ID.
id string
name string
Pattern name.
patternId string
Pattern ID.
id str
name str
Pattern name.
pattern_id str
Pattern ID.
id String
name String
Pattern name.
patternId String
Pattern ID.

getDatapattern Result

The following output properties are available:

CreatedBy string
Created by.
Description string
Pattern description.
DetectionTechnique string
Detection technique.
Entity string
Entity value.
Grammar string
Grammar value.
Id string
IsEditable bool
(bool) Is editable.
Mode string
Pattern mode (predefined or custom).
Name string
ParentId string
Parent ID for cloned data pattern.
PatternId string
ProximityKeywords List<string>
List of proximity keywords.
Regexes List<GetDatapatternRegex>
List of regexes, as defined below.
RootType string
Root type (predefined or custom) for cloned data pattern.
S3Path string
S3 Path to the grammar.
UpdatedAt double
(int) Last updated at.
UpdatedBy string
Updated by.
CreatedBy string
Created by.
Description string
Pattern description.
DetectionTechnique string
Detection technique.
Entity string
Entity value.
Grammar string
Grammar value.
Id string
IsEditable bool
(bool) Is editable.
Mode string
Pattern mode (predefined or custom).
Name string
ParentId string
Parent ID for cloned data pattern.
PatternId string
ProximityKeywords []string
List of proximity keywords.
Regexes []GetDatapatternRegex
List of regexes, as defined below.
RootType string
Root type (predefined or custom) for cloned data pattern.
S3Path string
S3 Path to the grammar.
UpdatedAt float64
(int) Last updated at.
UpdatedBy string
Updated by.
createdBy String
Created by.
description String
Pattern description.
detectionTechnique String
Detection technique.
entity String
Entity value.
grammar String
Grammar value.
id String
isEditable Boolean
(bool) Is editable.
mode String
Pattern mode (predefined or custom).
name String
parentId String
Parent ID for cloned data pattern.
patternId String
proximityKeywords List<String>
List of proximity keywords.
regexes List<GetDatapatternRegex>
List of regexes, as defined below.
rootType String
Root type (predefined or custom) for cloned data pattern.
s3Path String
S3 Path to the grammar.
updatedAt Double
(int) Last updated at.
updatedBy String
Updated by.
createdBy string
Created by.
description string
Pattern description.
detectionTechnique string
Detection technique.
entity string
Entity value.
grammar string
Grammar value.
id string
isEditable boolean
(bool) Is editable.
mode string
Pattern mode (predefined or custom).
name string
parentId string
Parent ID for cloned data pattern.
patternId string
proximityKeywords string[]
List of proximity keywords.
regexes GetDatapatternRegex[]
List of regexes, as defined below.
rootType string
Root type (predefined or custom) for cloned data pattern.
s3Path string
S3 Path to the grammar.
updatedAt number
(int) Last updated at.
updatedBy string
Updated by.
created_by str
Created by.
description str
Pattern description.
detection_technique str
Detection technique.
entity str
Entity value.
grammar str
Grammar value.
id str
is_editable bool
(bool) Is editable.
mode str
Pattern mode (predefined or custom).
name str
parent_id str
Parent ID for cloned data pattern.
pattern_id str
proximity_keywords Sequence[str]
List of proximity keywords.
regexes Sequence[GetDatapatternRegex]
List of regexes, as defined below.
root_type str
Root type (predefined or custom) for cloned data pattern.
s3_path str
S3 Path to the grammar.
updated_at float
(int) Last updated at.
updated_by str
Updated by.
createdBy String
Created by.
description String
Pattern description.
detectionTechnique String
Detection technique.
entity String
Entity value.
grammar String
Grammar value.
id String
isEditable Boolean
(bool) Is editable.
mode String
Pattern mode (predefined or custom).
name String
parentId String
Parent ID for cloned data pattern.
patternId String
proximityKeywords List<String>
List of proximity keywords.
regexes List<Property Map>
List of regexes, as defined below.
rootType String
Root type (predefined or custom) for cloned data pattern.
s3Path String
S3 Path to the grammar.
updatedAt Number
(int) Last updated at.
updatedBy String
Updated by.

Supporting Types

GetDatapatternRegex

Regex This property is required. string
Regular expression (match criteria for the data you want to find within your assets).
Weight This property is required. double
(int) Weight to assign a score to a text entry (pattern match occurs when the score threshold is exceeded).
Regex This property is required. string
Regular expression (match criteria for the data you want to find within your assets).
Weight This property is required. float64
(int) Weight to assign a score to a text entry (pattern match occurs when the score threshold is exceeded).
regex This property is required. String
Regular expression (match criteria for the data you want to find within your assets).
weight This property is required. Double
(int) Weight to assign a score to a text entry (pattern match occurs when the score threshold is exceeded).
regex This property is required. string
Regular expression (match criteria for the data you want to find within your assets).
weight This property is required. number
(int) Weight to assign a score to a text entry (pattern match occurs when the score threshold is exceeded).
regex This property is required. str
Regular expression (match criteria for the data you want to find within your assets).
weight This property is required. float
(int) Weight to assign a score to a text entry (pattern match occurs when the score threshold is exceeded).
regex This property is required. String
Regular expression (match criteria for the data you want to find within your assets).
weight This property is required. Number
(int) Weight to assign a score to a text entry (pattern match occurs when the score threshold is exceeded).

Package Details

Repository
prismacloud paloaltonetworks/terraform-provider-prismacloud
License
Notes
This Pulumi package is based on the prismacloud Terraform Provider.