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

fortios.filter/email.Blockallowlist

Explore with Pulumi AI

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

    Configure anti-spam block/allow list. Applies to FortiOS Version >= 7.0.0.

    Create Blockallowlist Resource

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

    Constructor syntax

    new Blockallowlist(name: string, args?: BlockallowlistArgs, opts?: CustomResourceOptions);
    @overload
    def Blockallowlist(resource_name: str,
                       args: Optional[BlockallowlistArgs] = None,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def Blockallowlist(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       comment: Optional[str] = None,
                       dynamic_sort_subtable: Optional[str] = None,
                       entries: Optional[Sequence[BlockallowlistEntryArgs]] = None,
                       fosid: Optional[int] = None,
                       get_all_tables: Optional[str] = None,
                       name: Optional[str] = None,
                       vdomparam: Optional[str] = None)
    func NewBlockallowlist(ctx *Context, name string, args *BlockallowlistArgs, opts ...ResourceOption) (*Blockallowlist, error)
    public Blockallowlist(string name, BlockallowlistArgs? args = null, CustomResourceOptions? opts = null)
    public Blockallowlist(String name, BlockallowlistArgs args)
    public Blockallowlist(String name, BlockallowlistArgs args, CustomResourceOptions options)
    
    type: fortios:filter/email/blockallowlist:Blockallowlist
    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 BlockallowlistArgs
    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 BlockallowlistArgs
    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 BlockallowlistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BlockallowlistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BlockallowlistArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Blockallowlist 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 Blockallowlist 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.BlockallowlistEntry>
    Anti-spam block/allow entries. 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 []BlockallowlistEntryArgs
    Anti-spam block/allow entries. 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<BlockallowlistEntry>
    Anti-spam block/allow entries. 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 BlockallowlistEntry[]
    Anti-spam block/allow entries. 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[BlockallowlistEntryArgs]
    Anti-spam block/allow entries. 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>
    Anti-spam block/allow entries. 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 Blockallowlist 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 Blockallowlist Resource

    Get an existing Blockallowlist 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?: BlockallowlistState, opts?: CustomResourceOptions): Blockallowlist
    @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[BlockallowlistEntryArgs]] = None,
            fosid: Optional[int] = None,
            get_all_tables: Optional[str] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Blockallowlist
    func GetBlockallowlist(ctx *Context, name string, id IDInput, state *BlockallowlistState, opts ...ResourceOption) (*Blockallowlist, error)
    public static Blockallowlist Get(string name, Input<string> id, BlockallowlistState? state, CustomResourceOptions? opts = null)
    public static Blockallowlist get(String name, Output<String> id, BlockallowlistState 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.BlockallowlistEntry>
    Anti-spam block/allow entries. 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 []BlockallowlistEntryArgs
    Anti-spam block/allow entries. 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<BlockallowlistEntry>
    Anti-spam block/allow entries. 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 BlockallowlistEntry[]
    Anti-spam block/allow entries. 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[BlockallowlistEntryArgs]
    Anti-spam block/allow entries. 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>
    Anti-spam block/allow entries. 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

    BlockallowlistEntry, BlockallowlistEntryArgs

    Action string
    Reject, mark as spam or good email. Valid values: reject, spam, clear.
    AddrType string
    IP address type. Valid values: ipv4, ipv6.
    EmailPattern string
    Email address pattern.
    Id int
    Entry ID.
    Ip4Subnet string
    IPv4 network address/subnet mask bits.
    Ip6Subnet string
    IPv6 network address/subnet mask bits.
    Pattern string
    Pattern to match.
    PatternType string
    Wildcard pattern or regular expression. Valid values: wildcard, regexp.
    Status string
    Enable/disable status. Valid values: enable, disable.
    Type string
    Entry type.
    Action string
    Reject, mark as spam or good email. Valid values: reject, spam, clear.
    AddrType string
    IP address type. Valid values: ipv4, ipv6.
    EmailPattern string
    Email address pattern.
    Id int
    Entry ID.
    Ip4Subnet string
    IPv4 network address/subnet mask bits.
    Ip6Subnet string
    IPv6 network address/subnet mask bits.
    Pattern string
    Pattern to match.
    PatternType string
    Wildcard pattern or regular expression. Valid values: wildcard, regexp.
    Status string
    Enable/disable status. Valid values: enable, disable.
    Type string
    Entry type.
    action String
    Reject, mark as spam or good email. Valid values: reject, spam, clear.
    addrType String
    IP address type. Valid values: ipv4, ipv6.
    emailPattern String
    Email address pattern.
    id Integer
    Entry ID.
    ip4Subnet String
    IPv4 network address/subnet mask bits.
    ip6Subnet String
    IPv6 network address/subnet mask bits.
    pattern String
    Pattern to match.
    patternType String
    Wildcard pattern or regular expression. Valid values: wildcard, regexp.
    status String
    Enable/disable status. Valid values: enable, disable.
    type String
    Entry type.
    action string
    Reject, mark as spam or good email. Valid values: reject, spam, clear.
    addrType string
    IP address type. Valid values: ipv4, ipv6.
    emailPattern string
    Email address pattern.
    id number
    Entry ID.
    ip4Subnet string
    IPv4 network address/subnet mask bits.
    ip6Subnet string
    IPv6 network address/subnet mask bits.
    pattern string
    Pattern to match.
    patternType string
    Wildcard pattern or regular expression. Valid values: wildcard, regexp.
    status string
    Enable/disable status. Valid values: enable, disable.
    type string
    Entry type.
    action str
    Reject, mark as spam or good email. Valid values: reject, spam, clear.
    addr_type str
    IP address type. Valid values: ipv4, ipv6.
    email_pattern str
    Email address pattern.
    id int
    Entry ID.
    ip4_subnet str
    IPv4 network address/subnet mask bits.
    ip6_subnet str
    IPv6 network address/subnet mask bits.
    pattern str
    Pattern to match.
    pattern_type str
    Wildcard pattern or regular expression. Valid values: wildcard, regexp.
    status str
    Enable/disable status. Valid values: enable, disable.
    type str
    Entry type.
    action String
    Reject, mark as spam or good email. Valid values: reject, spam, clear.
    addrType String
    IP address type. Valid values: ipv4, ipv6.
    emailPattern String
    Email address pattern.
    id Number
    Entry ID.
    ip4Subnet String
    IPv4 network address/subnet mask bits.
    ip6Subnet String
    IPv6 network address/subnet mask bits.
    pattern String
    Pattern to match.
    patternType String
    Wildcard pattern or regular expression. Valid values: wildcard, regexp.
    status String
    Enable/disable status. Valid values: enable, disable.
    type String
    Entry type.

    Import

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

    $ pulumi import fortios:filter/email/blockallowlist:Blockallowlist labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

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