1. Packages
  2. Sumo Logic
  3. API Docs
  4. MonitorFolder
Sumo Logic v0.20.3 published on Wednesday, Mar 6, 2024 by Pulumi

sumologic.MonitorFolder

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.20.3 published on Wednesday, Mar 6, 2024 by Pulumi

    Provides the ability to create, read, delete, and update folders for Monitors.

    If Fine Grain Permission (FGP) feature is enabled with Monitors Content at one’s Sumo Logic account, one can also set those permission details under this monitor folder resource. For further details about FGP, please see this Monitor Permission document.

    Example Monitor Folder

    NOTE: Monitor folders are considered a different resource from Library content folders.

    import * as pulumi from "@pulumi/pulumi";
    import * as sumologic from "@pulumi/sumologic";
    
    const tfMonitorFolder1 = new sumologic.MonitorFolder("tfMonitorFolder1", {description: "A folder for monitors managed by terraform."});
    
    import pulumi
    import pulumi_sumologic as sumologic
    
    tf_monitor_folder1 = sumologic.MonitorFolder("tfMonitorFolder1", description="A folder for monitors managed by terraform.")
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SumoLogic = Pulumi.SumoLogic;
    
    return await Deployment.RunAsync(() => 
    {
        var tfMonitorFolder1 = new SumoLogic.MonitorFolder("tfMonitorFolder1", new()
        {
            Description = "A folder for monitors managed by terraform.",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-sumologic/sdk/go/sumologic"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sumologic.NewMonitorFolder(ctx, "tfMonitorFolder1", &sumologic.MonitorFolderArgs{
    			Description: pulumi.String("A folder for monitors managed by terraform."),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sumologic.MonitorFolder;
    import com.pulumi.sumologic.MonitorFolderArgs;
    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 tfMonitorFolder1 = new MonitorFolder("tfMonitorFolder1", MonitorFolderArgs.builder()        
                .description("A folder for monitors managed by terraform.")
                .build());
    
        }
    }
    
    resources:
      tfMonitorFolder1:
        type: sumologic:MonitorFolder
        properties:
          description: A folder for monitors managed by terraform.
    

    Create MonitorFolder Resource

    new MonitorFolder(name: string, args: MonitorFolderArgs, opts?: CustomResourceOptions);
    @overload
    def MonitorFolder(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      content_type: Optional[str] = None,
                      created_at: Optional[str] = None,
                      created_by: Optional[str] = None,
                      description: Optional[str] = None,
                      is_locked: Optional[bool] = None,
                      is_mutable: Optional[bool] = None,
                      is_system: Optional[bool] = None,
                      modified_at: Optional[str] = None,
                      modified_by: Optional[str] = None,
                      name: Optional[str] = None,
                      obj_permissions: Optional[Sequence[MonitorFolderObjPermissionArgs]] = None,
                      parent_id: Optional[str] = None,
                      post_request_map: Optional[Mapping[str, str]] = None,
                      type: Optional[str] = None,
                      version: Optional[int] = None)
    @overload
    def MonitorFolder(resource_name: str,
                      args: MonitorFolderArgs,
                      opts: Optional[ResourceOptions] = None)
    func NewMonitorFolder(ctx *Context, name string, args MonitorFolderArgs, opts ...ResourceOption) (*MonitorFolder, error)
    public MonitorFolder(string name, MonitorFolderArgs args, CustomResourceOptions? opts = null)
    public MonitorFolder(String name, MonitorFolderArgs args)
    public MonitorFolder(String name, MonitorFolderArgs args, CustomResourceOptions options)
    
    type: sumologic:MonitorFolder
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args MonitorFolderArgs
    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 MonitorFolderArgs
    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 MonitorFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitorFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitorFolderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Description string
    The description of the monitor folder.
    ContentType string
    CreatedAt string
    CreatedBy string
    IsLocked bool
    IsMutable bool
    IsSystem bool
    ModifiedAt string
    ModifiedBy string
    Name string
    The name of the monitor folder. The name must be alphanumeric.
    ObjPermissions List<Pulumi.SumoLogic.Inputs.MonitorFolderObjPermission>
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    ParentId string
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    PostRequestMap Dictionary<string, string>
    Type string
    The type of object model. Valid value:
    Version int
    Description string
    The description of the monitor folder.
    ContentType string
    CreatedAt string
    CreatedBy string
    IsLocked bool
    IsMutable bool
    IsSystem bool
    ModifiedAt string
    ModifiedBy string
    Name string
    The name of the monitor folder. The name must be alphanumeric.
    ObjPermissions []MonitorFolderObjPermissionArgs
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    ParentId string
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    PostRequestMap map[string]string
    Type string
    The type of object model. Valid value:
    Version int
    description String
    The description of the monitor folder.
    contentType String
    createdAt String
    createdBy String
    isLocked Boolean
    isMutable Boolean
    isSystem Boolean
    modifiedAt String
    modifiedBy String
    name String
    The name of the monitor folder. The name must be alphanumeric.
    objPermissions List<MonitorFolderObjPermission>
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parentId String
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    postRequestMap Map<String,String>
    type String
    The type of object model. Valid value:
    version Integer
    description string
    The description of the monitor folder.
    contentType string
    createdAt string
    createdBy string
    isLocked boolean
    isMutable boolean
    isSystem boolean
    modifiedAt string
    modifiedBy string
    name string
    The name of the monitor folder. The name must be alphanumeric.
    objPermissions MonitorFolderObjPermission[]
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parentId string
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    postRequestMap {[key: string]: string}
    type string
    The type of object model. Valid value:
    version number
    description str
    The description of the monitor folder.
    content_type str
    created_at str
    created_by str
    is_locked bool
    is_mutable bool
    is_system bool
    modified_at str
    modified_by str
    name str
    The name of the monitor folder. The name must be alphanumeric.
    obj_permissions Sequence[MonitorFolderObjPermissionArgs]
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parent_id str
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    post_request_map Mapping[str, str]
    type str
    The type of object model. Valid value:
    version int
    description String
    The description of the monitor folder.
    contentType String
    createdAt String
    createdBy String
    isLocked Boolean
    isMutable Boolean
    isSystem Boolean
    modifiedAt String
    modifiedBy String
    name String
    The name of the monitor folder. The name must be alphanumeric.
    objPermissions List<Property Map>
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parentId String
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    postRequestMap Map<String>
    type String
    The type of object model. Valid value:
    version Number

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MonitorFolder 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 MonitorFolder Resource

    Get an existing MonitorFolder 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?: MonitorFolderState, opts?: CustomResourceOptions): MonitorFolder
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            content_type: Optional[str] = None,
            created_at: Optional[str] = None,
            created_by: Optional[str] = None,
            description: Optional[str] = None,
            is_locked: Optional[bool] = None,
            is_mutable: Optional[bool] = None,
            is_system: Optional[bool] = None,
            modified_at: Optional[str] = None,
            modified_by: Optional[str] = None,
            name: Optional[str] = None,
            obj_permissions: Optional[Sequence[MonitorFolderObjPermissionArgs]] = None,
            parent_id: Optional[str] = None,
            post_request_map: Optional[Mapping[str, str]] = None,
            type: Optional[str] = None,
            version: Optional[int] = None) -> MonitorFolder
    func GetMonitorFolder(ctx *Context, name string, id IDInput, state *MonitorFolderState, opts ...ResourceOption) (*MonitorFolder, error)
    public static MonitorFolder Get(string name, Input<string> id, MonitorFolderState? state, CustomResourceOptions? opts = null)
    public static MonitorFolder get(String name, Output<String> id, MonitorFolderState 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:
    ContentType string
    CreatedAt string
    CreatedBy string
    Description string
    The description of the monitor folder.
    IsLocked bool
    IsMutable bool
    IsSystem bool
    ModifiedAt string
    ModifiedBy string
    Name string
    The name of the monitor folder. The name must be alphanumeric.
    ObjPermissions List<Pulumi.SumoLogic.Inputs.MonitorFolderObjPermission>
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    ParentId string
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    PostRequestMap Dictionary<string, string>
    Type string
    The type of object model. Valid value:
    Version int
    ContentType string
    CreatedAt string
    CreatedBy string
    Description string
    The description of the monitor folder.
    IsLocked bool
    IsMutable bool
    IsSystem bool
    ModifiedAt string
    ModifiedBy string
    Name string
    The name of the monitor folder. The name must be alphanumeric.
    ObjPermissions []MonitorFolderObjPermissionArgs
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    ParentId string
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    PostRequestMap map[string]string
    Type string
    The type of object model. Valid value:
    Version int
    contentType String
    createdAt String
    createdBy String
    description String
    The description of the monitor folder.
    isLocked Boolean
    isMutable Boolean
    isSystem Boolean
    modifiedAt String
    modifiedBy String
    name String
    The name of the monitor folder. The name must be alphanumeric.
    objPermissions List<MonitorFolderObjPermission>
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parentId String
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    postRequestMap Map<String,String>
    type String
    The type of object model. Valid value:
    version Integer
    contentType string
    createdAt string
    createdBy string
    description string
    The description of the monitor folder.
    isLocked boolean
    isMutable boolean
    isSystem boolean
    modifiedAt string
    modifiedBy string
    name string
    The name of the monitor folder. The name must be alphanumeric.
    objPermissions MonitorFolderObjPermission[]
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parentId string
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    postRequestMap {[key: string]: string}
    type string
    The type of object model. Valid value:
    version number
    content_type str
    created_at str
    created_by str
    description str
    The description of the monitor folder.
    is_locked bool
    is_mutable bool
    is_system bool
    modified_at str
    modified_by str
    name str
    The name of the monitor folder. The name must be alphanumeric.
    obj_permissions Sequence[MonitorFolderObjPermissionArgs]
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parent_id str
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    post_request_map Mapping[str, str]
    type str
    The type of object model. Valid value:
    version int
    contentType String
    createdAt String
    createdBy String
    description String
    The description of the monitor folder.
    isLocked Boolean
    isMutable Boolean
    isSystem Boolean
    modifiedAt String
    modifiedBy String
    name String
    The name of the monitor folder. The name must be alphanumeric.
    objPermissions List<Property Map>
    obj_permission construct represents a Permission Statement associated with this Folder. A set of obj_permission constructs can be specified under a single Folder. An obj_permission construct can be used to control permissions Explicitly associated with a Folder. But, it cannot be used to control permissions Inherited from a Parent / Ancestor Folder. Default FGP would be still set to the Folder upon creation (e.g. the creating user would have full permission), even if no obj_permission construct is specified at a Folder and the FGP feature is enabled at the account.
    parentId String
    The identifier of the Monitor Folder that contains this Monitor Folder. Defaults to the root folder.
    postRequestMap Map<String>
    type String
    The type of object model. Valid value:
    version Number

    Supporting Types

    MonitorFolderObjPermission, MonitorFolderObjPermissionArgs

    Permissions List<string>
    A Set of Permissions. Valid Permission Values:
    SubjectId string
    A Role ID or the Org ID of the account
    SubjectType string
    Valid values:
    Permissions []string
    A Set of Permissions. Valid Permission Values:
    SubjectId string
    A Role ID or the Org ID of the account
    SubjectType string
    Valid values:
    permissions List<String>
    A Set of Permissions. Valid Permission Values:
    subjectId String
    A Role ID or the Org ID of the account
    subjectType String
    Valid values:
    permissions string[]
    A Set of Permissions. Valid Permission Values:
    subjectId string
    A Role ID or the Org ID of the account
    subjectType string
    Valid values:
    permissions Sequence[str]
    A Set of Permissions. Valid Permission Values:
    subject_id str
    A Role ID or the Org ID of the account
    subject_type str
    Valid values:
    permissions List<String>
    A Set of Permissions. Valid Permission Values:
    subjectId String
    A Role ID or the Org ID of the account
    subjectType String
    Valid values:

    Import

    Monitor folders can be imported using the monitor folder identifier, such as:

    hcl

    $ pulumi import sumologic:index/monitorFolder:MonitorFolder tf_monitor_folder_1 0000000000ABC123
    

    Package Details

    Repository
    Sumo Logic pulumi/pulumi-sumologic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Sumo Logic v0.20.3 published on Wednesday, Mar 6, 2024 by Pulumi