1. Packages
  2. Ibm Provider
  3. API Docs
  4. LogsDashboardFolder
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.LogsDashboardFolder

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Create, update, and delete logs_dashboard_folders with this resource.

    Create LogsDashboardFolder Resource

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

    Constructor syntax

    new LogsDashboardFolder(name: string, args: LogsDashboardFolderArgs, opts?: CustomResourceOptions);
    @overload
    def LogsDashboardFolder(resource_name: str,
                            args: LogsDashboardFolderArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def LogsDashboardFolder(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            instance_id: Optional[str] = None,
                            endpoint_type: Optional[str] = None,
                            logs_dashboard_folder_id: Optional[str] = None,
                            name: Optional[str] = None,
                            parent_id: Optional[str] = None,
                            region: Optional[str] = None)
    func NewLogsDashboardFolder(ctx *Context, name string, args LogsDashboardFolderArgs, opts ...ResourceOption) (*LogsDashboardFolder, error)
    public LogsDashboardFolder(string name, LogsDashboardFolderArgs args, CustomResourceOptions? opts = null)
    public LogsDashboardFolder(String name, LogsDashboardFolderArgs args)
    public LogsDashboardFolder(String name, LogsDashboardFolderArgs args, CustomResourceOptions options)
    
    type: ibm:LogsDashboardFolder
    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 LogsDashboardFolderArgs
    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 LogsDashboardFolderArgs
    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 LogsDashboardFolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogsDashboardFolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogsDashboardFolderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var logsDashboardFolderResource = new Ibm.LogsDashboardFolder("logsDashboardFolderResource", new()
    {
        InstanceId = "string",
        EndpointType = "string",
        LogsDashboardFolderId = "string",
        Name = "string",
        ParentId = "string",
        Region = "string",
    });
    
    example, err := ibm.NewLogsDashboardFolder(ctx, "logsDashboardFolderResource", &ibm.LogsDashboardFolderArgs{
    	InstanceId:            pulumi.String("string"),
    	EndpointType:          pulumi.String("string"),
    	LogsDashboardFolderId: pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	ParentId:              pulumi.String("string"),
    	Region:                pulumi.String("string"),
    })
    
    var logsDashboardFolderResource = new LogsDashboardFolder("logsDashboardFolderResource", LogsDashboardFolderArgs.builder()
        .instanceId("string")
        .endpointType("string")
        .logsDashboardFolderId("string")
        .name("string")
        .parentId("string")
        .region("string")
        .build());
    
    logs_dashboard_folder_resource = ibm.LogsDashboardFolder("logsDashboardFolderResource",
        instance_id="string",
        endpoint_type="string",
        logs_dashboard_folder_id="string",
        name="string",
        parent_id="string",
        region="string")
    
    const logsDashboardFolderResource = new ibm.LogsDashboardFolder("logsDashboardFolderResource", {
        instanceId: "string",
        endpointType: "string",
        logsDashboardFolderId: "string",
        name: "string",
        parentId: "string",
        region: "string",
    });
    
    type: ibm:LogsDashboardFolder
    properties:
        endpointType: string
        instanceId: string
        logsDashboardFolderId: string
        name: string
        parentId: string
        region: string
    

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

    InstanceId string
    Cloud Logs Instance GUID.
    EndpointType string
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    LogsDashboardFolderId string
    The unique identifier of the logs_dashboard_folder resource.
    Name string
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    ParentId string
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    Region string
    Cloud Logs Instance Region.
    InstanceId string
    Cloud Logs Instance GUID.
    EndpointType string
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    LogsDashboardFolderId string
    The unique identifier of the logs_dashboard_folder resource.
    Name string
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    ParentId string
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    Region string
    Cloud Logs Instance Region.
    instanceId String
    Cloud Logs Instance GUID.
    endpointType String
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    logsDashboardFolderId String
    The unique identifier of the logs_dashboard_folder resource.
    name String
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parentId String
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region String
    Cloud Logs Instance Region.
    instanceId string
    Cloud Logs Instance GUID.
    endpointType string
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    logsDashboardFolderId string
    The unique identifier of the logs_dashboard_folder resource.
    name string
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parentId string
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region string
    Cloud Logs Instance Region.
    instance_id str
    Cloud Logs Instance GUID.
    endpoint_type str
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    logs_dashboard_folder_id str
    The unique identifier of the logs_dashboard_folder resource.
    name str
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parent_id str
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region str
    Cloud Logs Instance Region.
    instanceId String
    Cloud Logs Instance GUID.
    endpointType String
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    logsDashboardFolderId String
    The unique identifier of the logs_dashboard_folder resource.
    name String
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parentId String
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region String
    Cloud Logs Instance Region.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LogsDashboardFolder resource produces the following output properties:

    DashboardFolderId string
    The unique identifier of the logs dashboard folder.
    Id string
    The provider-assigned unique ID for this managed resource.
    DashboardFolderId string
    The unique identifier of the logs dashboard folder.
    Id string
    The provider-assigned unique ID for this managed resource.
    dashboardFolderId String
    The unique identifier of the logs dashboard folder.
    id String
    The provider-assigned unique ID for this managed resource.
    dashboardFolderId string
    The unique identifier of the logs dashboard folder.
    id string
    The provider-assigned unique ID for this managed resource.
    dashboard_folder_id str
    The unique identifier of the logs dashboard folder.
    id str
    The provider-assigned unique ID for this managed resource.
    dashboardFolderId String
    The unique identifier of the logs dashboard folder.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LogsDashboardFolder Resource

    Get an existing LogsDashboardFolder 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?: LogsDashboardFolderState, opts?: CustomResourceOptions): LogsDashboardFolder
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dashboard_folder_id: Optional[str] = None,
            endpoint_type: Optional[str] = None,
            instance_id: Optional[str] = None,
            logs_dashboard_folder_id: Optional[str] = None,
            name: Optional[str] = None,
            parent_id: Optional[str] = None,
            region: Optional[str] = None) -> LogsDashboardFolder
    func GetLogsDashboardFolder(ctx *Context, name string, id IDInput, state *LogsDashboardFolderState, opts ...ResourceOption) (*LogsDashboardFolder, error)
    public static LogsDashboardFolder Get(string name, Input<string> id, LogsDashboardFolderState? state, CustomResourceOptions? opts = null)
    public static LogsDashboardFolder get(String name, Output<String> id, LogsDashboardFolderState state, CustomResourceOptions options)
    resources:  _:    type: ibm:LogsDashboardFolder    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.
    The following state arguments are supported:
    DashboardFolderId string
    The unique identifier of the logs dashboard folder.
    EndpointType string
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    InstanceId string
    Cloud Logs Instance GUID.
    LogsDashboardFolderId string
    The unique identifier of the logs_dashboard_folder resource.
    Name string
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    ParentId string
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    Region string
    Cloud Logs Instance Region.
    DashboardFolderId string
    The unique identifier of the logs dashboard folder.
    EndpointType string
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    InstanceId string
    Cloud Logs Instance GUID.
    LogsDashboardFolderId string
    The unique identifier of the logs_dashboard_folder resource.
    Name string
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    ParentId string
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    Region string
    Cloud Logs Instance Region.
    dashboardFolderId String
    The unique identifier of the logs dashboard folder.
    endpointType String
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    instanceId String
    Cloud Logs Instance GUID.
    logsDashboardFolderId String
    The unique identifier of the logs_dashboard_folder resource.
    name String
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parentId String
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region String
    Cloud Logs Instance Region.
    dashboardFolderId string
    The unique identifier of the logs dashboard folder.
    endpointType string
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    instanceId string
    Cloud Logs Instance GUID.
    logsDashboardFolderId string
    The unique identifier of the logs_dashboard_folder resource.
    name string
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parentId string
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region string
    Cloud Logs Instance Region.
    dashboard_folder_id str
    The unique identifier of the logs dashboard folder.
    endpoint_type str
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    instance_id str
    Cloud Logs Instance GUID.
    logs_dashboard_folder_id str
    The unique identifier of the logs_dashboard_folder resource.
    name str
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parent_id str
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region str
    Cloud Logs Instance Region.
    dashboardFolderId String
    The unique identifier of the logs dashboard folder.
    endpointType String
    Cloud Logs Instance Endpoint type. Allowed values public and private.
    instanceId String
    Cloud Logs Instance GUID.
    logsDashboardFolderId String
    The unique identifier of the logs_dashboard_folder resource.
    name String
    The dashboard folder name, required.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    parentId String
    The dashboard folder parent ID, optional. If not set, the folder is a root folder, if set, the folder is a subfolder of the parent folder and needs to be a uuid.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    region String
    Cloud Logs Instance Region.

    Import

    You can import the ibm_logs_dashboard_folder resource by using id. id combination of region, instance_id and dashboard_folder_id.

    Syntax

    
    ```sh
    $ pulumi import ibm:index/logsDashboardFolder:LogsDashboardFolder logs_dashboard_folder < region >/< instance_id >/< dashboard_folder_id >;
    ```
    
    

    Example

    $ pulumi import ibm:index/logsDashboardFolder:LogsDashboardFolder logs_dashboard_folder eu-gb/3dc02998-0b50-4ea8-b68a-4779d716fa1f/d6a3658e-78d2-47d0-9b81-b2c551f01b09
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud