@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
389 lines (388 loc) • 14.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Trigger for automation stitches.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.system.Automationtrigger("trname", {
* eventType: "event-log",
* iocLevel: "high",
* licenseType: "forticare-support",
* logid: 32002,
* triggerFrequency: "daily",
* triggerMinute: 60,
* triggerType: "event-based",
* });
* ```
*
* ## Import
*
* System AutomationTrigger can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:system/automationtrigger:Automationtrigger labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:system/automationtrigger:Automationtrigger labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Automationtrigger extends pulumi.CustomResource {
/**
* Get an existing Automationtrigger resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AutomationtriggerState, opts?: pulumi.CustomResourceOptions): Automationtrigger;
/**
* Returns true if the given object is an instance of Automationtrigger. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Automationtrigger;
/**
* Description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* Event type.
*/
readonly eventType: pulumi.Output<string>;
/**
* Fabric connector event handler name.
*/
readonly fabricEventName: pulumi.Output<string | undefined>;
/**
* Fabric connector event severity.
*/
readonly fabricEventSeverity: pulumi.Output<string | undefined>;
/**
* FortiAnalyzer event handler name.
*/
readonly fazEventName: pulumi.Output<string | undefined>;
/**
* FortiAnalyzer event severity.
*/
readonly fazEventSeverity: pulumi.Output<string | undefined>;
/**
* FortiAnalyzer event tags.
*/
readonly fazEventTags: pulumi.Output<string | undefined>;
/**
* Customized trigger field settings. The structure of `fields` block is documented below.
*/
readonly fields: pulumi.Output<outputs.system.AutomationtriggerField[] | undefined>;
/**
* 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.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* IOC threat level. Valid values: `medium`, `high`.
*/
readonly iocLevel: pulumi.Output<string>;
/**
* License type.
*/
readonly licenseType: pulumi.Output<string>;
/**
* Log ID to trigger event. *Due to the data type change of API, for other versions of FortiOS, please check variable `logidBlock`.*
*/
readonly logid: pulumi.Output<number>;
/**
* Log IDs to trigger event. *Due to the data type change of API, for other versions of FortiOS, please check variable `logid`.* The structure of `logidBlock` block is documented below.
*/
readonly logidBlocks: pulumi.Output<outputs.system.AutomationtriggerLogidBlock[] | undefined>;
/**
* Name.
*/
readonly name: pulumi.Output<string>;
/**
* Security Rating report.
*/
readonly reportType: pulumi.Output<string>;
/**
* Fabric connector serial number.
*/
readonly serial: pulumi.Output<string | undefined>;
/**
* Trigger date and time (YYYY-MM-DD HH:MM:SS).
*/
readonly triggerDatetime: pulumi.Output<string>;
/**
* Day within a month to trigger.
*/
readonly triggerDay: pulumi.Output<number>;
/**
* Scheduled trigger frequency (default = daily).
*/
readonly triggerFrequency: pulumi.Output<string>;
/**
* Hour of the day on which to trigger (0 - 23, default = 1).
*/
readonly triggerHour: pulumi.Output<number>;
/**
* Minute of the hour on which to trigger (0 - 59, default = 0).
*/
readonly triggerMinute: pulumi.Output<number>;
/**
* Trigger type. Valid values: `event-based`, `scheduled`.
*/
readonly triggerType: pulumi.Output<string>;
/**
* Day of week for trigger. Valid values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
*/
readonly triggerWeekday: pulumi.Output<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.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Virtual domain(s) that this trigger is valid for. The structure of `vdom` block is documented below.
*/
readonly vdoms: pulumi.Output<outputs.system.AutomationtriggerVdom[] | undefined>;
/**
* Create a Automationtrigger resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: AutomationtriggerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Automationtrigger resources.
*/
export interface AutomationtriggerState {
/**
* Description.
*/
description?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Event type.
*/
eventType?: pulumi.Input<string>;
/**
* Fabric connector event handler name.
*/
fabricEventName?: pulumi.Input<string>;
/**
* Fabric connector event severity.
*/
fabricEventSeverity?: pulumi.Input<string>;
/**
* FortiAnalyzer event handler name.
*/
fazEventName?: pulumi.Input<string>;
/**
* FortiAnalyzer event severity.
*/
fazEventSeverity?: pulumi.Input<string>;
/**
* FortiAnalyzer event tags.
*/
fazEventTags?: pulumi.Input<string>;
/**
* Customized trigger field settings. The structure of `fields` block is documented below.
*/
fields?: pulumi.Input<pulumi.Input<inputs.system.AutomationtriggerField>[]>;
/**
* 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.
*/
getAllTables?: pulumi.Input<string>;
/**
* IOC threat level. Valid values: `medium`, `high`.
*/
iocLevel?: pulumi.Input<string>;
/**
* License type.
*/
licenseType?: pulumi.Input<string>;
/**
* Log ID to trigger event. *Due to the data type change of API, for other versions of FortiOS, please check variable `logidBlock`.*
*/
logid?: pulumi.Input<number>;
/**
* Log IDs to trigger event. *Due to the data type change of API, for other versions of FortiOS, please check variable `logid`.* The structure of `logidBlock` block is documented below.
*/
logidBlocks?: pulumi.Input<pulumi.Input<inputs.system.AutomationtriggerLogidBlock>[]>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Security Rating report.
*/
reportType?: pulumi.Input<string>;
/**
* Fabric connector serial number.
*/
serial?: pulumi.Input<string>;
/**
* Trigger date and time (YYYY-MM-DD HH:MM:SS).
*/
triggerDatetime?: pulumi.Input<string>;
/**
* Day within a month to trigger.
*/
triggerDay?: pulumi.Input<number>;
/**
* Scheduled trigger frequency (default = daily).
*/
triggerFrequency?: pulumi.Input<string>;
/**
* Hour of the day on which to trigger (0 - 23, default = 1).
*/
triggerHour?: pulumi.Input<number>;
/**
* Minute of the hour on which to trigger (0 - 59, default = 0).
*/
triggerMinute?: pulumi.Input<number>;
/**
* Trigger type. Valid values: `event-based`, `scheduled`.
*/
triggerType?: pulumi.Input<string>;
/**
* Day of week for trigger. Valid values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
*/
triggerWeekday?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
/**
* Virtual domain(s) that this trigger is valid for. The structure of `vdom` block is documented below.
*/
vdoms?: pulumi.Input<pulumi.Input<inputs.system.AutomationtriggerVdom>[]>;
}
/**
* The set of arguments for constructing a Automationtrigger resource.
*/
export interface AutomationtriggerArgs {
/**
* Description.
*/
description?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* Event type.
*/
eventType?: pulumi.Input<string>;
/**
* Fabric connector event handler name.
*/
fabricEventName?: pulumi.Input<string>;
/**
* Fabric connector event severity.
*/
fabricEventSeverity?: pulumi.Input<string>;
/**
* FortiAnalyzer event handler name.
*/
fazEventName?: pulumi.Input<string>;
/**
* FortiAnalyzer event severity.
*/
fazEventSeverity?: pulumi.Input<string>;
/**
* FortiAnalyzer event tags.
*/
fazEventTags?: pulumi.Input<string>;
/**
* Customized trigger field settings. The structure of `fields` block is documented below.
*/
fields?: pulumi.Input<pulumi.Input<inputs.system.AutomationtriggerField>[]>;
/**
* 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.
*/
getAllTables?: pulumi.Input<string>;
/**
* IOC threat level. Valid values: `medium`, `high`.
*/
iocLevel?: pulumi.Input<string>;
/**
* License type.
*/
licenseType?: pulumi.Input<string>;
/**
* Log ID to trigger event. *Due to the data type change of API, for other versions of FortiOS, please check variable `logidBlock`.*
*/
logid?: pulumi.Input<number>;
/**
* Log IDs to trigger event. *Due to the data type change of API, for other versions of FortiOS, please check variable `logid`.* The structure of `logidBlock` block is documented below.
*/
logidBlocks?: pulumi.Input<pulumi.Input<inputs.system.AutomationtriggerLogidBlock>[]>;
/**
* Name.
*/
name?: pulumi.Input<string>;
/**
* Security Rating report.
*/
reportType?: pulumi.Input<string>;
/**
* Fabric connector serial number.
*/
serial?: pulumi.Input<string>;
/**
* Trigger date and time (YYYY-MM-DD HH:MM:SS).
*/
triggerDatetime?: pulumi.Input<string>;
/**
* Day within a month to trigger.
*/
triggerDay?: pulumi.Input<number>;
/**
* Scheduled trigger frequency (default = daily).
*/
triggerFrequency?: pulumi.Input<string>;
/**
* Hour of the day on which to trigger (0 - 23, default = 1).
*/
triggerHour?: pulumi.Input<number>;
/**
* Minute of the hour on which to trigger (0 - 59, default = 0).
*/
triggerMinute?: pulumi.Input<number>;
/**
* Trigger type. Valid values: `event-based`, `scheduled`.
*/
triggerType?: pulumi.Input<string>;
/**
* Day of week for trigger. Valid values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
*/
triggerWeekday?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
/**
* Virtual domain(s) that this trigger is valid for. The structure of `vdom` block is documented below.
*/
vdoms?: pulumi.Input<pulumi.Input<inputs.system.AutomationtriggerVdom>[]>;
}