1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. HelmConnector
Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi

harness.platform.HelmConnector

Explore with Pulumi AI

harness logo
Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi

    Resource for creating a HTTP Helm connector.

    Create HelmConnector Resource

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

    Constructor syntax

    new HelmConnector(name: string, args: HelmConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def HelmConnector(resource_name: str,
                      args: HelmConnectorArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def HelmConnector(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      identifier: Optional[str] = None,
                      url: Optional[str] = None,
                      credentials: Optional[HelmConnectorCredentialsArgs] = None,
                      delegate_selectors: Optional[Sequence[str]] = None,
                      description: Optional[str] = None,
                      force_delete: Optional[bool] = None,
                      name: Optional[str] = None,
                      org_id: Optional[str] = None,
                      project_id: Optional[str] = None,
                      tags: Optional[Sequence[str]] = None)
    func NewHelmConnector(ctx *Context, name string, args HelmConnectorArgs, opts ...ResourceOption) (*HelmConnector, error)
    public HelmConnector(string name, HelmConnectorArgs args, CustomResourceOptions? opts = null)
    public HelmConnector(String name, HelmConnectorArgs args)
    public HelmConnector(String name, HelmConnectorArgs args, CustomResourceOptions options)
    
    type: harness:platform:HelmConnector
    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 HelmConnectorArgs
    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 HelmConnectorArgs
    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 HelmConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HelmConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HelmConnectorArgs
    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 helmConnectorResource = new Harness.Platform.HelmConnector("helmConnectorResource", new()
    {
        Identifier = "string",
        Url = "string",
        Credentials = new Harness.Platform.Inputs.HelmConnectorCredentialsArgs
        {
            PasswordRef = "string",
            Username = "string",
            UsernameRef = "string",
        },
        DelegateSelectors = new[]
        {
            "string",
        },
        Description = "string",
        ForceDelete = false,
        Name = "string",
        OrgId = "string",
        ProjectId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewHelmConnector(ctx, "helmConnectorResource", &platform.HelmConnectorArgs{
    	Identifier: pulumi.String("string"),
    	Url:        pulumi.String("string"),
    	Credentials: &platform.HelmConnectorCredentialsArgs{
    		PasswordRef: pulumi.String("string"),
    		Username:    pulumi.String("string"),
    		UsernameRef: pulumi.String("string"),
    	},
    	DelegateSelectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	ForceDelete: pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    	OrgId:       pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var helmConnectorResource = new HelmConnector("helmConnectorResource", HelmConnectorArgs.builder()
        .identifier("string")
        .url("string")
        .credentials(HelmConnectorCredentialsArgs.builder()
            .passwordRef("string")
            .username("string")
            .usernameRef("string")
            .build())
        .delegateSelectors("string")
        .description("string")
        .forceDelete(false)
        .name("string")
        .orgId("string")
        .projectId("string")
        .tags("string")
        .build());
    
    helm_connector_resource = harness.platform.HelmConnector("helmConnectorResource",
        identifier="string",
        url="string",
        credentials=harness.platform.HelmConnectorCredentialsArgs(
            password_ref="string",
            username="string",
            username_ref="string",
        ),
        delegate_selectors=["string"],
        description="string",
        force_delete=False,
        name="string",
        org_id="string",
        project_id="string",
        tags=["string"])
    
    const helmConnectorResource = new harness.platform.HelmConnector("helmConnectorResource", {
        identifier: "string",
        url: "string",
        credentials: {
            passwordRef: "string",
            username: "string",
            usernameRef: "string",
        },
        delegateSelectors: ["string"],
        description: "string",
        forceDelete: false,
        name: "string",
        orgId: "string",
        projectId: "string",
        tags: ["string"],
    });
    
    type: harness:platform:HelmConnector
    properties:
        credentials:
            passwordRef: string
            username: string
            usernameRef: string
        delegateSelectors:
            - string
        description: string
        forceDelete: false
        identifier: string
        name: string
        orgId: string
        projectId: string
        tags:
            - string
        url: string
    

    HelmConnector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The HelmConnector resource accepts the following input properties:

    Identifier string
    Unique identifier of the resource.
    Url string
    URL of the helm server.
    Credentials HelmConnectorCredentials
    Credentials to use for authentication.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ForceDelete bool
    Enable this flag for force deletion of connector
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Identifier string
    Unique identifier of the resource.
    Url string
    URL of the helm server.
    Credentials HelmConnectorCredentialsArgs
    Credentials to use for authentication.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ForceDelete bool
    Enable this flag for force deletion of connector
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    identifier String
    Unique identifier of the resource.
    url String
    URL of the helm server.
    credentials HelmConnectorCredentials
    Credentials to use for authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    forceDelete Boolean
    Enable this flag for force deletion of connector
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    identifier string
    Unique identifier of the resource.
    url string
    URL of the helm server.
    credentials HelmConnectorCredentials
    Credentials to use for authentication.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    forceDelete boolean
    Enable this flag for force deletion of connector
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    identifier str
    Unique identifier of the resource.
    url str
    URL of the helm server.
    credentials HelmConnectorCredentialsArgs
    Credentials to use for authentication.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    force_delete bool
    Enable this flag for force deletion of connector
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    identifier String
    Unique identifier of the resource.
    url String
    URL of the helm server.
    credentials Property Map
    Credentials to use for authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    forceDelete Boolean
    Enable this flag for force deletion of connector
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing HelmConnector Resource

    Get an existing HelmConnector 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?: HelmConnectorState, opts?: CustomResourceOptions): HelmConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials: Optional[HelmConnectorCredentialsArgs] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            force_delete: Optional[bool] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            url: Optional[str] = None) -> HelmConnector
    func GetHelmConnector(ctx *Context, name string, id IDInput, state *HelmConnectorState, opts ...ResourceOption) (*HelmConnector, error)
    public static HelmConnector Get(string name, Input<string> id, HelmConnectorState? state, CustomResourceOptions? opts = null)
    public static HelmConnector get(String name, Output<String> id, HelmConnectorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Credentials HelmConnectorCredentials
    Credentials to use for authentication.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ForceDelete bool
    Enable this flag for force deletion of connector
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Url string
    URL of the helm server.
    Credentials HelmConnectorCredentialsArgs
    Credentials to use for authentication.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ForceDelete bool
    Enable this flag for force deletion of connector
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    Url string
    URL of the helm server.
    credentials HelmConnectorCredentials
    Credentials to use for authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    forceDelete Boolean
    Enable this flag for force deletion of connector
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the helm server.
    credentials HelmConnectorCredentials
    Credentials to use for authentication.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    forceDelete boolean
    Enable this flag for force deletion of connector
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    url string
    URL of the helm server.
    credentials HelmConnectorCredentialsArgs
    Credentials to use for authentication.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    force_delete bool
    Enable this flag for force deletion of connector
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    url str
    URL of the helm server.
    credentials Property Map
    Credentials to use for authentication.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    forceDelete Boolean
    Enable this flag for force deletion of connector
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the helm server.

    Supporting Types

    HelmConnectorCredentials, HelmConnectorCredentialsArgs

    PasswordRef string
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Username string
    Username to use for authentication.
    UsernameRef string
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    PasswordRef string
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Username string
    Username to use for authentication.
    UsernameRef string
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    passwordRef String
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username String
    Username to use for authentication.
    usernameRef String
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    passwordRef string
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username string
    Username to use for authentication.
    usernameRef string
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    password_ref str
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username str
    Username to use for authentication.
    username_ref str
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    passwordRef String
    Reference to a secret containing the password to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username String
    Username to use for authentication.
    usernameRef String
    Reference to a secret containing the username to use for authentication. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    Import

    Import account level helm connector

    $ pulumi import harness:platform/helmConnector:HelmConnector example <connector_id>
    

    Import org level helm connector

    $ pulumi import harness:platform/helmConnector:HelmConnector example <ord_id>/<connector_id>
    

    Import project level helm connector

    $ pulumi import harness:platform/helmConnector:HelmConnector example <org_id>/<project_id>/<connector_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi