Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectEmailfilterBword
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectEmailfilterBword

Explore with Pulumi AI

fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

Configure AntiSpam banned word list.

The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • entries: fortimanager.ObjectEmailfilterBwordEntries

Example Usage

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

const trname = new fortimanager.ObjectEmailfilterBword("trname", {
    comment: "This is a Terraform example",
    fosid: 1,
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectEmailfilterBword("trname",
    comment="This is a Terraform example",
    fosid=1)
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 {
		_, err := fortimanager.NewObjectEmailfilterBword(ctx, "trname", &fortimanager.ObjectEmailfilterBwordArgs{
			Comment: pulumi.String("This is a Terraform example"),
			Fosid:   pulumi.Float64(1),
		})
		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 trname = new Fortimanager.ObjectEmailfilterBword("trname", new()
    {
        Comment = "This is a Terraform example",
        Fosid = 1,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectEmailfilterBword;
import com.pulumi.fortimanager.ObjectEmailfilterBwordArgs;
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 trname = new ObjectEmailfilterBword("trname", ObjectEmailfilterBwordArgs.builder()
            .comment("This is a Terraform example")
            .fosid(1)
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:ObjectEmailfilterBword
    properties:
      comment: This is a Terraform example
      fosid: 1
Copy

Create ObjectEmailfilterBword Resource

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

Constructor syntax

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

@overload
def ObjectEmailfilterBword(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           adom: Optional[str] = None,
                           comment: Optional[str] = None,
                           dynamic_sort_subtable: Optional[str] = None,
                           entries: Optional[Sequence[ObjectEmailfilterBwordEntryArgs]] = None,
                           fosid: Optional[float] = None,
                           name: Optional[str] = None,
                           object_emailfilter_bword_id: Optional[str] = None,
                           scopetype: Optional[str] = None)
func NewObjectEmailfilterBword(ctx *Context, name string, args *ObjectEmailfilterBwordArgs, opts ...ResourceOption) (*ObjectEmailfilterBword, error)
public ObjectEmailfilterBword(string name, ObjectEmailfilterBwordArgs? args = null, CustomResourceOptions? opts = null)
public ObjectEmailfilterBword(String name, ObjectEmailfilterBwordArgs args)
public ObjectEmailfilterBword(String name, ObjectEmailfilterBwordArgs args, CustomResourceOptions options)

type: fortimanager:ObjectEmailfilterBword
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 ObjectEmailfilterBwordArgs
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 ObjectEmailfilterBwordArgs
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 ObjectEmailfilterBwordArgs
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 ObjectEmailfilterBwordArgs
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. ObjectEmailfilterBwordArgs
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 objectEmailfilterBwordResource = new Fortimanager.ObjectEmailfilterBword("objectEmailfilterBwordResource", new()
{
    Adom = "string",
    Comment = "string",
    DynamicSortSubtable = "string",
    Entries = new[]
    {
        new Fortimanager.Inputs.ObjectEmailfilterBwordEntryArgs
        {
            Action = "string",
            Id = 0,
            Language = "string",
            Pattern = "string",
            PatternType = "string",
            Score = 0,
            Status = "string",
            Where = "string",
        },
    },
    Fosid = 0,
    Name = "string",
    ObjectEmailfilterBwordId = "string",
    Scopetype = "string",
});
Copy
example, err := fortimanager.NewObjectEmailfilterBword(ctx, "objectEmailfilterBwordResource", &fortimanager.ObjectEmailfilterBwordArgs{
Adom: pulumi.String("string"),
Comment: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
Entries: .ObjectEmailfilterBwordEntryArray{
&.ObjectEmailfilterBwordEntryArgs{
Action: pulumi.String("string"),
Id: pulumi.Float64(0),
Language: pulumi.String("string"),
Pattern: pulumi.String("string"),
PatternType: pulumi.String("string"),
Score: pulumi.Float64(0),
Status: pulumi.String("string"),
Where: pulumi.String("string"),
},
},
Fosid: pulumi.Float64(0),
Name: pulumi.String("string"),
ObjectEmailfilterBwordId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
})
Copy
var objectEmailfilterBwordResource = new ObjectEmailfilterBword("objectEmailfilterBwordResource", ObjectEmailfilterBwordArgs.builder()
    .adom("string")
    .comment("string")
    .dynamicSortSubtable("string")
    .entries(ObjectEmailfilterBwordEntryArgs.builder()
        .action("string")
        .id(0)
        .language("string")
        .pattern("string")
        .patternType("string")
        .score(0)
        .status("string")
        .where("string")
        .build())
    .fosid(0)
    .name("string")
    .objectEmailfilterBwordId("string")
    .scopetype("string")
    .build());
Copy
object_emailfilter_bword_resource = fortimanager.ObjectEmailfilterBword("objectEmailfilterBwordResource",
    adom="string",
    comment="string",
    dynamic_sort_subtable="string",
    entries=[{
        "action": "string",
        "id": 0,
        "language": "string",
        "pattern": "string",
        "pattern_type": "string",
        "score": 0,
        "status": "string",
        "where": "string",
    }],
    fosid=0,
    name="string",
    object_emailfilter_bword_id="string",
    scopetype="string")
Copy
const objectEmailfilterBwordResource = new fortimanager.ObjectEmailfilterBword("objectEmailfilterBwordResource", {
    adom: "string",
    comment: "string",
    dynamicSortSubtable: "string",
    entries: [{
        action: "string",
        id: 0,
        language: "string",
        pattern: "string",
        patternType: "string",
        score: 0,
        status: "string",
        where: "string",
    }],
    fosid: 0,
    name: "string",
    objectEmailfilterBwordId: "string",
    scopetype: "string",
});
Copy
type: fortimanager:ObjectEmailfilterBword
properties:
    adom: string
    comment: string
    dynamicSortSubtable: string
    entries:
        - action: string
          id: 0
          language: string
          pattern: string
          patternType: string
          score: 0
          status: string
          where: string
    fosid: 0
    name: string
    objectEmailfilterBwordId: string
    scopetype: string
Copy

ObjectEmailfilterBword 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 ObjectEmailfilterBword resource accepts the following input properties:

Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Comment string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Entries List<ObjectEmailfilterBwordEntry>
Entries. The structure of entries block is documented below.
Fosid double
ID.
Name string
Name of table.
ObjectEmailfilterBwordId string
an identifier for the resource with format {{fosid}}.
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.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Comment string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Entries []ObjectEmailfilterBwordEntryArgs
Entries. The structure of entries block is documented below.
Fosid float64
ID.
Name string
Name of table.
ObjectEmailfilterBwordId string
an identifier for the resource with format {{fosid}}.
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.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries List<ObjectEmailfilterBwordEntry>
Entries. The structure of entries block is documented below.
fosid Double
ID.
name String
Name of table.
objectEmailfilterBwordId String
an identifier for the resource with format {{fosid}}.
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.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment string
Optional comments.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries ObjectEmailfilterBwordEntry[]
Entries. The structure of entries block is documented below.
fosid number
ID.
name string
Name of table.
objectEmailfilterBwordId string
an identifier for the resource with format {{fosid}}.
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.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment str
Optional comments.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries Sequence[ObjectEmailfilterBwordEntryArgs]
Entries. The structure of entries block is documented below.
fosid float
ID.
name str
Name of table.
object_emailfilter_bword_id str
an identifier for the resource with format {{fosid}}.
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.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries List<Property Map>
Entries. The structure of entries block is documented below.
fosid Number
ID.
name String
Name of table.
objectEmailfilterBwordId String
an identifier for the resource with format {{fosid}}.
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the ObjectEmailfilterBword 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 ObjectEmailfilterBword Resource

Get an existing ObjectEmailfilterBword 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?: ObjectEmailfilterBwordState, opts?: CustomResourceOptions): ObjectEmailfilterBword
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        entries: Optional[Sequence[ObjectEmailfilterBwordEntryArgs]] = None,
        fosid: Optional[float] = None,
        name: Optional[str] = None,
        object_emailfilter_bword_id: Optional[str] = None,
        scopetype: Optional[str] = None) -> ObjectEmailfilterBword
func GetObjectEmailfilterBword(ctx *Context, name string, id IDInput, state *ObjectEmailfilterBwordState, opts ...ResourceOption) (*ObjectEmailfilterBword, error)
public static ObjectEmailfilterBword Get(string name, Input<string> id, ObjectEmailfilterBwordState? state, CustomResourceOptions? opts = null)
public static ObjectEmailfilterBword get(String name, Output<String> id, ObjectEmailfilterBwordState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectEmailfilterBword    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.
Comment string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Entries List<ObjectEmailfilterBwordEntry>
Entries. The structure of entries block is documented below.
Fosid double
ID.
Name string
Name of table.
ObjectEmailfilterBwordId string
an identifier for the resource with format {{fosid}}.
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.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
Comment string
Optional comments.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
Entries []ObjectEmailfilterBwordEntryArgs
Entries. The structure of entries block is documented below.
Fosid float64
ID.
Name string
Name of table.
ObjectEmailfilterBwordId string
an identifier for the resource with format {{fosid}}.
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.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries List<ObjectEmailfilterBwordEntry>
Entries. The structure of entries block is documented below.
fosid Double
ID.
name String
Name of table.
objectEmailfilterBwordId String
an identifier for the resource with format {{fosid}}.
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.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment string
Optional comments.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries ObjectEmailfilterBwordEntry[]
Entries. The structure of entries block is documented below.
fosid number
ID.
name string
Name of table.
objectEmailfilterBwordId string
an identifier for the resource with format {{fosid}}.
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.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment str
Optional comments.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries Sequence[ObjectEmailfilterBwordEntryArgs]
Entries. The structure of entries block is documented below.
fosid float
ID.
name str
Name of table.
object_emailfilter_bword_id str
an identifier for the resource with format {{fosid}}.
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.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
comment String
Optional comments.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
entries List<Property Map>
Entries. The structure of entries block is documented below.
fosid Number
ID.
name String
Name of table.
objectEmailfilterBwordId String
an identifier for the resource with format {{fosid}}.
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.

Supporting Types

ObjectEmailfilterBwordEntry
, ObjectEmailfilterBwordEntryArgs

Action string
Mark spam or good. Valid values: spam, clear.
Id double
Banned word entry ID.
Language string
Language for the banned word. Valid values: western, simch, trach, japanese, korean, french, thai, spanish.
Pattern string
Pattern for the banned word.
PatternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
Score double
Score value.
Status string
Enable/disable status. Valid values: disable, enable.
Where string
Component of the email to be scanned. Valid values: all, subject, body.
Action string
Mark spam or good. Valid values: spam, clear.
Id float64
Banned word entry ID.
Language string
Language for the banned word. Valid values: western, simch, trach, japanese, korean, french, thai, spanish.
Pattern string
Pattern for the banned word.
PatternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
Score float64
Score value.
Status string
Enable/disable status. Valid values: disable, enable.
Where string
Component of the email to be scanned. Valid values: all, subject, body.
action String
Mark spam or good. Valid values: spam, clear.
id Double
Banned word entry ID.
language String
Language for the banned word. Valid values: western, simch, trach, japanese, korean, french, thai, spanish.
pattern String
Pattern for the banned word.
patternType String
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
score Double
Score value.
status String
Enable/disable status. Valid values: disable, enable.
where String
Component of the email to be scanned. Valid values: all, subject, body.
action string
Mark spam or good. Valid values: spam, clear.
id number
Banned word entry ID.
language string
Language for the banned word. Valid values: western, simch, trach, japanese, korean, french, thai, spanish.
pattern string
Pattern for the banned word.
patternType string
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
score number
Score value.
status string
Enable/disable status. Valid values: disable, enable.
where string
Component of the email to be scanned. Valid values: all, subject, body.
action str
Mark spam or good. Valid values: spam, clear.
id float
Banned word entry ID.
language str
Language for the banned word. Valid values: western, simch, trach, japanese, korean, french, thai, spanish.
pattern str
Pattern for the banned word.
pattern_type str
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
score float
Score value.
status str
Enable/disable status. Valid values: disable, enable.
where str
Component of the email to be scanned. Valid values: all, subject, body.
action String
Mark spam or good. Valid values: spam, clear.
id Number
Banned word entry ID.
language String
Language for the banned word. Valid values: western, simch, trach, japanese, korean, french, thai, spanish.
pattern String
Pattern for the banned word.
patternType String
Wildcard pattern or regular expression. Valid values: wildcard, regexp.
score Number
Score value.
status String
Enable/disable status. Valid values: disable, enable.
where String
Component of the email to be scanned. Valid values: all, subject, body.

Import

ObjectEmailfilter Bword can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectEmailfilterBword:ObjectEmailfilterBword labelname {{fosid}}
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.
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager