Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Sonarqube Provider
  4. API Docs
  5. SecuredSetting
Viewing docs for sonarqube 0.16.26
published on Friday, Oct 2, 2026 by jdamata
Schema (JSON)
jdamata/terraform-provider-sonarqube

sonarqube.SecuredSetting

sonarqube
Viewing docs for sonarqube 0.16.26
published on Friday, Oct 2, 2026 by jdamata
Schema (JSON)
jdamata/terraform-provider-sonarqube

    Provides a Sonarqube Secured Setting resource. This can be used to manage Sonarqube secured (encrypted) settings. The value is write-only and cannot be read back from the API.

    Example Usage

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

const ldapBindPassword = new sonarqube.SecuredSetting("ldap_bind_password", {
    key: "ldap.bindPassword",
    value: ldapBindPasswordConfig,
});

    import pulumi
import pulumi_sonarqube as sonarqube

ldap_bind_password = sonarqube.SecuredSetting("ldap_bind_password",
    key="ldap.bindPassword",
    value=ldap_bind_password_config)

    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.NewSecuredSetting(ctx, "ldap_bind_password", &sonarqube.SecuredSettingArgs{
			Key:   pulumi.String("ldap.bindPassword"),
			Value: pulumi.Any(ldapBindPasswordConfig),
		})
		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 ldapBindPassword = new Sonarqube.SecuredSetting("ldap_bind_password", new()
    {
        Key = "ldap.bindPassword",
        Value = ldapBindPasswordConfig,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sonarqube.SecuredSetting;
import com.pulumi.sonarqube.SecuredSettingArgs;
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 ldapBindPassword = new SecuredSetting("ldapBindPassword", SecuredSettingArgs.builder()
            .key("ldap.bindPassword")
            .value(ldapBindPasswordConfig)
            .build());

    }
}

    resources:
  ldapBindPassword:
    type: sonarqube:SecuredSetting
    name: ldap_bind_password
    properties:
      key: ldap.bindPassword
      value: ${ldapBindPasswordConfig}

    Example coming soon!

    Create SecuredSetting Resource

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

    Constructor syntax

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

@overload
def SecuredSetting(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   key: Optional[str] = None,
                   value: Optional[str] = None,
                   component: Optional[str] = None,
                   secured_setting_id: Optional[str] = None)
    func NewSecuredSetting(ctx *Context, name string, args SecuredSettingArgs, opts ...ResourceOption) (*SecuredSetting, error)
    public SecuredSetting(string name, SecuredSettingArgs args, CustomResourceOptions? opts = null)
    public SecuredSetting(String name, SecuredSettingArgs args)
public SecuredSetting(String name, SecuredSettingArgs args, CustomResourceOptions options)

    type: sonarqube:SecuredSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "sonarqube_secured_setting" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SecuredSettingArgs
    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 SecuredSettingArgs
    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 SecuredSettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecuredSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecuredSettingArgs
    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 securedSettingResource = new Sonarqube.SecuredSetting("securedSettingResource", new()
{
    Key = "string",
    Value = "string",
    Component = "string",
    SecuredSettingId = "string",
});

    example, err := sonarqube.NewSecuredSetting(ctx, "securedSettingResource", &sonarqube.SecuredSettingArgs{
	Key:              pulumi.String("string"),
	Value:            pulumi.String("string"),
	Component:        pulumi.String("string"),
	SecuredSettingId: pulumi.String("string"),
})

    resource "sonarqube_secured_setting" "securedSettingResource" {
  lifecycle {
    create_before_destroy = true
  }
  key                = "string"
  value              = "string"
  component          = "string"
  secured_setting_id = "string"
}

    var securedSettingResource = new SecuredSetting("securedSettingResource", SecuredSettingArgs.builder()
    .key("string")
    .value("string")
    .component("string")
    .securedSettingId("string")
    .build());

    secured_setting_resource = sonarqube.SecuredSetting("securedSettingResource",
    key="string",
    value="string",
    component="string",
    secured_setting_id="string")

    const securedSettingResource = new sonarqube.SecuredSetting("securedSettingResource", {
    key: "string",
    value: "string",
    component: "string",
    securedSettingId: "string",
});

    type: sonarqube:SecuredSetting
properties:
    component: string
    key: string
    securedSettingId: string
    value: string

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

    Key string
    Setting key.
    Value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    Component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    SecuredSettingId string
    The ID of this resource.
    Key string
    Setting key.
    Value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    Component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    SecuredSettingId string
    The ID of this resource.
    key string
    Setting key.
    value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    secured_setting_id string
    The ID of this resource.
    key String
    Setting key.
    value String
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component String
    Component (project) key to scope the setting to. If omitted, the setting is global.
    securedSettingId String
    The ID of this resource.
    key string
    Setting key.
    value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    securedSettingId string
    The ID of this resource.
    key str
    Setting key.
    value str
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component str
    Component (project) key to scope the setting to. If omitted, the setting is global.
    secured_setting_id str
    The ID of this resource.
    key String
    Setting key.
    value String
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component String
    Component (project) key to scope the setting to. If omitted, the setting is global.
    securedSettingId String
    The ID of this resource.

    Outputs

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

    Get an existing SecuredSetting 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?: SecuredSettingState, opts?: CustomResourceOptions): SecuredSetting
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        component: Optional[str] = None,
        key: Optional[str] = None,
        secured_setting_id: Optional[str] = None,
        value: Optional[str] = None) -> SecuredSetting
    func GetSecuredSetting(ctx *Context, name string, id IDInput, state *SecuredSettingState, opts ...ResourceOption) (*SecuredSetting, error)
    public static SecuredSetting Get(string name, Input<string> id, SecuredSettingState? state, CustomResourceOptions? opts = null)
    public static SecuredSetting get(String name, Output<String> id, SecuredSettingState state, CustomResourceOptions options)
    resources:  _:    type: sonarqube:SecuredSetting    get:      id: ${id}
    import {
  to = sonarqube_secured_setting.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:
    Component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    Key string
    Setting key.
    SecuredSettingId string
    The ID of this resource.
    Value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    Component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    Key string
    Setting key.
    SecuredSettingId string
    The ID of this resource.
    Value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    key string
    Setting key.
    secured_setting_id string
    The ID of this resource.
    value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component String
    Component (project) key to scope the setting to. If omitted, the setting is global.
    key String
    Setting key.
    securedSettingId String
    The ID of this resource.
    value String
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component string
    Component (project) key to scope the setting to. If omitted, the setting is global.
    key string
    Setting key.
    securedSettingId string
    The ID of this resource.
    value string
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component str
    Component (project) key to scope the setting to. If omitted, the setting is global.
    key str
    Setting key.
    secured_setting_id str
    The ID of this resource.
    value str
    Setting value. Stored encrypted server-side and never returned by the API (write-only).
    component String
    Component (project) key to scope the setting to. If omitted, the setting is global.
    key String
    Setting key.
    securedSettingId String
    The ID of this resource.
    value String
    Setting value. Stored encrypted server-side and never returned by the API (write-only).

    Package Details

    Repository
    sonarqube jdamata/terraform-provider-sonarqube
    License
    Notes
    This Pulumi package is based on the sonarqube Terraform Provider.
    sonarqube
    Viewing docs for sonarqube 0.16.26
    published on Friday, Oct 2, 2026 by jdamata
    Schema (JSON)
    jdamata/terraform-provider-sonarqube

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial