fortios.filter/video.Keyword
Explore with Pulumi AI
Configure video filter keywords. Applies to FortiOS Version >= 7.4.2
.
Create Keyword Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Keyword(name: string, args?: KeywordArgs, opts?: CustomResourceOptions);
@overload
def Keyword(resource_name: str,
args: Optional[KeywordArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Keyword(resource_name: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
dynamic_sort_subtable: Optional[str] = None,
fosid: Optional[int] = None,
get_all_tables: Optional[str] = None,
match: Optional[str] = None,
name: Optional[str] = None,
vdomparam: Optional[str] = None,
words: Optional[Sequence[KeywordWordArgs]] = None)
func NewKeyword(ctx *Context, name string, args *KeywordArgs, opts ...ResourceOption) (*Keyword, error)
public Keyword(string name, KeywordArgs? args = null, CustomResourceOptions? opts = null)
public Keyword(String name, KeywordArgs args)
public Keyword(String name, KeywordArgs args, CustomResourceOptions options)
type: fortios:filter/video/keyword:Keyword
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 KeywordArgs
- 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 KeywordArgs
- 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 KeywordArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KeywordArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KeywordArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Keyword 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 Keyword resource accepts the following input properties:
- Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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 ].
- Fosid int
- ID.
- Get
All stringTables - 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.
- Match string
- Keyword matching logic. Valid values:
or
,and
. - Name string
- Name.
- 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.
- Words
List<Pulumiverse.
Fortios. Filter. Video. Inputs. Keyword Word> - List of keywords. The structure of
word
block is documented below.
- Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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 ].
- Fosid int
- ID.
- Get
All stringTables - 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.
- Match string
- Keyword matching logic. Valid values:
or
,and
. - Name string
- Name.
- 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.
- Words
[]Keyword
Word Args - List of keywords. The structure of
word
block is documented below.
- comment String
- Comment.
- dynamic
Sort StringSubtable - 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 ].
- fosid Integer
- ID.
- get
All StringTables - 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.
- match String
- Keyword matching logic. Valid values:
or
,and
. - name String
- Name.
- 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.
- words
List<Keyword
Word> - List of keywords. The structure of
word
block is documented below.
- comment string
- Comment.
- dynamic
Sort stringSubtable - 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 ].
- fosid number
- ID.
- get
All stringTables - 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.
- match string
- Keyword matching logic. Valid values:
or
,and
. - name string
- Name.
- 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.
- words
Keyword
Word[] - List of keywords. The structure of
word
block is documented below.
- comment str
- Comment.
- dynamic_
sort_ strsubtable - 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 ].
- fosid int
- ID.
- get_
all_ strtables - 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.
- match str
- Keyword matching logic. Valid values:
or
,and
. - name str
- Name.
- 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.
- words
Sequence[Keyword
Word Args] - List of keywords. The structure of
word
block is documented below.
- comment String
- Comment.
- dynamic
Sort StringSubtable - 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 ].
- fosid Number
- ID.
- get
All StringTables - 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.
- match String
- Keyword matching logic. Valid values:
or
,and
. - name String
- Name.
- 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.
- words List<Property Map>
- List of keywords. The structure of
word
block is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Keyword 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 Keyword Resource
Get an existing Keyword 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?: KeywordState, opts?: CustomResourceOptions): Keyword
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
comment: Optional[str] = None,
dynamic_sort_subtable: Optional[str] = None,
fosid: Optional[int] = None,
get_all_tables: Optional[str] = None,
match: Optional[str] = None,
name: Optional[str] = None,
vdomparam: Optional[str] = None,
words: Optional[Sequence[KeywordWordArgs]] = None) -> Keyword
func GetKeyword(ctx *Context, name string, id IDInput, state *KeywordState, opts ...ResourceOption) (*Keyword, error)
public static Keyword Get(string name, Input<string> id, KeywordState? state, CustomResourceOptions? opts = null)
public static Keyword get(String name, Output<String> id, KeywordState state, CustomResourceOptions options)
resources: _: type: fortios:filter/video/keyword:Keyword get: id: ${id}
- 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.
- Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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 ].
- Fosid int
- ID.
- Get
All stringTables - 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.
- Match string
- Keyword matching logic. Valid values:
or
,and
. - Name string
- Name.
- 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.
- Words
List<Pulumiverse.
Fortios. Filter. Video. Inputs. Keyword Word> - List of keywords. The structure of
word
block is documented below.
- Comment string
- Comment.
- Dynamic
Sort stringSubtable - 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 ].
- Fosid int
- ID.
- Get
All stringTables - 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.
- Match string
- Keyword matching logic. Valid values:
or
,and
. - Name string
- Name.
- 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.
- Words
[]Keyword
Word Args - List of keywords. The structure of
word
block is documented below.
- comment String
- Comment.
- dynamic
Sort StringSubtable - 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 ].
- fosid Integer
- ID.
- get
All StringTables - 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.
- match String
- Keyword matching logic. Valid values:
or
,and
. - name String
- Name.
- 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.
- words
List<Keyword
Word> - List of keywords. The structure of
word
block is documented below.
- comment string
- Comment.
- dynamic
Sort stringSubtable - 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 ].
- fosid number
- ID.
- get
All stringTables - 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.
- match string
- Keyword matching logic. Valid values:
or
,and
. - name string
- Name.
- 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.
- words
Keyword
Word[] - List of keywords. The structure of
word
block is documented below.
- comment str
- Comment.
- dynamic_
sort_ strsubtable - 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 ].
- fosid int
- ID.
- get_
all_ strtables - 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.
- match str
- Keyword matching logic. Valid values:
or
,and
. - name str
- Name.
- 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.
- words
Sequence[Keyword
Word Args] - List of keywords. The structure of
word
block is documented below.
- comment String
- Comment.
- dynamic
Sort StringSubtable - 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 ].
- fosid Number
- ID.
- get
All StringTables - 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.
- match String
- Keyword matching logic. Valid values:
or
,and
. - name String
- Name.
- 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.
- words List<Property Map>
- List of keywords. The structure of
word
block is documented below.
Supporting Types
KeywordWord, KeywordWordArgs
- Comment string
- Comment.
- Name string
- Name.
- Pattern
Type string - Pattern type. Valid values:
wildcard
,regex
. - Status string
- Enable(consider)/disable(ignore) this keyword. Valid values:
enable
,disable
.
- Comment string
- Comment.
- Name string
- Name.
- Pattern
Type string - Pattern type. Valid values:
wildcard
,regex
. - Status string
- Enable(consider)/disable(ignore) this keyword. Valid values:
enable
,disable
.
- comment String
- Comment.
- name String
- Name.
- pattern
Type String - Pattern type. Valid values:
wildcard
,regex
. - status String
- Enable(consider)/disable(ignore) this keyword. Valid values:
enable
,disable
.
- comment string
- Comment.
- name string
- Name.
- pattern
Type string - Pattern type. Valid values:
wildcard
,regex
. - status string
- Enable(consider)/disable(ignore) this keyword. Valid values:
enable
,disable
.
- comment str
- Comment.
- name str
- Name.
- pattern_
type str - Pattern type. Valid values:
wildcard
,regex
. - status str
- Enable(consider)/disable(ignore) this keyword. Valid values:
enable
,disable
.
- comment String
- Comment.
- name String
- Name.
- pattern
Type String - Pattern type. Valid values:
wildcard
,regex
. - status String
- Enable(consider)/disable(ignore) this keyword. Valid values:
enable
,disable
.
Import
Videofilter Keyword can be imported using any of these accepted formats:
$ pulumi import fortios:filter/video/keyword:Keyword labelname {{fosid}}
If you do not want to import arguments of block:
$ export “FORTIOS_IMPORT_TABLE”=“false”
$ pulumi import fortios:filter/video/keyword:Keyword 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.