1. Packages
  2. Fortios
  3. API Docs
  4. automation
  5. Setting
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.automation.Setting

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Automation setting configuration. Applies to FortiOS Version >= 7.2.0.

    Create Setting Resource

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

    Constructor syntax

    new Setting(name: string, args?: SettingArgs, opts?: CustomResourceOptions);
    @overload
    def Setting(resource_name: str,
                args: Optional[SettingArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Setting(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                fabric_sync: Optional[str] = None,
                max_concurrent_stitches: Optional[int] = None,
                vdomparam: Optional[str] = None)
    func NewSetting(ctx *Context, name string, args *SettingArgs, opts ...ResourceOption) (*Setting, error)
    public Setting(string name, SettingArgs? args = null, CustomResourceOptions? opts = null)
    public Setting(String name, SettingArgs args)
    public Setting(String name, SettingArgs args, CustomResourceOptions options)
    
    type: fortios:automation:Setting
    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 SettingArgs
    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 SettingArgs
    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 SettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SettingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var examplesettingResourceResourceFromAutomationsetting = new Fortios.Automation.Setting("examplesettingResourceResourceFromAutomationsetting", new()
    {
        FabricSync = "string",
        MaxConcurrentStitches = 0,
        Vdomparam = "string",
    });
    
    example, err := automation.NewSetting(ctx, "examplesettingResourceResourceFromAutomationsetting", &automation.SettingArgs{
    	FabricSync:            pulumi.String("string"),
    	MaxConcurrentStitches: pulumi.Int(0),
    	Vdomparam:             pulumi.String("string"),
    })
    
    var examplesettingResourceResourceFromAutomationsetting = new Setting("examplesettingResourceResourceFromAutomationsetting", SettingArgs.builder()
        .fabricSync("string")
        .maxConcurrentStitches(0)
        .vdomparam("string")
        .build());
    
    examplesetting_resource_resource_from_automationsetting = fortios.automation.Setting("examplesettingResourceResourceFromAutomationsetting",
        fabric_sync="string",
        max_concurrent_stitches=0,
        vdomparam="string")
    
    const examplesettingResourceResourceFromAutomationsetting = new fortios.automation.Setting("examplesettingResourceResourceFromAutomationsetting", {
        fabricSync: "string",
        maxConcurrentStitches: 0,
        vdomparam: "string",
    });
    
    type: fortios:automation:Setting
    properties:
        fabricSync: string
        maxConcurrentStitches: 0
        vdomparam: string
    

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

    FabricSync string
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    MaxConcurrentStitches int
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    FabricSync string
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    MaxConcurrentStitches int
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabricSync String
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    maxConcurrentStitches Integer
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabricSync string
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    maxConcurrentStitches number
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabric_sync str
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    max_concurrent_stitches int
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabricSync String
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    maxConcurrentStitches Number
    Maximum number of automation stitches that are allowed to run concurrently.
    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 Setting 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 Setting Resource

    Get an existing Setting 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?: SettingState, opts?: CustomResourceOptions): Setting
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fabric_sync: Optional[str] = None,
            max_concurrent_stitches: Optional[int] = None,
            vdomparam: Optional[str] = None) -> Setting
    func GetSetting(ctx *Context, name string, id IDInput, state *SettingState, opts ...ResourceOption) (*Setting, error)
    public static Setting Get(string name, Input<string> id, SettingState? state, CustomResourceOptions? opts = null)
    public static Setting get(String name, Output<String> id, SettingState 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:
    FabricSync string
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    MaxConcurrentStitches int
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    FabricSync string
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    MaxConcurrentStitches int
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabricSync String
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    maxConcurrentStitches Integer
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabricSync string
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    maxConcurrentStitches number
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabric_sync str
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    max_concurrent_stitches int
    Maximum number of automation stitches that are allowed to run concurrently.
    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.
    fabricSync String
    Enable/disable synchronization of automation settings with security fabric. Valid values: enable, disable.
    maxConcurrentStitches Number
    Maximum number of automation stitches that are allowed to run concurrently.
    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

    Automation Setting can be imported using any of these accepted formats:

    $ pulumi import fortios:automation/setting:Setting labelname AutomationSetting
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:automation/setting:Setting labelname AutomationSetting
    

    $ 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse