1. Packages
  2. Control Plane Provider
  3. API Docs
  4. HelmRelease
Viewing docs for Control Plane v0.0.84
published on Friday, Mar 20, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-cpln

cpln.HelmRelease

cpln logo
Viewing docs for Control Plane v0.0.84
published on Friday, Mar 20, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-cpln

    Create HelmRelease Resource

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

    Constructor syntax

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

@overload
def HelmRelease(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                chart: Optional[str] = None,
                dependency_update: Optional[bool] = None,
                description: Optional[str] = None,
                gvc: Optional[str] = None,
                insecure_skip_tls_verify: Optional[bool] = None,
                max_history: Optional[int] = None,
                name: Optional[str] = None,
                postrender: Optional[HelmReleasePostrenderArgs] = None,
                render_subchart_notes: Optional[bool] = None,
                repository: Optional[str] = None,
                repository_ca_file: Optional[str] = None,
                repository_cert_file: Optional[str] = None,
                repository_key_file: Optional[str] = None,
                repository_password: Optional[str] = None,
                repository_username: Optional[str] = None,
                set: Optional[Mapping[str, str]] = None,
                set_file: Optional[Mapping[str, str]] = None,
                set_string: Optional[Mapping[str, str]] = None,
                timeout: Optional[int] = None,
                values: Optional[Sequence[str]] = None,
                verify: Optional[bool] = None,
                version: Optional[str] = None,
                wait: Optional[bool] = None)
    func NewHelmRelease(ctx *Context, name string, args HelmReleaseArgs, opts ...ResourceOption) (*HelmRelease, error)
    public HelmRelease(string name, HelmReleaseArgs args, CustomResourceOptions? opts = null)
    public HelmRelease(String name, HelmReleaseArgs args)
public HelmRelease(String name, HelmReleaseArgs args, CustomResourceOptions options)

    type: cpln:HelmRelease
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 HelmReleaseArgs
    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 HelmReleaseArgs
    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 HelmReleaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HelmReleaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HelmReleaseArgs
    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 helmReleaseResource = new Cpln.HelmRelease("helmReleaseResource", new()
{
    Chart = "string",
    DependencyUpdate = false,
    Description = "string",
    Gvc = "string",
    InsecureSkipTlsVerify = false,
    MaxHistory = 0,
    Name = "string",
    Postrender = new Cpln.Inputs.HelmReleasePostrenderArgs
    {
        BinaryPath = "string",
        Args = new[]
        {
            "string",
        },
    },
    RenderSubchartNotes = false,
    Repository = "string",
    RepositoryCaFile = "string",
    RepositoryCertFile = "string",
    RepositoryKeyFile = "string",
    RepositoryPassword = "string",
    RepositoryUsername = "string",
    Set = 
    {
        { "string", "string" },
    },
    SetFile = 
    {
        { "string", "string" },
    },
    SetString = 
    {
        { "string", "string" },
    },
    Timeout = 0,
    Values = new[]
    {
        "string",
    },
    Verify = false,
    Version = "string",
    Wait = false,
});

    example, err := cpln.NewHelmRelease(ctx, "helmReleaseResource", &cpln.HelmReleaseArgs{
	Chart:                 pulumi.String("string"),
	DependencyUpdate:      pulumi.Bool(false),
	Description:           pulumi.String("string"),
	Gvc:                   pulumi.String("string"),
	InsecureSkipTlsVerify: pulumi.Bool(false),
	MaxHistory:            pulumi.Int(0),
	Name:                  pulumi.String("string"),
	Postrender: &cpln.HelmReleasePostrenderArgs{
		BinaryPath: pulumi.String("string"),
		Args: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	RenderSubchartNotes: pulumi.Bool(false),
	Repository:          pulumi.String("string"),
	RepositoryCaFile:    pulumi.String("string"),
	RepositoryCertFile:  pulumi.String("string"),
	RepositoryKeyFile:   pulumi.String("string"),
	RepositoryPassword:  pulumi.String("string"),
	RepositoryUsername:  pulumi.String("string"),
	Set: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SetFile: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SetString: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeout: pulumi.Int(0),
	Values: pulumi.StringArray{
		pulumi.String("string"),
	},
	Verify:  pulumi.Bool(false),
	Version: pulumi.String("string"),
	Wait:    pulumi.Bool(false),
})

    var helmReleaseResource = new HelmRelease("helmReleaseResource", HelmReleaseArgs.builder()
    .chart("string")
    .dependencyUpdate(false)
    .description("string")
    .gvc("string")
    .insecureSkipTlsVerify(false)
    .maxHistory(0)
    .name("string")
    .postrender(HelmReleasePostrenderArgs.builder()
        .binaryPath("string")
        .args("string")
        .build())
    .renderSubchartNotes(false)
    .repository("string")
    .repositoryCaFile("string")
    .repositoryCertFile("string")
    .repositoryKeyFile("string")
    .repositoryPassword("string")
    .repositoryUsername("string")
    .set(Map.of("string", "string"))
    .setFile(Map.of("string", "string"))
    .setString(Map.of("string", "string"))
    .timeout(0)
    .values("string")
    .verify(false)
    .version("string")
    .wait(false)
    .build());

    helm_release_resource = cpln.HelmRelease("helmReleaseResource",
    chart="string",
    dependency_update=False,
    description="string",
    gvc="string",
    insecure_skip_tls_verify=False,
    max_history=0,
    name="string",
    postrender={
        "binary_path": "string",
        "args": ["string"],
    },
    render_subchart_notes=False,
    repository="string",
    repository_ca_file="string",
    repository_cert_file="string",
    repository_key_file="string",
    repository_password="string",
    repository_username="string",
    set={
        "string": "string",
    },
    set_file={
        "string": "string",
    },
    set_string={
        "string": "string",
    },
    timeout=0,
    values=["string"],
    verify=False,
    version="string",
    wait=False)

    const helmReleaseResource = new cpln.HelmRelease("helmReleaseResource", {
    chart: "string",
    dependencyUpdate: false,
    description: "string",
    gvc: "string",
    insecureSkipTlsVerify: false,
    maxHistory: 0,
    name: "string",
    postrender: {
        binaryPath: "string",
        args: ["string"],
    },
    renderSubchartNotes: false,
    repository: "string",
    repositoryCaFile: "string",
    repositoryCertFile: "string",
    repositoryKeyFile: "string",
    repositoryPassword: "string",
    repositoryUsername: "string",
    set: {
        string: "string",
    },
    setFile: {
        string: "string",
    },
    setString: {
        string: "string",
    },
    timeout: 0,
    values: ["string"],
    verify: false,
    version: "string",
    wait: false,
});

    type: cpln:HelmRelease
properties:
    chart: string
    dependencyUpdate: false
    description: string
    gvc: string
    insecureSkipTlsVerify: false
    maxHistory: 0
    name: string
    postrender:
        args:
            - string
        binaryPath: string
    renderSubchartNotes: false
    repository: string
    repositoryCaFile: string
    repositoryCertFile: string
    repositoryKeyFile: string
    repositoryPassword: string
    repositoryUsername: string
    set:
        string: string
    setFile:
        string: string
    setString:
        string: string
    timeout: 0
    values:
        - string
    verify: false
    version: string
    wait: false

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

    Chart string
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    DependencyUpdate bool
    Update dependencies if they are missing before installing the chart.
    Description string
    Add a custom description for the release.
    Gvc string
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    InsecureSkipTlsVerify bool
    Skip TLS certificate checks for the chart download.
    MaxHistory int
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    Name string
    The release name for this helm deployment.
    Postrender Pulumiverse.Cpln.Inputs.HelmReleasePostrender
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    RenderSubchartNotes bool
    If set, render subchart notes along with the parent on install/upgrade.
    Repository string
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    RepositoryCaFile string
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    RepositoryCertFile string
    Identify HTTPS client using this SSL certificate file.
    RepositoryKeyFile string
    Identify HTTPS client using this SSL key file.
    RepositoryPassword string
    Chart repository password where to locate the requested chart.
    RepositoryUsername string
    Chart repository username where to locate the requested chart.
    Set Dictionary<string, string>
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    SetFile Dictionary<string, string>
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    SetString Dictionary<string, string>
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    Timeout int
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    Values List<string>
    List of values in raw YAML to pass to helm.
    Verify bool
    Verify the package before using it.
    Version string
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    Wait bool
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    Chart string
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    DependencyUpdate bool
    Update dependencies if they are missing before installing the chart.
    Description string
    Add a custom description for the release.
    Gvc string
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    InsecureSkipTlsVerify bool
    Skip TLS certificate checks for the chart download.
    MaxHistory int
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    Name string
    The release name for this helm deployment.
    Postrender HelmReleasePostrenderArgs
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    RenderSubchartNotes bool
    If set, render subchart notes along with the parent on install/upgrade.
    Repository string
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    RepositoryCaFile string
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    RepositoryCertFile string
    Identify HTTPS client using this SSL certificate file.
    RepositoryKeyFile string
    Identify HTTPS client using this SSL key file.
    RepositoryPassword string
    Chart repository password where to locate the requested chart.
    RepositoryUsername string
    Chart repository username where to locate the requested chart.
    Set map[string]string
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    SetFile map[string]string
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    SetString map[string]string
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    Timeout int
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    Values []string
    List of values in raw YAML to pass to helm.
    Verify bool
    Verify the package before using it.
    Version string
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    Wait bool
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart String
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependencyUpdate Boolean
    Update dependencies if they are missing before installing the chart.
    description String
    Add a custom description for the release.
    gvc String
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecureSkipTlsVerify Boolean
    Skip TLS certificate checks for the chart download.
    maxHistory Integer
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name String
    The release name for this helm deployment.
    postrender HelmReleasePostrender
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    renderSubchartNotes Boolean
    If set, render subchart notes along with the parent on install/upgrade.
    repository String
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repositoryCaFile String
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repositoryCertFile String
    Identify HTTPS client using this SSL certificate file.
    repositoryKeyFile String
    Identify HTTPS client using this SSL key file.
    repositoryPassword String
    Chart repository password where to locate the requested chart.
    repositoryUsername String
    Chart repository username where to locate the requested chart.
    set Map<String,String>
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    setFile Map<String,String>
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    setString Map<String,String>
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    timeout Integer
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values List<String>
    List of values in raw YAML to pass to helm.
    verify Boolean
    Verify the package before using it.
    version String
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait_ Boolean
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart string
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependencyUpdate boolean
    Update dependencies if they are missing before installing the chart.
    description string
    Add a custom description for the release.
    gvc string
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecureSkipTlsVerify boolean
    Skip TLS certificate checks for the chart download.
    maxHistory number
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name string
    The release name for this helm deployment.
    postrender HelmReleasePostrender
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    renderSubchartNotes boolean
    If set, render subchart notes along with the parent on install/upgrade.
    repository string
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repositoryCaFile string
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repositoryCertFile string
    Identify HTTPS client using this SSL certificate file.
    repositoryKeyFile string
    Identify HTTPS client using this SSL key file.
    repositoryPassword string
    Chart repository password where to locate the requested chart.
    repositoryUsername string
    Chart repository username where to locate the requested chart.
    set {[key: string]: string}
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    setFile {[key: string]: string}
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    setString {[key: string]: string}
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    timeout number
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values string[]
    List of values in raw YAML to pass to helm.
    verify boolean
    Verify the package before using it.
    version string
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait boolean
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart str
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependency_update bool
    Update dependencies if they are missing before installing the chart.
    description str
    Add a custom description for the release.
    gvc str
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecure_skip_tls_verify bool
    Skip TLS certificate checks for the chart download.
    max_history int
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name str
    The release name for this helm deployment.
    postrender HelmReleasePostrenderArgs
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    render_subchart_notes bool
    If set, render subchart notes along with the parent on install/upgrade.
    repository str
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repository_ca_file str
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repository_cert_file str
    Identify HTTPS client using this SSL certificate file.
    repository_key_file str
    Identify HTTPS client using this SSL key file.
    repository_password str
    Chart repository password where to locate the requested chart.
    repository_username str
    Chart repository username where to locate the requested chart.
    set Mapping[str, str]
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    set_file Mapping[str, str]
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    set_string Mapping[str, str]
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    timeout int
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values Sequence[str]
    List of values in raw YAML to pass to helm.
    verify bool
    Verify the package before using it.
    version str
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait bool
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart String
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependencyUpdate Boolean
    Update dependencies if they are missing before installing the chart.
    description String
    Add a custom description for the release.
    gvc String
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecureSkipTlsVerify Boolean
    Skip TLS certificate checks for the chart download.
    maxHistory Number
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name String
    The release name for this helm deployment.
    postrender Property Map
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    renderSubchartNotes Boolean
    If set, render subchart notes along with the parent on install/upgrade.
    repository String
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repositoryCaFile String
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repositoryCertFile String
    Identify HTTPS client using this SSL certificate file.
    repositoryKeyFile String
    Identify HTTPS client using this SSL key file.
    repositoryPassword String
    Chart repository password where to locate the requested chart.
    repositoryUsername String
    Chart repository username where to locate the requested chart.
    set Map<String>
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    setFile Map<String>
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    setString Map<String>
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    timeout Number
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values List<String>
    List of values in raw YAML to pass to helm.
    verify Boolean
    Verify the package before using it.
    version String
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait Boolean
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Manifest string
    The rendered manifest of the helm release.
    Resources Dictionary<string, string>
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    Revision int
    The current revision number of the helm release.
    Status string
    The current status of the helm release.
    Id string
    The provider-assigned unique ID for this managed resource.
    Manifest string
    The rendered manifest of the helm release.
    Resources map[string]string
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    Revision int
    The current revision number of the helm release.
    Status string
    The current status of the helm release.
    id String
    The provider-assigned unique ID for this managed resource.
    manifest String
    The rendered manifest of the helm release.
    resources Map<String,String>
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision Integer
    The current revision number of the helm release.
    status String
    The current status of the helm release.
    id string
    The provider-assigned unique ID for this managed resource.
    manifest string
    The rendered manifest of the helm release.
    resources {[key: string]: string}
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision number
    The current revision number of the helm release.
    status string
    The current status of the helm release.
    id str
    The provider-assigned unique ID for this managed resource.
    manifest str
    The rendered manifest of the helm release.
    resources Mapping[str, str]
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision int
    The current revision number of the helm release.
    status str
    The current status of the helm release.
    id String
    The provider-assigned unique ID for this managed resource.
    manifest String
    The rendered manifest of the helm release.
    resources Map<String>
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision Number
    The current revision number of the helm release.
    status String
    The current status of the helm release.

    Look up Existing HelmRelease Resource

    Get an existing HelmRelease 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?: HelmReleaseState, opts?: CustomResourceOptions): HelmRelease
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        chart: Optional[str] = None,
        dependency_update: Optional[bool] = None,
        description: Optional[str] = None,
        gvc: Optional[str] = None,
        insecure_skip_tls_verify: Optional[bool] = None,
        manifest: Optional[str] = None,
        max_history: Optional[int] = None,
        name: Optional[str] = None,
        postrender: Optional[HelmReleasePostrenderArgs] = None,
        render_subchart_notes: Optional[bool] = None,
        repository: Optional[str] = None,
        repository_ca_file: Optional[str] = None,
        repository_cert_file: Optional[str] = None,
        repository_key_file: Optional[str] = None,
        repository_password: Optional[str] = None,
        repository_username: Optional[str] = None,
        resources: Optional[Mapping[str, str]] = None,
        revision: Optional[int] = None,
        set: Optional[Mapping[str, str]] = None,
        set_file: Optional[Mapping[str, str]] = None,
        set_string: Optional[Mapping[str, str]] = None,
        status: Optional[str] = None,
        timeout: Optional[int] = None,
        values: Optional[Sequence[str]] = None,
        verify: Optional[bool] = None,
        version: Optional[str] = None,
        wait: Optional[bool] = None) -> HelmRelease
    func GetHelmRelease(ctx *Context, name string, id IDInput, state *HelmReleaseState, opts ...ResourceOption) (*HelmRelease, error)
    public static HelmRelease Get(string name, Input<string> id, HelmReleaseState? state, CustomResourceOptions? opts = null)
    public static HelmRelease get(String name, Output<String> id, HelmReleaseState state, CustomResourceOptions options)
    resources:  _:    type: cpln:HelmRelease    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:
    Chart string
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    DependencyUpdate bool
    Update dependencies if they are missing before installing the chart.
    Description string
    Add a custom description for the release.
    Gvc string
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    InsecureSkipTlsVerify bool
    Skip TLS certificate checks for the chart download.
    Manifest string
    The rendered manifest of the helm release.
    MaxHistory int
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    Name string
    The release name for this helm deployment.
    Postrender Pulumiverse.Cpln.Inputs.HelmReleasePostrender
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    RenderSubchartNotes bool
    If set, render subchart notes along with the parent on install/upgrade.
    Repository string
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    RepositoryCaFile string
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    RepositoryCertFile string
    Identify HTTPS client using this SSL certificate file.
    RepositoryKeyFile string
    Identify HTTPS client using this SSL key file.
    RepositoryPassword string
    Chart repository password where to locate the requested chart.
    RepositoryUsername string
    Chart repository username where to locate the requested chart.
    Resources Dictionary<string, string>
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    Revision int
    The current revision number of the helm release.
    Set Dictionary<string, string>
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    SetFile Dictionary<string, string>
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    SetString Dictionary<string, string>
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    Status string
    The current status of the helm release.
    Timeout int
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    Values List<string>
    List of values in raw YAML to pass to helm.
    Verify bool
    Verify the package before using it.
    Version string
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    Wait bool
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    Chart string
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    DependencyUpdate bool
    Update dependencies if they are missing before installing the chart.
    Description string
    Add a custom description for the release.
    Gvc string
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    InsecureSkipTlsVerify bool
    Skip TLS certificate checks for the chart download.
    Manifest string
    The rendered manifest of the helm release.
    MaxHistory int
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    Name string
    The release name for this helm deployment.
    Postrender HelmReleasePostrenderArgs
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    RenderSubchartNotes bool
    If set, render subchart notes along with the parent on install/upgrade.
    Repository string
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    RepositoryCaFile string
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    RepositoryCertFile string
    Identify HTTPS client using this SSL certificate file.
    RepositoryKeyFile string
    Identify HTTPS client using this SSL key file.
    RepositoryPassword string
    Chart repository password where to locate the requested chart.
    RepositoryUsername string
    Chart repository username where to locate the requested chart.
    Resources map[string]string
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    Revision int
    The current revision number of the helm release.
    Set map[string]string
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    SetFile map[string]string
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    SetString map[string]string
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    Status string
    The current status of the helm release.
    Timeout int
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    Values []string
    List of values in raw YAML to pass to helm.
    Verify bool
    Verify the package before using it.
    Version string
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    Wait bool
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart String
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependencyUpdate Boolean
    Update dependencies if they are missing before installing the chart.
    description String
    Add a custom description for the release.
    gvc String
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecureSkipTlsVerify Boolean
    Skip TLS certificate checks for the chart download.
    manifest String
    The rendered manifest of the helm release.
    maxHistory Integer
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name String
    The release name for this helm deployment.
    postrender HelmReleasePostrender
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    renderSubchartNotes Boolean
    If set, render subchart notes along with the parent on install/upgrade.
    repository String
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repositoryCaFile String
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repositoryCertFile String
    Identify HTTPS client using this SSL certificate file.
    repositoryKeyFile String
    Identify HTTPS client using this SSL key file.
    repositoryPassword String
    Chart repository password where to locate the requested chart.
    repositoryUsername String
    Chart repository username where to locate the requested chart.
    resources Map<String,String>
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision Integer
    The current revision number of the helm release.
    set Map<String,String>
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    setFile Map<String,String>
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    setString Map<String,String>
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    status String
    The current status of the helm release.
    timeout Integer
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values List<String>
    List of values in raw YAML to pass to helm.
    verify Boolean
    Verify the package before using it.
    version String
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait_ Boolean
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart string
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependencyUpdate boolean
    Update dependencies if they are missing before installing the chart.
    description string
    Add a custom description for the release.
    gvc string
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecureSkipTlsVerify boolean
    Skip TLS certificate checks for the chart download.
    manifest string
    The rendered manifest of the helm release.
    maxHistory number
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name string
    The release name for this helm deployment.
    postrender HelmReleasePostrender
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    renderSubchartNotes boolean
    If set, render subchart notes along with the parent on install/upgrade.
    repository string
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repositoryCaFile string
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repositoryCertFile string
    Identify HTTPS client using this SSL certificate file.
    repositoryKeyFile string
    Identify HTTPS client using this SSL key file.
    repositoryPassword string
    Chart repository password where to locate the requested chart.
    repositoryUsername string
    Chart repository username where to locate the requested chart.
    resources {[key: string]: string}
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision number
    The current revision number of the helm release.
    set {[key: string]: string}
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    setFile {[key: string]: string}
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    setString {[key: string]: string}
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    status string
    The current status of the helm release.
    timeout number
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values string[]
    List of values in raw YAML to pass to helm.
    verify boolean
    Verify the package before using it.
    version string
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait boolean
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart str
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependency_update bool
    Update dependencies if they are missing before installing the chart.
    description str
    Add a custom description for the release.
    gvc str
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecure_skip_tls_verify bool
    Skip TLS certificate checks for the chart download.
    manifest str
    The rendered manifest of the helm release.
    max_history int
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name str
    The release name for this helm deployment.
    postrender HelmReleasePostrenderArgs
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    render_subchart_notes bool
    If set, render subchart notes along with the parent on install/upgrade.
    repository str
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repository_ca_file str
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repository_cert_file str
    Identify HTTPS client using this SSL certificate file.
    repository_key_file str
    Identify HTTPS client using this SSL key file.
    repository_password str
    Chart repository password where to locate the requested chart.
    repository_username str
    Chart repository username where to locate the requested chart.
    resources Mapping[str, str]
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision int
    The current revision number of the helm release.
    set Mapping[str, str]
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    set_file Mapping[str, str]
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    set_string Mapping[str, str]
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    status str
    The current status of the helm release.
    timeout int
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values Sequence[str]
    List of values in raw YAML to pass to helm.
    verify bool
    Verify the package before using it.
    version str
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait bool
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
    chart String
    Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
    dependencyUpdate Boolean
    Update dependencies if they are missing before installing the chart.
    description String
    Add a custom description for the release.
    gvc String
    The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
    insecureSkipTlsVerify Boolean
    Skip TLS certificate checks for the chart download.
    manifest String
    The rendered manifest of the helm release.
    maxHistory Number
    Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
    name String
    The release name for this helm deployment.
    postrender Property Map
    Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
    renderSubchartNotes Boolean
    If set, render subchart notes along with the parent on install/upgrade.
    repository String
    Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
    repositoryCaFile String
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    repositoryCertFile String
    Identify HTTPS client using this SSL certificate file.
    repositoryKeyFile String
    Identify HTTPS client using this SSL key file.
    repositoryPassword String
    Chart repository password where to locate the requested chart.
    repositoryUsername String
    Chart repository username where to locate the requested chart.
    resources Map<String>
    Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
    revision Number
    The current revision number of the helm release.
    set Map<String>
    Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
    setFile Map<String>
    Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
    setString Map<String>
    Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
    status String
    The current status of the helm release.
    timeout Number
    The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
    values List<String>
    List of values in raw YAML to pass to helm.
    verify Boolean
    Verify the package before using it.
    version String
    Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
    wait Boolean
    If set to true, will wait until all Workloads are in a ready state before marking the release as successful.

    Supporting Types

    HelmReleasePostrender, HelmReleasePostrenderArgs

    BinaryPath string
    The path to an executable to be used for post rendering.
    Args List<string>
    Arguments to the post-renderer.
    BinaryPath string
    The path to an executable to be used for post rendering.
    Args []string
    Arguments to the post-renderer.
    binaryPath String
    The path to an executable to be used for post rendering.
    args List<String>
    Arguments to the post-renderer.
    binaryPath string
    The path to an executable to be used for post rendering.
    args string[]
    Arguments to the post-renderer.
    binary_path str
    The path to an executable to be used for post rendering.
    args Sequence[str]
    Arguments to the post-renderer.
    binaryPath String
    The path to an executable to be used for post rendering.
    args List<String>
    Arguments to the post-renderer.

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Viewing docs for Control Plane v0.0.84
    published on Friday, Mar 20, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-cpln
      Try Pulumi Cloud free. Your team will thank you.