1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectWebfilterProfileAntiphishCustompatterns
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev

fortimanager.ObjectWebfilterProfileAntiphishCustompatterns

Explore with Pulumi AI

Custom username and password regex patterns.

This resource is a sub resource for variable custom_patterns of resource fortimanager.ObjectWebfilterProfileAntiphish. Conflict and overwrite may occur if use both of them.

Example Usage

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

const trname5 = new fortimanager.ObjectWebfilterProfile("trname5", {});
const trname = new fortimanager.ObjectWebfilterProfileAntiphishCustompatterns("trname", {
    category: "username",
    pattern: "tset",
    profile: trname5.name,
}, {
    dependsOn: [trname5],
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname5 = fortimanager.ObjectWebfilterProfile("trname5")
trname = fortimanager.ObjectWebfilterProfileAntiphishCustompatterns("trname",
    category="username",
    pattern="tset",
    profile=trname5.name,
    opts = pulumi.ResourceOptions(depends_on=[trname5]))
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		trname5, err := fortimanager.NewObjectWebfilterProfile(ctx, "trname5", nil)
		if err != nil {
			return err
		}
		_, err = fortimanager.NewObjectWebfilterProfileAntiphishCustompatterns(ctx, "trname", &fortimanager.ObjectWebfilterProfileAntiphishCustompatternsArgs{
			Category: pulumi.String("username"),
			Pattern:  pulumi.String("tset"),
			Profile:  trname5.Name,
		}, pulumi.DependsOn([]pulumi.Resource{
			trname5,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname5 = new Fortimanager.ObjectWebfilterProfile("trname5");

    var trname = new Fortimanager.ObjectWebfilterProfileAntiphishCustompatterns("trname", new()
    {
        Category = "username",
        Pattern = "tset",
        Profile = trname5.Name,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            trname5,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectWebfilterProfile;
import com.pulumi.fortimanager.ObjectWebfilterProfileAntiphishCustompatterns;
import com.pulumi.fortimanager.ObjectWebfilterProfileAntiphishCustompatternsArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        var trname5 = new ObjectWebfilterProfile("trname5");

        var trname = new ObjectWebfilterProfileAntiphishCustompatterns("trname", ObjectWebfilterProfileAntiphishCustompatternsArgs.builder()
            .category("username")
            .pattern("tset")
            .profile(trname5.name())
            .build(), CustomResourceOptions.builder()
                .dependsOn(trname5)
                .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:ObjectWebfilterProfileAntiphishCustompatterns
    properties:
      category: username
      pattern: tset
      profile: ${trname5.name}
    options:
      dependsOn:
        - ${trname5}
  trname5:
    type: fortimanager:ObjectWebfilterProfile
Copy

Create ObjectWebfilterProfileAntiphishCustompatterns Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ObjectWebfilterProfileAntiphishCustompatterns(name: string, args: ObjectWebfilterProfileAntiphishCustompatternsArgs, opts?: CustomResourceOptions);
@overload
def ObjectWebfilterProfileAntiphishCustompatterns(resource_name: str,
                                                  args: ObjectWebfilterProfileAntiphishCustompatternsArgs,
                                                  opts: Optional[ResourceOptions] = None)

@overload
def ObjectWebfilterProfileAntiphishCustompatterns(resource_name: str,
                                                  opts: Optional[ResourceOptions] = None,
                                                  profile: Optional[str] = None,
                                                  adom: Optional[str] = None,
                                                  category: Optional[str] = None,
                                                  object_webfilter_profile_antiphish_custompatterns_id: Optional[str] = None,
                                                  pattern: Optional[str] = None,
                                                  scopetype: Optional[str] = None,
                                                  type: Optional[str] = None)
func NewObjectWebfilterProfileAntiphishCustompatterns(ctx *Context, name string, args ObjectWebfilterProfileAntiphishCustompatternsArgs, opts ...ResourceOption) (*ObjectWebfilterProfileAntiphishCustompatterns, error)
public ObjectWebfilterProfileAntiphishCustompatterns(string name, ObjectWebfilterProfileAntiphishCustompatternsArgs args, CustomResourceOptions? opts = null)
public ObjectWebfilterProfileAntiphishCustompatterns(String name, ObjectWebfilterProfileAntiphishCustompatternsArgs args)
public ObjectWebfilterProfileAntiphishCustompatterns(String name, ObjectWebfilterProfileAntiphishCustompatternsArgs args, CustomResourceOptions options)
type: fortimanager:ObjectWebfilterProfileAntiphishCustompatterns
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ObjectWebfilterProfileAntiphishCustompatternsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ObjectWebfilterProfileAntiphishCustompatternsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ObjectWebfilterProfileAntiphishCustompatternsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ObjectWebfilterProfileAntiphishCustompatternsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ObjectWebfilterProfileAntiphishCustompatternsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var objectWebfilterProfileAntiphishCustompatternsResource = new Fortimanager.ObjectWebfilterProfileAntiphishCustompatterns("objectWebfilterProfileAntiphishCustompatternsResource", new()
{
    Profile = "string",
    Adom = "string",
    Category = "string",
    ObjectWebfilterProfileAntiphishCustompatternsId = "string",
    Pattern = "string",
    Scopetype = "string",
    Type = "string",
});
Copy
example, err := fortimanager.NewObjectWebfilterProfileAntiphishCustompatterns(ctx, "objectWebfilterProfileAntiphishCustompatternsResource", &fortimanager.ObjectWebfilterProfileAntiphishCustompatternsArgs{
Profile: pulumi.String("string"),
Adom: pulumi.String("string"),
Category: pulumi.String("string"),
ObjectWebfilterProfileAntiphishCustompatternsId: pulumi.String("string"),
Pattern: pulumi.String("string"),
Scopetype: pulumi.String("string"),
Type: pulumi.String("string"),
})
Copy
var objectWebfilterProfileAntiphishCustompatternsResource = new ObjectWebfilterProfileAntiphishCustompatterns("objectWebfilterProfileAntiphishCustompatternsResource", ObjectWebfilterProfileAntiphishCustompatternsArgs.builder()
    .profile("string")
    .adom("string")
    .category("string")
    .objectWebfilterProfileAntiphishCustompatternsId("string")
    .pattern("string")
    .scopetype("string")
    .type("string")
    .build());
Copy
object_webfilter_profile_antiphish_custompatterns_resource = fortimanager.ObjectWebfilterProfileAntiphishCustompatterns("objectWebfilterProfileAntiphishCustompatternsResource",
    profile="string",
    adom="string",
    category="string",
    object_webfilter_profile_antiphish_custompatterns_id="string",
    pattern="string",
    scopetype="string",
    type="string")
Copy
const objectWebfilterProfileAntiphishCustompatternsResource = new fortimanager.ObjectWebfilterProfileAntiphishCustompatterns("objectWebfilterProfileAntiphishCustompatternsResource", {
    profile: "string",
    adom: "string",
    category: "string",
    objectWebfilterProfileAntiphishCustompatternsId: "string",
    pattern: "string",
    scopetype: "string",
    type: "string",
});
Copy
type: fortimanager:ObjectWebfilterProfileAntiphishCustompatterns
properties:
    adom: string
    category: string
    objectWebfilterProfileAntiphishCustompatternsId: string
    pattern: string
    profile: string
    scopetype: string
    type: string
Copy

ObjectWebfilterProfileAntiphishCustompatterns Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ObjectWebfilterProfileAntiphishCustompatterns resource accepts the following input properties:

Profile This property is required. string
Profile.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Category string
Category that the pattern matches. Valid values: username, password.
ObjectWebfilterProfileAntiphishCustompatternsId string
an identifier for the resource with format {{pattern}}.
Pattern string
Target pattern.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Type string
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
Profile This property is required. string
Profile.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Category string
Category that the pattern matches. Valid values: username, password.
ObjectWebfilterProfileAntiphishCustompatternsId string
an identifier for the resource with format {{pattern}}.
Pattern string
Target pattern.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Type string
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
profile This property is required. String
Profile.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category String
Category that the pattern matches. Valid values: username, password.
objectWebfilterProfileAntiphishCustompatternsId String
an identifier for the resource with format {{pattern}}.
pattern String
Target pattern.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type String
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
profile This property is required. string
Profile.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category string
Category that the pattern matches. Valid values: username, password.
objectWebfilterProfileAntiphishCustompatternsId string
an identifier for the resource with format {{pattern}}.
pattern string
Target pattern.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type string
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
profile This property is required. str
Profile.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category str
Category that the pattern matches. Valid values: username, password.
object_webfilter_profile_antiphish_custompatterns_id str
an identifier for the resource with format {{pattern}}.
pattern str
Target pattern.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type str
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
profile This property is required. String
Profile.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category String
Category that the pattern matches. Valid values: username, password.
objectWebfilterProfileAntiphishCustompatternsId String
an identifier for the resource with format {{pattern}}.
pattern String
Target pattern.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type String
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.

Outputs

All input properties are implicitly available as output properties. Additionally, the ObjectWebfilterProfileAntiphishCustompatterns resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ObjectWebfilterProfileAntiphishCustompatterns Resource

Get an existing ObjectWebfilterProfileAntiphishCustompatterns resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ObjectWebfilterProfileAntiphishCustompatternsState, opts?: CustomResourceOptions): ObjectWebfilterProfileAntiphishCustompatterns
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        category: Optional[str] = None,
        object_webfilter_profile_antiphish_custompatterns_id: Optional[str] = None,
        pattern: Optional[str] = None,
        profile: Optional[str] = None,
        scopetype: Optional[str] = None,
        type: Optional[str] = None) -> ObjectWebfilterProfileAntiphishCustompatterns
func GetObjectWebfilterProfileAntiphishCustompatterns(ctx *Context, name string, id IDInput, state *ObjectWebfilterProfileAntiphishCustompatternsState, opts ...ResourceOption) (*ObjectWebfilterProfileAntiphishCustompatterns, error)
public static ObjectWebfilterProfileAntiphishCustompatterns Get(string name, Input<string> id, ObjectWebfilterProfileAntiphishCustompatternsState? state, CustomResourceOptions? opts = null)
public static ObjectWebfilterProfileAntiphishCustompatterns get(String name, Output<String> id, ObjectWebfilterProfileAntiphishCustompatternsState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectWebfilterProfileAntiphishCustompatterns    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Category string
Category that the pattern matches. Valid values: username, password.
ObjectWebfilterProfileAntiphishCustompatternsId string
an identifier for the resource with format {{pattern}}.
Pattern string
Target pattern.
Profile string
Profile.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Type string
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Category string
Category that the pattern matches. Valid values: username, password.
ObjectWebfilterProfileAntiphishCustompatternsId string
an identifier for the resource with format {{pattern}}.
Pattern string
Target pattern.
Profile string
Profile.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Type string
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category String
Category that the pattern matches. Valid values: username, password.
objectWebfilterProfileAntiphishCustompatternsId String
an identifier for the resource with format {{pattern}}.
pattern String
Target pattern.
profile String
Profile.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type String
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category string
Category that the pattern matches. Valid values: username, password.
objectWebfilterProfileAntiphishCustompatternsId string
an identifier for the resource with format {{pattern}}.
pattern string
Target pattern.
profile string
Profile.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type string
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category str
Category that the pattern matches. Valid values: username, password.
object_webfilter_profile_antiphish_custompatterns_id str
an identifier for the resource with format {{pattern}}.
pattern str
Target pattern.
profile str
Profile.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type str
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
category String
Category that the pattern matches. Valid values: username, password.
objectWebfilterProfileAntiphishCustompatternsId String
an identifier for the resource with format {{pattern}}.
pattern String
Target pattern.
profile String
Profile.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
type String
Pattern will be treated either as a regex pattern or literal string. Valid values: regex, literal.

Import

ObjectWebfilter ProfileAntiphishCustomPatterns can be imported using any of these accepted formats:

Set import_options = [“profile=YOUR_VALUE”] in the provider section.

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectWebfilterProfileAntiphishCustompatterns:ObjectWebfilterProfileAntiphishCustompatterns labelname {{pattern}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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