Fortios v0.0.6, Jul 9 24

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.filter/email.Bword

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

Create Bword Resource

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

Constructor syntax

new Bword(name: string, args?: BwordArgs, opts?: CustomResourceOptions);

@overload
def Bword(resource_name: str,
          args: Optional[BwordArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Bword(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          comment: Optional[str] = None,
          dynamic_sort_subtable: Optional[str] = None,
          entries: Optional[Sequence[BwordEntryArgs]] = None,
          fosid: Optional[int] = None,
          get_all_tables: Optional[str] = None,
          name: Optional[str] = None,
          vdomparam: Optional[str] = None)

func NewBword(ctx *Context, name string, args *BwordArgs, opts ...ResourceOption) (*Bword, error)

public Bword(string name, BwordArgs? args = null, CustomResourceOptions? opts = null)

public Bword(String name, BwordArgs args)
public Bword(String name, BwordArgs args, CustomResourceOptions options)

type: fortios:filter/email/bword:Bword
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args BwordArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args BwordArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BwordArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BwordArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BwordArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Bword Resource Properties

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

Inputs

The Bword resource accepts the following input properties:

Comment string: Optional comments.
DynamicSortSubtable string: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries List<Pulumiverse.Fortios.Filter.Email.Inputs.BwordEntry>: Spam filter banned word. The structure of entries block is documented below.
Fosid int: ID.
GetAllTables string: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string: Name of table.
Vdomparam string: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Comment string: Optional comments.
DynamicSortSubtable string: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries []BwordEntryArgs: Spam filter banned word. The structure of entries block is documented below.
Fosid int: ID.
GetAllTables string: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string: Name of table.
Vdomparam string: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment String: Optional comments.
dynamicSortSubtable String: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<BwordEntry>: Spam filter banned word. The structure of entries block is documented below.
fosid Integer: ID.
getAllTables String: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String: Name of table.
vdomparam String: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment string: Optional comments.
dynamicSortSubtable string: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries BwordEntry[]: Spam filter banned word. The structure of entries block is documented below.
fosid number: ID.
getAllTables string: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name string: Name of table.
vdomparam string: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment str: Optional comments.
dynamic_sort_subtable str: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries Sequence[BwordEntryArgs]: Spam filter banned word. The structure of entries block is documented below.
fosid int: ID.
get_all_tables str: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name str: Name of table.
vdomparam str: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment String: Optional comments.
dynamicSortSubtable String: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<Property Map>: Spam filter banned word. The structure of entries block is documented below.
fosid Number: ID.
getAllTables String: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String: Name of table.
vdomparam String: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

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

Get an existing Bword 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?: BwordState, opts?: CustomResourceOptions): Bword

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        entries: Optional[Sequence[BwordEntryArgs]] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Bword

func GetBword(ctx *Context, name string, id IDInput, state *BwordState, opts ...ResourceOption) (*Bword, error)

public static Bword Get(string name, Input<string> id, BwordState? state, CustomResourceOptions? opts = null)

public static Bword get(String name, Output<String> id, BwordState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

Comment string: Optional comments.
DynamicSortSubtable string: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries List<Pulumiverse.Fortios.Filter.Email.Inputs.BwordEntry>: Spam filter banned word. The structure of entries block is documented below.
Fosid int: ID.
GetAllTables string: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string: Name of table.
Vdomparam string: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Comment string: Optional comments.
DynamicSortSubtable string: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
Entries []BwordEntryArgs: Spam filter banned word. The structure of entries block is documented below.
Fosid int: ID.
GetAllTables string: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Name string: Name of table.
Vdomparam string: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment String: Optional comments.
dynamicSortSubtable String: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<BwordEntry>: Spam filter banned word. The structure of entries block is documented below.
fosid Integer: ID.
getAllTables String: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String: Name of table.
vdomparam String: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment string: Optional comments.
dynamicSortSubtable string: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries BwordEntry[]: Spam filter banned word. The structure of entries block is documented below.
fosid number: ID.
getAllTables string: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name string: Name of table.
vdomparam string: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment str: Optional comments.
dynamic_sort_subtable str: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries Sequence[BwordEntryArgs]: Spam filter banned word. The structure of entries block is documented below.
fosid int: ID.
get_all_tables str: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name str: Name of table.
vdomparam str: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

comment String: Optional comments.
dynamicSortSubtable String: Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
entries List<Property Map>: Spam filter banned word. The structure of entries block is documented below.
fosid Number: ID.
getAllTables String: Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name String: Name of table.
vdomparam String: Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Supporting Types

BwordEntry, BwordEntryArgs

Action string: Mark spam or good. Valid values: spam, clear.
Id int: 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 int: Score value.
Status string: Enable/disable status. Valid values: enable, disable.
Where string: Component of the email to be scanned. Valid values: subject, body, all.

Action string: Mark spam or good. Valid values: spam, clear.
Id int: 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 int: Score value.
Status string: Enable/disable status. Valid values: enable, disable.
Where string: Component of the email to be scanned. Valid values: subject, body, all.

action String: Mark spam or good. Valid values: spam, clear.
id Integer: 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 Integer: Score value.
status String: Enable/disable status. Valid values: enable, disable.
where String: Component of the email to be scanned. Valid values: subject, body, all.

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: enable, disable.
where string: Component of the email to be scanned. Valid values: subject, body, all.

action str: Mark spam or good. Valid values: spam, clear.
id int: 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 int: Score value.
status str: Enable/disable status. Valid values: enable, disable.
where str: Component of the email to be scanned. Valid values: subject, body, all.

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: enable, disable.
where String: Component of the email to be scanned. Valid values: subject, body, all.

Import

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

$ pulumi import fortios:filter/email/bword:Bword labelname {{fosid}}

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:filter/email/bword:Bword labelname {{fosid}}

$ unset “FORTIOS_IMPORT_TABLE”

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

Package Details

Repository: fortios pulumiverse/pulumi-fortios
License: Apache-2.0
Notes: This Pulumi package is based on the fortios Terraform Provider.

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.filter/email.Bword

On this page

On this page

Create Bword Resource

Constructor syntax

Parameters

Bword Resource Properties

Inputs

Outputs

Look up Existing Bword Resource

Supporting Types

BwordEntry, BwordEntryArgs

Import

Package Details

On this page

On this page