Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. filter
  5. filter/email
  6. Fortishield
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.filter/email.Fortishield

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure FortiGuard - AntiSpam. Applies to FortiOS Version >= 6.2.4.

    Create Fortishield Resource

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

    Constructor syntax

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

@overload
def Fortishield(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                spam_submit_force: Optional[str] = None,
                spam_submit_srv: Optional[str] = None,
                spam_submit_txt2htm: Optional[str] = None,
                vdomparam: Optional[str] = None)
    func NewFortishield(ctx *Context, name string, args *FortishieldArgs, opts ...ResourceOption) (*Fortishield, error)
    public Fortishield(string name, FortishieldArgs? args = null, CustomResourceOptions? opts = null)
    public Fortishield(String name, FortishieldArgs args)
public Fortishield(String name, FortishieldArgs args, CustomResourceOptions options)

    type: fortios:filter/email/fortishield:Fortishield
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 FortishieldArgs
    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 FortishieldArgs
    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 FortishieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FortishieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FortishieldArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    SpamSubmitForce string
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    SpamSubmitSrv string
    Hostname of the spam submission server.
    SpamSubmitTxt2htm string
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    SpamSubmitForce string
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    SpamSubmitSrv string
    Hostname of the spam submission server.
    SpamSubmitTxt2htm string
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spamSubmitForce String
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spamSubmitSrv String
    Hostname of the spam submission server.
    spamSubmitTxt2htm String
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spamSubmitForce string
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spamSubmitSrv string
    Hostname of the spam submission server.
    spamSubmitTxt2htm string
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spam_submit_force str
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spam_submit_srv str
    Hostname of the spam submission server.
    spam_submit_txt2htm str
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spamSubmitForce String
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spamSubmitSrv String
    Hostname of the spam submission server.
    spamSubmitTxt2htm String
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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 Fortishield 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 Fortishield Resource

    Get an existing Fortishield 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?: FortishieldState, opts?: CustomResourceOptions): Fortishield
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        spam_submit_force: Optional[str] = None,
        spam_submit_srv: Optional[str] = None,
        spam_submit_txt2htm: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Fortishield
    func GetFortishield(ctx *Context, name string, id IDInput, state *FortishieldState, opts ...ResourceOption) (*Fortishield, error)
    public static Fortishield Get(string name, Input<string> id, FortishieldState? state, CustomResourceOptions? opts = null)
    public static Fortishield get(String name, Output<String> id, FortishieldState 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:
    SpamSubmitForce string
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    SpamSubmitSrv string
    Hostname of the spam submission server.
    SpamSubmitTxt2htm string
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    SpamSubmitForce string
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    SpamSubmitSrv string
    Hostname of the spam submission server.
    SpamSubmitTxt2htm string
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spamSubmitForce String
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spamSubmitSrv String
    Hostname of the spam submission server.
    spamSubmitTxt2htm String
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spamSubmitForce string
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spamSubmitSrv string
    Hostname of the spam submission server.
    spamSubmitTxt2htm string
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spam_submit_force str
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spam_submit_srv str
    Hostname of the spam submission server.
    spam_submit_txt2htm str
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.
    spamSubmitForce String
    Enable/disable force insertion of a new mime entity for the submission text. Valid values: enable, disable.
    spamSubmitSrv String
    Hostname of the spam submission server.
    spamSubmitTxt2htm String
    Enable/disable conversion of text email to HTML email. Valid values: enable, disable.
    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.

    Import

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

    $ pulumi import fortios:filter/email/fortishield:Fortishield labelname EmailfilterFortishield

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:filter/email/fortishield:Fortishield labelname EmailfilterFortishield

    $ 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 logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios