Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectFilefilterProfileRules
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectFilefilterProfileRules

Explore with Pulumi AI

fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

File filter rules.

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

Create ObjectFilefilterProfileRules Resource

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

Constructor syntax

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

@overload
def ObjectFilefilterProfileRules(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 profile: Optional[str] = None,
                                 action: Optional[str] = None,
                                 adom: Optional[str] = None,
                                 comment: Optional[str] = None,
                                 direction: Optional[str] = None,
                                 file_types: Optional[Sequence[str]] = None,
                                 name: Optional[str] = None,
                                 object_filefilter_profile_rules_id: Optional[str] = None,
                                 password_protected: Optional[str] = None,
                                 protocols: Optional[Sequence[str]] = None,
                                 scopetype: Optional[str] = None)
func NewObjectFilefilterProfileRules(ctx *Context, name string, args ObjectFilefilterProfileRulesArgs, opts ...ResourceOption) (*ObjectFilefilterProfileRules, error)
public ObjectFilefilterProfileRules(string name, ObjectFilefilterProfileRulesArgs args, CustomResourceOptions? opts = null)
public ObjectFilefilterProfileRules(String name, ObjectFilefilterProfileRulesArgs args)
public ObjectFilefilterProfileRules(String name, ObjectFilefilterProfileRulesArgs args, CustomResourceOptions options)

type: fortimanager:ObjectFilefilterProfileRules
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. ObjectFilefilterProfileRulesArgs
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. ObjectFilefilterProfileRulesArgs
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. ObjectFilefilterProfileRulesArgs
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. ObjectFilefilterProfileRulesArgs
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. ObjectFilefilterProfileRulesArgs
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 objectFilefilterProfileRulesResource = new Fortimanager.ObjectFilefilterProfileRules("objectFilefilterProfileRulesResource", new()
{
    Profile = "string",
    Action = "string",
    Adom = "string",
    Comment = "string",
    Direction = "string",
    FileTypes = new[]
    {
        "string",
    },
    Name = "string",
    ObjectFilefilterProfileRulesId = "string",
    PasswordProtected = "string",
    Protocols = new[]
    {
        "string",
    },
    Scopetype = "string",
});
Copy
example, err := fortimanager.NewObjectFilefilterProfileRules(ctx, "objectFilefilterProfileRulesResource", &fortimanager.ObjectFilefilterProfileRulesArgs{
Profile: pulumi.String("string"),
Action: pulumi.String("string"),
Adom: pulumi.String("string"),
Comment: pulumi.String("string"),
Direction: pulumi.String("string"),
FileTypes: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
ObjectFilefilterProfileRulesId: pulumi.String("string"),
PasswordProtected: pulumi.String("string"),
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Scopetype: pulumi.String("string"),
})
Copy
var objectFilefilterProfileRulesResource = new ObjectFilefilterProfileRules("objectFilefilterProfileRulesResource", ObjectFilefilterProfileRulesArgs.builder()
    .profile("string")
    .action("string")
    .adom("string")
    .comment("string")
    .direction("string")
    .fileTypes("string")
    .name("string")
    .objectFilefilterProfileRulesId("string")
    .passwordProtected("string")
    .protocols("string")
    .scopetype("string")
    .build());
Copy
object_filefilter_profile_rules_resource = fortimanager.ObjectFilefilterProfileRules("objectFilefilterProfileRulesResource",
    profile="string",
    action="string",
    adom="string",
    comment="string",
    direction="string",
    file_types=["string"],
    name="string",
    object_filefilter_profile_rules_id="string",
    password_protected="string",
    protocols=["string"],
    scopetype="string")
Copy
const objectFilefilterProfileRulesResource = new fortimanager.ObjectFilefilterProfileRules("objectFilefilterProfileRulesResource", {
    profile: "string",
    action: "string",
    adom: "string",
    comment: "string",
    direction: "string",
    fileTypes: ["string"],
    name: "string",
    objectFilefilterProfileRulesId: "string",
    passwordProtected: "string",
    protocols: ["string"],
    scopetype: "string",
});
Copy
type: fortimanager:ObjectFilefilterProfileRules
properties:
    action: string
    adom: string
    comment: string
    direction: string
    fileTypes:
        - string
    name: string
    objectFilefilterProfileRulesId: string
    passwordProtected: string
    profile: string
    protocols:
        - string
    scopetype: string
Copy

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

Profile This property is required. string
Profile.
Action string
Action taken for matched file. Valid values: log-only, block.
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
Comment.
Direction string
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
FileTypes List<string>
Select file type.
Name string
File-filter rule name.
ObjectFilefilterProfileRulesId string
an identifier for the resource with format {{name}}.
PasswordProtected string
Match password-protected files. Valid values: any, yes.
Protocols List<string>
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
Profile This property is required. string
Profile.
Action string
Action taken for matched file. Valid values: log-only, block.
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
Comment.
Direction string
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
FileTypes []string
Select file type.
Name string
File-filter rule name.
ObjectFilefilterProfileRulesId string
an identifier for the resource with format {{name}}.
PasswordProtected string
Match password-protected files. Valid values: any, yes.
Protocols []string
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
profile This property is required. String
Profile.
action String
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction String
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
fileTypes List<String>
Select file type.
name String
File-filter rule name.
objectFilefilterProfileRulesId String
an identifier for the resource with format {{name}}.
passwordProtected String
Match password-protected files. Valid values: any, yes.
protocols List<String>
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
profile This property is required. string
Profile.
action string
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction string
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
fileTypes string[]
Select file type.
name string
File-filter rule name.
objectFilefilterProfileRulesId string
an identifier for the resource with format {{name}}.
passwordProtected string
Match password-protected files. Valid values: any, yes.
protocols string[]
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
profile This property is required. str
Profile.
action str
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction str
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
file_types Sequence[str]
Select file type.
name str
File-filter rule name.
object_filefilter_profile_rules_id str
an identifier for the resource with format {{name}}.
password_protected str
Match password-protected files. Valid values: any, yes.
protocols Sequence[str]
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
profile This property is required. String
Profile.
action String
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction String
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
fileTypes List<String>
Select file type.
name String
File-filter rule name.
objectFilefilterProfileRulesId String
an identifier for the resource with format {{name}}.
passwordProtected String
Match password-protected files. Valid values: any, yes.
protocols List<String>
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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 ObjectFilefilterProfileRules 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 ObjectFilefilterProfileRules Resource

Get an existing ObjectFilefilterProfileRules 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?: ObjectFilefilterProfileRulesState, opts?: CustomResourceOptions): ObjectFilefilterProfileRules
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        adom: Optional[str] = None,
        comment: Optional[str] = None,
        direction: Optional[str] = None,
        file_types: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        object_filefilter_profile_rules_id: Optional[str] = None,
        password_protected: Optional[str] = None,
        profile: Optional[str] = None,
        protocols: Optional[Sequence[str]] = None,
        scopetype: Optional[str] = None) -> ObjectFilefilterProfileRules
func GetObjectFilefilterProfileRules(ctx *Context, name string, id IDInput, state *ObjectFilefilterProfileRulesState, opts ...ResourceOption) (*ObjectFilefilterProfileRules, error)
public static ObjectFilefilterProfileRules Get(string name, Input<string> id, ObjectFilefilterProfileRulesState? state, CustomResourceOptions? opts = null)
public static ObjectFilefilterProfileRules get(String name, Output<String> id, ObjectFilefilterProfileRulesState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectFilefilterProfileRules    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:
Action string
Action taken for matched file. Valid values: log-only, block.
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
Comment.
Direction string
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
FileTypes List<string>
Select file type.
Name string
File-filter rule name.
ObjectFilefilterProfileRulesId string
an identifier for the resource with format {{name}}.
PasswordProtected string
Match password-protected files. Valid values: any, yes.
Profile string
Profile.
Protocols List<string>
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
Action string
Action taken for matched file. Valid values: log-only, block.
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
Comment.
Direction string
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
FileTypes []string
Select file type.
Name string
File-filter rule name.
ObjectFilefilterProfileRulesId string
an identifier for the resource with format {{name}}.
PasswordProtected string
Match password-protected files. Valid values: any, yes.
Profile string
Profile.
Protocols []string
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
action String
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction String
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
fileTypes List<String>
Select file type.
name String
File-filter rule name.
objectFilefilterProfileRulesId String
an identifier for the resource with format {{name}}.
passwordProtected String
Match password-protected files. Valid values: any, yes.
profile String
Profile.
protocols List<String>
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
action string
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction string
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
fileTypes string[]
Select file type.
name string
File-filter rule name.
objectFilefilterProfileRulesId string
an identifier for the resource with format {{name}}.
passwordProtected string
Match password-protected files. Valid values: any, yes.
profile string
Profile.
protocols string[]
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
action str
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction str
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
file_types Sequence[str]
Select file type.
name str
File-filter rule name.
object_filefilter_profile_rules_id str
an identifier for the resource with format {{name}}.
password_protected str
Match password-protected files. Valid values: any, yes.
profile str
Profile.
protocols Sequence[str]
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.
action String
Action taken for matched file. Valid values: log-only, block.
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
Comment.
direction String
Traffic direction. (HTTP, FTP, SSH, CIFS only) Valid values: any, incoming, outgoing.
fileTypes List<String>
Select file type.
name String
File-filter rule name.
objectFilefilterProfileRulesId String
an identifier for the resource with format {{name}}.
passwordProtected String
Match password-protected files. Valid values: any, yes.
profile String
Profile.
protocols List<String>
Protocols to apply rule to. Valid values: imap, smtp, pop3, http, ftp, mapi, cifs, ssh.
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.

Import

ObjectFileFilter ProfileRules 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/objectFilefilterProfileRules:ObjectFilefilterProfileRules labelname {{name}}
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.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager