1. Registry
  2. Packages
  3. Sonarqube Provider
  4. API Docs
  5. ProjectLinks
Viewing docs for sonarqube 0.16.22
published on Monday, Sep 7, 2026 by jdamata
Viewing docs for sonarqube 0.16.22
published on Monday, Sep 7, 2026 by jdamata

    Create ProjectLinks Resource

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

    Constructor syntax

    new ProjectLinks(name: string, args: ProjectLinksArgs, opts?: CustomResourceOptions);
    @overload
    def ProjectLinks(resource_name: str,
                     args: ProjectLinksArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProjectLinks(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     project_key: Optional[str] = None,
                     url: Optional[str] = None,
                     name: Optional[str] = None,
                     project_links_id: Optional[str] = None)
    func NewProjectLinks(ctx *Context, name string, args ProjectLinksArgs, opts ...ResourceOption) (*ProjectLinks, error)
    public ProjectLinks(string name, ProjectLinksArgs args, CustomResourceOptions? opts = null)
    public ProjectLinks(String name, ProjectLinksArgs args)
    public ProjectLinks(String name, ProjectLinksArgs args, CustomResourceOptions options)
    
    type: sonarqube:ProjectLinks
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "sonarqube_project_links" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ProjectLinksArgs
    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 ProjectLinksArgs
    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 ProjectLinksArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectLinksArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectLinksArgs
    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 projectLinksResource = new Sonarqube.ProjectLinks("projectLinksResource", new()
    {
        ProjectKey = "string",
        Url = "string",
        Name = "string",
        ProjectLinksId = "string",
    });
    
    example, err := sonarqube.NewProjectLinks(ctx, "projectLinksResource", &sonarqube.ProjectLinksArgs{
    	ProjectKey:     pulumi.String("string"),
    	Url:            pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	ProjectLinksId: pulumi.String("string"),
    })
    
    resource "sonarqube_project_links" "projectLinksResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_key      = "string"
      url              = "string"
      name             = "string"
      project_links_id = "string"
    }
    
    var projectLinksResource = new ProjectLinks("projectLinksResource", ProjectLinksArgs.builder()
        .projectKey("string")
        .url("string")
        .name("string")
        .projectLinksId("string")
        .build());
    
    project_links_resource = sonarqube.ProjectLinks("projectLinksResource",
        project_key="string",
        url="string",
        name="string",
        project_links_id="string")
    
    const projectLinksResource = new sonarqube.ProjectLinks("projectLinksResource", {
        projectKey: "string",
        url: "string",
        name: "string",
        projectLinksId: "string",
    });
    
    type: sonarqube:ProjectLinks
    properties:
        name: string
        projectKey: string
        projectLinksId: string
        url: string
    

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

    ProjectKey string
    The key of the project to associate the link with.
    Url string
    The URL of the link.
    Name string
    The name of the link.
    ProjectLinksId string
    ProjectKey string
    The key of the project to associate the link with.
    Url string
    The URL of the link.
    Name string
    The name of the link.
    ProjectLinksId string
    project_key string
    The key of the project to associate the link with.
    url string
    The URL of the link.
    name string
    The name of the link.
    project_links_id string
    projectKey String
    The key of the project to associate the link with.
    url String
    The URL of the link.
    name String
    The name of the link.
    projectLinksId String
    projectKey string
    The key of the project to associate the link with.
    url string
    The URL of the link.
    name string
    The name of the link.
    projectLinksId string
    project_key str
    The key of the project to associate the link with.
    url str
    The URL of the link.
    name str
    The name of the link.
    project_links_id str
    projectKey String
    The key of the project to associate the link with.
    url String
    The URL of the link.
    name String
    The name of the link.
    projectLinksId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of the link, assigned by SonarQube.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of the link, assigned by SonarQube.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The type of the link, assigned by SonarQube.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the link, assigned by SonarQube.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The type of the link, assigned by SonarQube.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The type of the link, assigned by SonarQube.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of the link, assigned by SonarQube.

    Look up Existing ProjectLinks Resource

    Get an existing ProjectLinks 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?: ProjectLinksState, opts?: CustomResourceOptions): ProjectLinks
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            project_key: Optional[str] = None,
            project_links_id: Optional[str] = None,
            type: Optional[str] = None,
            url: Optional[str] = None) -> ProjectLinks
    func GetProjectLinks(ctx *Context, name string, id IDInput, state *ProjectLinksState, opts ...ResourceOption) (*ProjectLinks, error)
    public static ProjectLinks Get(string name, Input<string> id, ProjectLinksState? state, CustomResourceOptions? opts = null)
    public static ProjectLinks get(String name, Output<String> id, ProjectLinksState state, CustomResourceOptions options)
    resources:  _:    type: sonarqube:ProjectLinks    get:      id: ${id}
    import {
      to = sonarqube_project_links.example
      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:
    Name string
    The name of the link.
    ProjectKey string
    The key of the project to associate the link with.
    ProjectLinksId string
    Type string
    The type of the link, assigned by SonarQube.
    Url string
    The URL of the link.
    Name string
    The name of the link.
    ProjectKey string
    The key of the project to associate the link with.
    ProjectLinksId string
    Type string
    The type of the link, assigned by SonarQube.
    Url string
    The URL of the link.
    name string
    The name of the link.
    project_key string
    The key of the project to associate the link with.
    project_links_id string
    type string
    The type of the link, assigned by SonarQube.
    url string
    The URL of the link.
    name String
    The name of the link.
    projectKey String
    The key of the project to associate the link with.
    projectLinksId String
    type String
    The type of the link, assigned by SonarQube.
    url String
    The URL of the link.
    name string
    The name of the link.
    projectKey string
    The key of the project to associate the link with.
    projectLinksId string
    type string
    The type of the link, assigned by SonarQube.
    url string
    The URL of the link.
    name str
    The name of the link.
    project_key str
    The key of the project to associate the link with.
    project_links_id str
    type str
    The type of the link, assigned by SonarQube.
    url str
    The URL of the link.
    name String
    The name of the link.
    projectKey String
    The key of the project to associate the link with.
    projectLinksId String
    type String
    The type of the link, assigned by SonarQube.
    url String
    The URL of the link.

    Package Details

    Repository
    sonarqube jdamata/terraform-provider-sonarqube
    License
    Notes
    This Pulumi package is based on the sonarqube Terraform Provider.
    Viewing docs for sonarqube 0.16.22
    published on Monday, Sep 7, 2026 by jdamata

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial