Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sonarqube Provider
  3. API Docs
  4. PermissionTemplate
sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
jdamata/terraform-provider-sonarqube

sonarqube.PermissionTemplate

Explore with Pulumi AI

sonarqube logo
sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
jdamata/terraform-provider-sonarqube

    Provides a Sonarqube Permission template resource. This can be used to create and manage Sonarqube Permission templates.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as sonarqube from "@pulumi/sonarqube";

const template = new sonarqube.PermissionTemplate("template", {
    description: "These are internal projects",
    projectKeyPattern: "internal.*",
});

    import pulumi
import pulumi_sonarqube as sonarqube

template = sonarqube.PermissionTemplate("template",
    description="These are internal projects",
    project_key_pattern="internal.*")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sonarqube/sonarqube"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sonarqube.NewPermissionTemplate(ctx, "template", &sonarqube.PermissionTemplateArgs{
			Description:       pulumi.String("These are internal projects"),
			ProjectKeyPattern: pulumi.String("internal.*"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sonarqube = Pulumi.Sonarqube;

return await Deployment.RunAsync(() => 
{
    var template = new Sonarqube.PermissionTemplate("template", new()
    {
        Description = "These are internal projects",
        ProjectKeyPattern = "internal.*",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sonarqube.PermissionTemplate;
import com.pulumi.sonarqube.PermissionTemplateArgs;
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 template = new PermissionTemplate("template", PermissionTemplateArgs.builder()
            .description("These are internal projects")
            .projectKeyPattern("internal.*")
            .build());

    }
}

    resources:
  template:
    type: sonarqube:PermissionTemplate
    properties:
      description: These are internal projects
      projectKeyPattern: internal.*

    Create PermissionTemplate Resource

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

    Constructor syntax

    new PermissionTemplate(name: string, args?: PermissionTemplateArgs, opts?: CustomResourceOptions);
    @overload
def PermissionTemplate(resource_name: str,
                       args: Optional[PermissionTemplateArgs] = None,
                       opts: Optional[ResourceOptions] = None)

@overload
def PermissionTemplate(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       default: Optional[bool] = None,
                       description: Optional[str] = None,
                       name: Optional[str] = None,
                       permission_template_id: Optional[str] = None,
                       project_key_pattern: Optional[str] = None)
    func NewPermissionTemplate(ctx *Context, name string, args *PermissionTemplateArgs, opts ...ResourceOption) (*PermissionTemplate, error)
    public PermissionTemplate(string name, PermissionTemplateArgs? args = null, CustomResourceOptions? opts = null)
    public PermissionTemplate(String name, PermissionTemplateArgs args)
public PermissionTemplate(String name, PermissionTemplateArgs args, CustomResourceOptions options)

    type: sonarqube:PermissionTemplate
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 PermissionTemplateArgs
    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 PermissionTemplateArgs
    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 PermissionTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PermissionTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PermissionTemplateArgs
    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 permissionTemplateResource = new Sonarqube.PermissionTemplate("permissionTemplateResource", new()
{
    Default = false,
    Description = "string",
    Name = "string",
    PermissionTemplateId = "string",
    ProjectKeyPattern = "string",
});

    example, err := sonarqube.NewPermissionTemplate(ctx, "permissionTemplateResource", &sonarqube.PermissionTemplateArgs{
	Default:              pulumi.Bool(false),
	Description:          pulumi.String("string"),
	Name:                 pulumi.String("string"),
	PermissionTemplateId: pulumi.String("string"),
	ProjectKeyPattern:    pulumi.String("string"),
})

    var permissionTemplateResource = new PermissionTemplate("permissionTemplateResource", PermissionTemplateArgs.builder()
    .default_(false)
    .description("string")
    .name("string")
    .permissionTemplateId("string")
    .projectKeyPattern("string")
    .build());

    permission_template_resource = sonarqube.PermissionTemplate("permissionTemplateResource",
    default=False,
    description="string",
    name="string",
    permission_template_id="string",
    project_key_pattern="string")

    const permissionTemplateResource = new sonarqube.PermissionTemplate("permissionTemplateResource", {
    "default": false,
    description: "string",
    name: "string",
    permissionTemplateId: "string",
    projectKeyPattern: "string",
});

    type: sonarqube:PermissionTemplate
properties:
    default: false
    description: string
    name: string
    permissionTemplateId: string
    projectKeyPattern: string

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

    Default bool
    Set the template as the default. This can only be set for one template.
    Description string
    Description of the Template.
    Name string
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    PermissionTemplateId string
    The ID of this resource.
    ProjectKeyPattern string
    The project key pattern. Must be a valid Java regular expression.
    Default bool
    Set the template as the default. This can only be set for one template.
    Description string
    Description of the Template.
    Name string
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    PermissionTemplateId string
    The ID of this resource.
    ProjectKeyPattern string
    The project key pattern. Must be a valid Java regular expression.
    default_ Boolean
    Set the template as the default. This can only be set for one template.
    description String
    Description of the Template.
    name String
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permissionTemplateId String
    The ID of this resource.
    projectKeyPattern String
    The project key pattern. Must be a valid Java regular expression.
    default boolean
    Set the template as the default. This can only be set for one template.
    description string
    Description of the Template.
    name string
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permissionTemplateId string
    The ID of this resource.
    projectKeyPattern string
    The project key pattern. Must be a valid Java regular expression.
    default bool
    Set the template as the default. This can only be set for one template.
    description str
    Description of the Template.
    name str
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permission_template_id str
    The ID of this resource.
    project_key_pattern str
    The project key pattern. Must be a valid Java regular expression.
    default Boolean
    Set the template as the default. This can only be set for one template.
    description String
    Description of the Template.
    name String
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permissionTemplateId String
    The ID of this resource.
    projectKeyPattern String
    The project key pattern. Must be a valid Java regular expression.

    Outputs

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

    Get an existing PermissionTemplate 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?: PermissionTemplateState, opts?: CustomResourceOptions): PermissionTemplate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default: Optional[bool] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        permission_template_id: Optional[str] = None,
        project_key_pattern: Optional[str] = None) -> PermissionTemplate
    func GetPermissionTemplate(ctx *Context, name string, id IDInput, state *PermissionTemplateState, opts ...ResourceOption) (*PermissionTemplate, error)
    public static PermissionTemplate Get(string name, Input<string> id, PermissionTemplateState? state, CustomResourceOptions? opts = null)
    public static PermissionTemplate get(String name, Output<String> id, PermissionTemplateState state, CustomResourceOptions options)
    resources:  _:    type: sonarqube:PermissionTemplate    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:
    Default bool
    Set the template as the default. This can only be set for one template.
    Description string
    Description of the Template.
    Name string
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    PermissionTemplateId string
    The ID of this resource.
    ProjectKeyPattern string
    The project key pattern. Must be a valid Java regular expression.
    Default bool
    Set the template as the default. This can only be set for one template.
    Description string
    Description of the Template.
    Name string
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    PermissionTemplateId string
    The ID of this resource.
    ProjectKeyPattern string
    The project key pattern. Must be a valid Java regular expression.
    default_ Boolean
    Set the template as the default. This can only be set for one template.
    description String
    Description of the Template.
    name String
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permissionTemplateId String
    The ID of this resource.
    projectKeyPattern String
    The project key pattern. Must be a valid Java regular expression.
    default boolean
    Set the template as the default. This can only be set for one template.
    description string
    Description of the Template.
    name string
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permissionTemplateId string
    The ID of this resource.
    projectKeyPattern string
    The project key pattern. Must be a valid Java regular expression.
    default bool
    Set the template as the default. This can only be set for one template.
    description str
    Description of the Template.
    name str
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permission_template_id str
    The ID of this resource.
    project_key_pattern str
    The project key pattern. Must be a valid Java regular expression.
    default Boolean
    Set the template as the default. This can only be set for one template.
    description String
    Description of the Template.
    name String
    The name of the Permission template to create. Do not use names with /. If needed, use replace(var.permission_template_name, "/", "_"). Changing this forces a new resource to be created.
    permissionTemplateId String
    The ID of this resource.
    projectKeyPattern String
    The project key pattern. Must be a valid Java regular expression.

    Package Details

    Repository
    sonarqube jdamata/terraform-provider-sonarqube
    License
    Notes
    This Pulumi package is based on the sonarqube Terraform Provider.
    sonarqube logo
    sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
    jdamata/terraform-provider-sonarqube