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

fortios.log.Customfield

Explore with Pulumi AI

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

    Configure custom log fields.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.log.Customfield("trname", {
        fosid: "1",
        value: "logteststr",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.log.Customfield("trname",
        fosid="1",
        value="logteststr")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/log"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := log.NewCustomfield(ctx, "trname", &log.CustomfieldArgs{
    			Fosid: pulumi.String("1"),
    			Value: pulumi.String("logteststr"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname = new Fortios.Log.Customfield("trname", new()
        {
            Fosid = "1",
            Value = "logteststr",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.log.Customfield;
    import com.pulumi.fortios.log.CustomfieldArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var trname = new Customfield("trname", CustomfieldArgs.builder()        
                .fosid("1")
                .value("logteststr")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:log:Customfield
        properties:
          fosid: '1'
          value: logteststr
    

    Create Customfield Resource

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

    Constructor syntax

    new Customfield(name: string, args: CustomfieldArgs, opts?: CustomResourceOptions);
    @overload
    def Customfield(resource_name: str,
                    args: CustomfieldArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Customfield(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    value: Optional[str] = None,
                    fosid: Optional[str] = None,
                    name: Optional[str] = None,
                    vdomparam: Optional[str] = None)
    func NewCustomfield(ctx *Context, name string, args CustomfieldArgs, opts ...ResourceOption) (*Customfield, error)
    public Customfield(string name, CustomfieldArgs args, CustomResourceOptions? opts = null)
    public Customfield(String name, CustomfieldArgs args)
    public Customfield(String name, CustomfieldArgs args, CustomResourceOptions options)
    
    type: fortios:log:Customfield
    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 CustomfieldArgs
    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 CustomfieldArgs
    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 CustomfieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomfieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomfieldArgs
    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 customfieldResource = new Fortios.Log.Customfield("customfieldResource", new()
    {
        Value = "string",
        Fosid = "string",
        Name = "string",
        Vdomparam = "string",
    });
    
    example, err := log.NewCustomfield(ctx, "customfieldResource", &log.CustomfieldArgs{
    	Value:     pulumi.String("string"),
    	Fosid:     pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Vdomparam: pulumi.String("string"),
    })
    
    var customfieldResource = new Customfield("customfieldResource", CustomfieldArgs.builder()        
        .value("string")
        .fosid("string")
        .name("string")
        .vdomparam("string")
        .build());
    
    customfield_resource = fortios.log.Customfield("customfieldResource",
        value="string",
        fosid="string",
        name="string",
        vdomparam="string")
    
    const customfieldResource = new fortios.log.Customfield("customfieldResource", {
        value: "string",
        fosid: "string",
        name: "string",
        vdomparam: "string",
    });
    
    type: fortios:log:Customfield
    properties:
        fosid: string
        name: string
        value: string
        vdomparam: string
    

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

    Value string
    Field value (max: 15 characters).
    Fosid string
    field ID .
    Name string
    Field name (max: 15 characters).
    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.
    Value string
    Field value (max: 15 characters).
    Fosid string
    field ID .
    Name string
    Field name (max: 15 characters).
    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.
    value String
    Field value (max: 15 characters).
    fosid String
    field ID .
    name String
    Field name (max: 15 characters).
    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.
    value string
    Field value (max: 15 characters).
    fosid string
    field ID .
    name string
    Field name (max: 15 characters).
    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.
    value str
    Field value (max: 15 characters).
    fosid str
    field ID .
    name str
    Field name (max: 15 characters).
    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.
    value String
    Field value (max: 15 characters).
    fosid String
    field ID .
    name String
    Field name (max: 15 characters).
    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 Customfield 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 Customfield Resource

    Get an existing Customfield 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?: CustomfieldState, opts?: CustomResourceOptions): Customfield
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            fosid: Optional[str] = None,
            name: Optional[str] = None,
            value: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Customfield
    func GetCustomfield(ctx *Context, name string, id IDInput, state *CustomfieldState, opts ...ResourceOption) (*Customfield, error)
    public static Customfield Get(string name, Input<string> id, CustomfieldState? state, CustomResourceOptions? opts = null)
    public static Customfield get(String name, Output<String> id, CustomfieldState 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:
    Fosid string
    field ID .
    Name string
    Field name (max: 15 characters).
    Value string
    Field value (max: 15 characters).
    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.
    Fosid string
    field ID .
    Name string
    Field name (max: 15 characters).
    Value string
    Field value (max: 15 characters).
    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.
    fosid String
    field ID .
    name String
    Field name (max: 15 characters).
    value String
    Field value (max: 15 characters).
    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.
    fosid string
    field ID .
    name string
    Field name (max: 15 characters).
    value string
    Field value (max: 15 characters).
    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.
    fosid str
    field ID .
    name str
    Field name (max: 15 characters).
    value str
    Field value (max: 15 characters).
    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.
    fosid String
    field ID .
    name String
    Field name (max: 15 characters).
    value String
    Field value (max: 15 characters).
    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

    Log CustomField can be imported using any of these accepted formats:

    $ pulumi import fortios:log/customfield:Customfield labelname {{fosid}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:log/customfield:Customfield 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse