1. Packages
  2. Qovery
  3. API Docs
  4. getHelm
Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien

qovery.getHelm

Explore with Pulumi AI

qovery logo
Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien

    # qovery.Helm (Data Source)

    Provides a Qovery helm resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as qovery from "@pulumi/qovery";
    
    const myHelm = qovery.getHelm({
        id: "<helm_id>",
    });
    
    import pulumi
    import pulumi_qovery as qovery
    
    my_helm = qovery.get_helm(id="<helm_id>")
    
    package main
    
    import (
    	"github.com/dirien/pulumi-qovery/sdk/go/qovery"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := qovery.LookupHelm(ctx, &qovery.LookupHelmArgs{
    			Id: "<helm_id>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Qovery = Pulumi.Qovery;
    
    return await Deployment.RunAsync(() => 
    {
        var myHelm = Qovery.GetHelm.Invoke(new()
        {
            Id = "<helm_id>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.qovery.QoveryFunctions;
    import com.pulumi.qovery.inputs.GetHelmArgs;
    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) {
            final var myHelm = QoveryFunctions.getHelm(GetHelmArgs.builder()
                .id("<helm_id>")
                .build());
    
        }
    }
    
    variables:
      myHelm:
        fn::invoke:
          Function: qovery:getHelm
          Arguments:
            id: <helm_id>
    

    Using getHelm

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHelm(args: GetHelmArgs, opts?: InvokeOptions): Promise<GetHelmResult>
    function getHelmOutput(args: GetHelmOutputArgs, opts?: InvokeOptions): Output<GetHelmResult>
    def get_helm(advanced_settings_json: Optional[str] = None,
                 deployment_restrictions: Optional[Sequence[GetHelmDeploymentRestriction]] = None,
                 deployment_stage_id: Optional[str] = None,
                 environment_variable_aliases: Optional[Sequence[GetHelmEnvironmentVariableAlias]] = None,
                 environment_variable_overrides: Optional[Sequence[GetHelmEnvironmentVariableOverride]] = None,
                 environment_variables: Optional[Sequence[GetHelmEnvironmentVariable]] = None,
                 id: Optional[str] = None,
                 secret_aliases: Optional[Sequence[GetHelmSecretAlias]] = None,
                 secret_overrides: Optional[Sequence[GetHelmSecretOverride]] = None,
                 secrets: Optional[Sequence[GetHelmSecret]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetHelmResult
    def get_helm_output(advanced_settings_json: Optional[pulumi.Input[str]] = None,
                 deployment_restrictions: Optional[pulumi.Input[Sequence[pulumi.Input[GetHelmDeploymentRestrictionArgs]]]] = None,
                 deployment_stage_id: Optional[pulumi.Input[str]] = None,
                 environment_variable_aliases: Optional[pulumi.Input[Sequence[pulumi.Input[GetHelmEnvironmentVariableAliasArgs]]]] = None,
                 environment_variable_overrides: Optional[pulumi.Input[Sequence[pulumi.Input[GetHelmEnvironmentVariableOverrideArgs]]]] = None,
                 environment_variables: Optional[pulumi.Input[Sequence[pulumi.Input[GetHelmEnvironmentVariableArgs]]]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 secret_aliases: Optional[pulumi.Input[Sequence[pulumi.Input[GetHelmSecretAliasArgs]]]] = None,
                 secret_overrides: Optional[pulumi.Input[Sequence[pulumi.Input[GetHelmSecretOverrideArgs]]]] = None,
                 secrets: Optional[pulumi.Input[Sequence[pulumi.Input[GetHelmSecretArgs]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetHelmResult]
    func LookupHelm(ctx *Context, args *LookupHelmArgs, opts ...InvokeOption) (*LookupHelmResult, error)
    func LookupHelmOutput(ctx *Context, args *LookupHelmOutputArgs, opts ...InvokeOption) LookupHelmResultOutput

    > Note: This function is named LookupHelm in the Go SDK.

    public static class GetHelm 
    {
        public static Task<GetHelmResult> InvokeAsync(GetHelmArgs args, InvokeOptions? opts = null)
        public static Output<GetHelmResult> Invoke(GetHelmInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHelmResult> getHelm(GetHelmArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: qovery:index/getHelm:getHelm
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Id of the helm.
    AdvancedSettingsJson string
    Advanced settings.
    DeploymentRestrictions List<ediri.Qovery.Inputs.GetHelmDeploymentRestriction>
    List of deployment restrictions
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentVariableAliases List<ediri.Qovery.Inputs.GetHelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    EnvironmentVariableOverrides List<ediri.Qovery.Inputs.GetHelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    EnvironmentVariables List<ediri.Qovery.Inputs.GetHelmEnvironmentVariable>
    List of environment variables linked to this helm.
    SecretAliases List<ediri.Qovery.Inputs.GetHelmSecretAlias>
    List of secret aliases linked to this helm.
    SecretOverrides List<ediri.Qovery.Inputs.GetHelmSecretOverride>
    List of secret overrides linked to this helm.
    Secrets List<ediri.Qovery.Inputs.GetHelmSecret>
    List of secrets linked to this helm.
    Id string
    Id of the helm.
    AdvancedSettingsJson string
    Advanced settings.
    DeploymentRestrictions []GetHelmDeploymentRestriction
    List of deployment restrictions
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentVariableAliases []GetHelmEnvironmentVariableAlias
    List of environment variable aliases linked to this helm.
    EnvironmentVariableOverrides []GetHelmEnvironmentVariableOverride
    List of environment variable overrides linked to this helm.
    EnvironmentVariables []GetHelmEnvironmentVariable
    List of environment variables linked to this helm.
    SecretAliases []GetHelmSecretAlias
    List of secret aliases linked to this helm.
    SecretOverrides []GetHelmSecretOverride
    List of secret overrides linked to this helm.
    Secrets []GetHelmSecret
    List of secrets linked to this helm.
    id String
    Id of the helm.
    advancedSettingsJson String
    Advanced settings.
    deploymentRestrictions List<GetHelmDeploymentRestriction>
    List of deployment restrictions
    deploymentStageId String
    Id of the deployment stage.
    environmentVariableAliases List<GetHelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides List<GetHelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    environmentVariables List<GetHelmEnvironmentVariable>
    List of environment variables linked to this helm.
    secretAliases List<GetHelmSecretAlias>
    List of secret aliases linked to this helm.
    secretOverrides List<GetHelmSecretOverride>
    List of secret overrides linked to this helm.
    secrets List<GetHelmSecret>
    List of secrets linked to this helm.
    id string
    Id of the helm.
    advancedSettingsJson string
    Advanced settings.
    deploymentRestrictions GetHelmDeploymentRestriction[]
    List of deployment restrictions
    deploymentStageId string
    Id of the deployment stage.
    environmentVariableAliases GetHelmEnvironmentVariableAlias[]
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides GetHelmEnvironmentVariableOverride[]
    List of environment variable overrides linked to this helm.
    environmentVariables GetHelmEnvironmentVariable[]
    List of environment variables linked to this helm.
    secretAliases GetHelmSecretAlias[]
    List of secret aliases linked to this helm.
    secretOverrides GetHelmSecretOverride[]
    List of secret overrides linked to this helm.
    secrets GetHelmSecret[]
    List of secrets linked to this helm.
    id str
    Id of the helm.
    advanced_settings_json str
    Advanced settings.
    deployment_restrictions Sequence[GetHelmDeploymentRestriction]
    List of deployment restrictions
    deployment_stage_id str
    Id of the deployment stage.
    environment_variable_aliases Sequence[GetHelmEnvironmentVariableAlias]
    List of environment variable aliases linked to this helm.
    environment_variable_overrides Sequence[GetHelmEnvironmentVariableOverride]
    List of environment variable overrides linked to this helm.
    environment_variables Sequence[GetHelmEnvironmentVariable]
    List of environment variables linked to this helm.
    secret_aliases Sequence[GetHelmSecretAlias]
    List of secret aliases linked to this helm.
    secret_overrides Sequence[GetHelmSecretOverride]
    List of secret overrides linked to this helm.
    secrets Sequence[GetHelmSecret]
    List of secrets linked to this helm.
    id String
    Id of the helm.
    advancedSettingsJson String
    Advanced settings.
    deploymentRestrictions List<Property Map>
    List of deployment restrictions
    deploymentStageId String
    Id of the deployment stage.
    environmentVariableAliases List<Property Map>
    List of environment variable aliases linked to this helm.
    environmentVariableOverrides List<Property Map>
    List of environment variable overrides linked to this helm.
    environmentVariables List<Property Map>
    List of environment variables linked to this helm.
    secretAliases List<Property Map>
    List of secret aliases linked to this helm.
    secretOverrides List<Property Map>
    List of secret overrides linked to this helm.
    secrets List<Property Map>
    List of secrets linked to this helm.

    getHelm Result

    The following output properties are available:

    AdvancedSettingsJson string
    Advanced settings.
    BuiltInEnvironmentVariables List<ediri.Qovery.Outputs.GetHelmBuiltInEnvironmentVariable>
    List of built-in environment variables linked to this helm.
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentId string
    Id of the environment.
    EnvironmentVariableAliases List<ediri.Qovery.Outputs.GetHelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    ExternalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    Id string
    Id of the helm.
    InternalHost string
    The helm internal host.
    Name string
    Name of the helm.
    DeploymentRestrictions List<ediri.Qovery.Outputs.GetHelmDeploymentRestriction>
    List of deployment restrictions
    EnvironmentVariableOverrides List<ediri.Qovery.Outputs.GetHelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    EnvironmentVariables List<ediri.Qovery.Outputs.GetHelmEnvironmentVariable>
    List of environment variables linked to this helm.
    SecretAliases List<ediri.Qovery.Outputs.GetHelmSecretAlias>
    List of secret aliases linked to this helm.
    SecretOverrides List<ediri.Qovery.Outputs.GetHelmSecretOverride>
    List of secret overrides linked to this helm.
    Secrets List<ediri.Qovery.Outputs.GetHelmSecret>
    List of secrets linked to this helm.
    AdvancedSettingsJson string
    Advanced settings.
    BuiltInEnvironmentVariables []GetHelmBuiltInEnvironmentVariable
    List of built-in environment variables linked to this helm.
    DeploymentStageId string
    Id of the deployment stage.
    EnvironmentId string
    Id of the environment.
    EnvironmentVariableAliases []GetHelmEnvironmentVariableAlias
    List of environment variable aliases linked to this helm.
    ExternalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    Id string
    Id of the helm.
    InternalHost string
    The helm internal host.
    Name string
    Name of the helm.
    DeploymentRestrictions []GetHelmDeploymentRestriction
    List of deployment restrictions
    EnvironmentVariableOverrides []GetHelmEnvironmentVariableOverride
    List of environment variable overrides linked to this helm.
    EnvironmentVariables []GetHelmEnvironmentVariable
    List of environment variables linked to this helm.
    SecretAliases []GetHelmSecretAlias
    List of secret aliases linked to this helm.
    SecretOverrides []GetHelmSecretOverride
    List of secret overrides linked to this helm.
    Secrets []GetHelmSecret
    List of secrets linked to this helm.
    advancedSettingsJson String
    Advanced settings.
    builtInEnvironmentVariables List<GetHelmBuiltInEnvironmentVariable>
    List of built-in environment variables linked to this helm.
    deploymentStageId String
    Id of the deployment stage.
    environmentId String
    Id of the environment.
    environmentVariableAliases List<GetHelmEnvironmentVariableAlias>
    List of environment variable aliases linked to this helm.
    externalHost String
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id String
    Id of the helm.
    internalHost String
    The helm internal host.
    name String
    Name of the helm.
    deploymentRestrictions List<GetHelmDeploymentRestriction>
    List of deployment restrictions
    environmentVariableOverrides List<GetHelmEnvironmentVariableOverride>
    List of environment variable overrides linked to this helm.
    environmentVariables List<GetHelmEnvironmentVariable>
    List of environment variables linked to this helm.
    secretAliases List<GetHelmSecretAlias>
    List of secret aliases linked to this helm.
    secretOverrides List<GetHelmSecretOverride>
    List of secret overrides linked to this helm.
    secrets List<GetHelmSecret>
    List of secrets linked to this helm.
    advancedSettingsJson string
    Advanced settings.
    builtInEnvironmentVariables GetHelmBuiltInEnvironmentVariable[]
    List of built-in environment variables linked to this helm.
    deploymentStageId string
    Id of the deployment stage.
    environmentId string
    Id of the environment.
    environmentVariableAliases GetHelmEnvironmentVariableAlias[]
    List of environment variable aliases linked to this helm.
    externalHost string
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id string
    Id of the helm.
    internalHost string
    The helm internal host.
    name string
    Name of the helm.
    deploymentRestrictions GetHelmDeploymentRestriction[]
    List of deployment restrictions
    environmentVariableOverrides GetHelmEnvironmentVariableOverride[]
    List of environment variable overrides linked to this helm.
    environmentVariables GetHelmEnvironmentVariable[]
    List of environment variables linked to this helm.
    secretAliases GetHelmSecretAlias[]
    List of secret aliases linked to this helm.
    secretOverrides GetHelmSecretOverride[]
    List of secret overrides linked to this helm.
    secrets GetHelmSecret[]
    List of secrets linked to this helm.
    advanced_settings_json str
    Advanced settings.
    built_in_environment_variables Sequence[GetHelmBuiltInEnvironmentVariable]
    List of built-in environment variables linked to this helm.
    deployment_stage_id str
    Id of the deployment stage.
    environment_id str
    Id of the environment.
    environment_variable_aliases Sequence[GetHelmEnvironmentVariableAlias]
    List of environment variable aliases linked to this helm.
    external_host str
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id str
    Id of the helm.
    internal_host str
    The helm internal host.
    name str
    Name of the helm.
    deployment_restrictions Sequence[GetHelmDeploymentRestriction]
    List of deployment restrictions
    environment_variable_overrides Sequence[GetHelmEnvironmentVariableOverride]
    List of environment variable overrides linked to this helm.
    environment_variables Sequence[GetHelmEnvironmentVariable]
    List of environment variables linked to this helm.
    secret_aliases Sequence[GetHelmSecretAlias]
    List of secret aliases linked to this helm.
    secret_overrides Sequence[GetHelmSecretOverride]
    List of secret overrides linked to this helm.
    secrets Sequence[GetHelmSecret]
    List of secrets linked to this helm.
    advancedSettingsJson String
    Advanced settings.
    builtInEnvironmentVariables List<Property Map>
    List of built-in environment variables linked to this helm.
    deploymentStageId String
    Id of the deployment stage.
    environmentId String
    Id of the environment.
    environmentVariableAliases List<Property Map>
    List of environment variable aliases linked to this helm.
    externalHost String
    The helm external FQDN host [NOTE: only if your helm is using a publicly accessible port].
    id String
    Id of the helm.
    internalHost String
    The helm internal host.
    name String
    Name of the helm.
    deploymentRestrictions List<Property Map>
    List of deployment restrictions
    environmentVariableOverrides List<Property Map>
    List of environment variable overrides linked to this helm.
    environmentVariables List<Property Map>
    List of environment variables linked to this helm.
    secretAliases List<Property Map>
    List of secret aliases linked to this helm.
    secretOverrides List<Property Map>
    List of secret overrides linked to this helm.
    secrets List<Property Map>
    List of secrets linked to this helm.

    Supporting Types

    GetHelmBuiltInEnvironmentVariable

    Id string
    Id of the environment variable.
    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    Id string
    Id of the environment variable.
    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    id String
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.
    id string
    Id of the environment variable.
    key string
    Key of the environment variable.
    value string
    Value of the environment variable.
    id str
    Id of the environment variable.
    key str
    Key of the environment variable.
    value str
    Value of the environment variable.
    id String
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.

    GetHelmDeploymentRestriction

    Id string
    Id of the deployment restriction
    Mode string
    Can be EXCLUDE or MATCH
    Type string
    Currently, only PATH is accepted
    Value string
    Value of the deployment restriction
    Id string
    Id of the deployment restriction
    Mode string
    Can be EXCLUDE or MATCH
    Type string
    Currently, only PATH is accepted
    Value string
    Value of the deployment restriction
    id String
    Id of the deployment restriction
    mode String
    Can be EXCLUDE or MATCH
    type String
    Currently, only PATH is accepted
    value String
    Value of the deployment restriction
    id string
    Id of the deployment restriction
    mode string
    Can be EXCLUDE or MATCH
    type string
    Currently, only PATH is accepted
    value string
    Value of the deployment restriction
    id str
    Id of the deployment restriction
    mode str
    Can be EXCLUDE or MATCH
    type str
    Currently, only PATH is accepted
    value str
    Value of the deployment restriction
    id String
    Id of the deployment restriction
    mode String
    Can be EXCLUDE or MATCH
    type String
    Currently, only PATH is accepted
    value String
    Value of the deployment restriction

    GetHelmEnvironmentVariable

    Id string
    Id of the environment variable.
    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    Id string
    Id of the environment variable.
    Key string
    Key of the environment variable.
    Value string
    Value of the environment variable.
    id String
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.
    id string
    Id of the environment variable.
    key string
    Key of the environment variable.
    value string
    Value of the environment variable.
    id str
    Id of the environment variable.
    key str
    Key of the environment variable.
    value str
    Value of the environment variable.
    id String
    Id of the environment variable.
    key String
    Key of the environment variable.
    value String
    Value of the environment variable.

    GetHelmEnvironmentVariableAlias

    Id string
    Id of the environment variable alias.
    Key string
    Name of the environment variable alias.
    Value string
    Name of the variable to alias.
    Id string
    Id of the environment variable alias.
    Key string
    Name of the environment variable alias.
    Value string
    Name of the variable to alias.
    id String
    Id of the environment variable alias.
    key String
    Name of the environment variable alias.
    value String
    Name of the variable to alias.
    id string
    Id of the environment variable alias.
    key string
    Name of the environment variable alias.
    value string
    Name of the variable to alias.
    id str
    Id of the environment variable alias.
    key str
    Name of the environment variable alias.
    value str
    Name of the variable to alias.
    id String
    Id of the environment variable alias.
    key String
    Name of the environment variable alias.
    value String
    Name of the variable to alias.

    GetHelmEnvironmentVariableOverride

    Id string
    Id of the environment variable override.
    Key string
    Name of the environment variable override.
    Value string
    Value of the environment variable override.
    Id string
    Id of the environment variable override.
    Key string
    Name of the environment variable override.
    Value string
    Value of the environment variable override.
    id String
    Id of the environment variable override.
    key String
    Name of the environment variable override.
    value String
    Value of the environment variable override.
    id string
    Id of the environment variable override.
    key string
    Name of the environment variable override.
    value string
    Value of the environment variable override.
    id str
    Id of the environment variable override.
    key str
    Name of the environment variable override.
    value str
    Value of the environment variable override.
    id String
    Id of the environment variable override.
    key String
    Name of the environment variable override.
    value String
    Value of the environment variable override.

    GetHelmSecret

    Id string
    Id of the secret.
    Key string
    Key of the secret.
    Value string
    Value of the secret.
    Id string
    Id of the secret.
    Key string
    Key of the secret.
    Value string
    Value of the secret.
    id String
    Id of the secret.
    key String
    Key of the secret.
    value String
    Value of the secret.
    id string
    Id of the secret.
    key string
    Key of the secret.
    value string
    Value of the secret.
    id str
    Id of the secret.
    key str
    Key of the secret.
    value str
    Value of the secret.
    id String
    Id of the secret.
    key String
    Key of the secret.
    value String
    Value of the secret.

    GetHelmSecretAlias

    Id string
    Id of the secret alias.
    Key string
    Name of the secret alias.
    Value string
    Name of the secret to alias.
    Id string
    Id of the secret alias.
    Key string
    Name of the secret alias.
    Value string
    Name of the secret to alias.
    id String
    Id of the secret alias.
    key String
    Name of the secret alias.
    value String
    Name of the secret to alias.
    id string
    Id of the secret alias.
    key string
    Name of the secret alias.
    value string
    Name of the secret to alias.
    id str
    Id of the secret alias.
    key str
    Name of the secret alias.
    value str
    Name of the secret to alias.
    id String
    Id of the secret alias.
    key String
    Name of the secret alias.
    value String
    Name of the secret to alias.

    GetHelmSecretOverride

    Id string
    Id of the secret override.
    Key string
    Name of the secret override.
    Value string
    Value of the secret override.
    Id string
    Id of the secret override.
    Key string
    Name of the secret override.
    Value string
    Value of the secret override.
    id String
    Id of the secret override.
    key String
    Name of the secret override.
    value String
    Value of the secret override.
    id string
    Id of the secret override.
    key string
    Name of the secret override.
    value string
    Value of the secret override.
    id str
    Id of the secret override.
    key str
    Name of the secret override.
    value str
    Value of the secret override.
    id String
    Id of the secret override.
    key String
    Name of the secret override.
    value String
    Value of the secret override.

    Package Details

    Repository
    qovery dirien/pulumi-qovery
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the qovery Terraform Provider.
    qovery logo
    Qovery v0.28.10 published on Friday, Jun 7, 2024 by dirien