Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. SshCredential
Harness v0.6.0 published on Tuesday, Mar 25, 2025 by Pulumi
pulumi/pulumi-harness

harness.SshCredential

Explore with Pulumi AI

harness logo
Harness v0.6.0 published on Tuesday, Mar 25, 2025 by Pulumi
pulumi/pulumi-harness

    Resource for creating an encrypted text secret

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as harness from "@pulumi/harness";
import * as tls from "@pulumi/tls";

const harnessDeployKey = new tls.index.PrivateKey("harness_deploy_key", {
    algorithm: "RSA",
    rsaBits: 4096,
});
const secretManager = harness.getSecretManager({
    "default": true,
});
const mySecret = new harness.EncryptedText("my_secret", {
    name: "my_secret",
    value: harnessDeployKey.privateKeyPem,
    secretManagerId: secretManager.then(secretManager => secretManager.id),
});
const sshCreds = new harness.SshCredential("ssh_creds", {
    name: "ssh-test",
    sshAuthentication: {
        port: 22,
        username: "git",
        inlineSsh: {
            sshKeyFileId: mySecret.id,
        },
    },
});

    import pulumi
import pulumi_harness as harness
import pulumi_tls as tls

harness_deploy_key = tls.index.PrivateKey("harness_deploy_key",
    algorithm=RSA,
    rsa_bits=4096)
secret_manager = harness.get_secret_manager(default=True)
my_secret = harness.EncryptedText("my_secret",
    name="my_secret",
    value=harness_deploy_key["privateKeyPem"],
    secret_manager_id=secret_manager.id)
ssh_creds = harness.SshCredential("ssh_creds",
    name="ssh-test",
    ssh_authentication={
        "port": 22,
        "username": "git",
        "inline_ssh": {
            "ssh_key_file_id": my_secret.id,
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness"
	"github.com/pulumi/pulumi-tls/sdk/go/tls"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		harnessDeployKey, err := tls.NewPrivateKey(ctx, "harness_deploy_key", &tls.PrivateKeyArgs{
			Algorithm: "RSA",
			RsaBits:   4096,
		})
		if err != nil {
			return err
		}
		secretManager, err := harness.GetSecretManager(ctx, &harness.GetSecretManagerArgs{
			Default: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		mySecret, err := harness.NewEncryptedText(ctx, "my_secret", &harness.EncryptedTextArgs{
			Name:            pulumi.String("my_secret"),
			Value:           harnessDeployKey.PrivateKeyPem,
			SecretManagerId: pulumi.String(secretManager.Id),
		})
		if err != nil {
			return err
		}
		_, err = harness.NewSshCredential(ctx, "ssh_creds", &harness.SshCredentialArgs{
			Name: pulumi.String("ssh-test"),
			SshAuthentication: &harness.SshCredentialSshAuthenticationArgs{
				Port:     pulumi.Int(22),
				Username: pulumi.String("git"),
				InlineSsh: &harness.SshCredentialSshAuthenticationInlineSshArgs{
					SshKeyFileId: mySecret.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;
using Tls = Pulumi.Tls;

return await Deployment.RunAsync(() => 
{
    var harnessDeployKey = new Tls.Index.PrivateKey("harness_deploy_key", new()
    {
        Algorithm = "RSA",
        RsaBits = 4096,
    });

    var secretManager = Harness.GetSecretManager.Invoke(new()
    {
        Default = true,
    });

    var mySecret = new Harness.EncryptedText("my_secret", new()
    {
        Name = "my_secret",
        Value = harnessDeployKey.PrivateKeyPem,
        SecretManagerId = secretManager.Apply(getSecretManagerResult => getSecretManagerResult.Id),
    });

    var sshCreds = new Harness.SshCredential("ssh_creds", new()
    {
        Name = "ssh-test",
        SshAuthentication = new Harness.Inputs.SshCredentialSshAuthenticationArgs
        {
            Port = 22,
            Username = "git",
            InlineSsh = new Harness.Inputs.SshCredentialSshAuthenticationInlineSshArgs
            {
                SshKeyFileId = mySecret.Id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tls.privateKey;
import com.pulumi.tls.PrivateKeyArgs;
import com.pulumi.harness.HarnessFunctions;
import com.pulumi.harness.inputs.GetSecretManagerArgs;
import com.pulumi.harness.EncryptedText;
import com.pulumi.harness.EncryptedTextArgs;
import com.pulumi.harness.SshCredential;
import com.pulumi.harness.SshCredentialArgs;
import com.pulumi.harness.inputs.SshCredentialSshAuthenticationArgs;
import com.pulumi.harness.inputs.SshCredentialSshAuthenticationInlineSshArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var harnessDeployKey = new PrivateKey("harnessDeployKey", PrivateKeyArgs.builder()
            .algorithm("RSA")
            .rsaBits(4096)
            .build());

        final var secretManager = HarnessFunctions.getSecretManager(GetSecretManagerArgs.builder()
            .default_(true)
            .build());

        var mySecret = new EncryptedText("mySecret", EncryptedTextArgs.builder()
            .name("my_secret")
            .value(harnessDeployKey.privateKeyPem())
            .secretManagerId(secretManager.applyValue(getSecretManagerResult -> getSecretManagerResult.id()))
            .build());

        var sshCreds = new SshCredential("sshCreds", SshCredentialArgs.builder()
            .name("ssh-test")
            .sshAuthentication(SshCredentialSshAuthenticationArgs.builder()
                .port(22)
                .username("git")
                .inlineSsh(SshCredentialSshAuthenticationInlineSshArgs.builder()
                    .sshKeyFileId(mySecret.id())
                    .build())
                .build())
            .build());

    }
}

    resources:
  harnessDeployKey:
    type: tls:privateKey
    name: harness_deploy_key
    properties:
      algorithm: RSA
      rsaBits: 4096
  mySecret:
    type: harness:EncryptedText
    name: my_secret
    properties:
      name: my_secret
      value: ${harnessDeployKey.privateKeyPem}
      secretManagerId: ${secretManager.id}
  sshCreds:
    type: harness:SshCredential
    name: ssh_creds
    properties:
      name: ssh-test
      sshAuthentication:
        port: 22
        username: git
        inlineSsh:
          sshKeyFileId: ${mySecret.id}
variables:
  secretManager:
    fn::invoke:
      function: harness:getSecretManager
      arguments:
        default: true

    Create SshCredential Resource

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

    Constructor syntax

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

@overload
def SshCredential(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  kerberos_authentication: Optional[SshCredentialKerberosAuthenticationArgs] = None,
                  name: Optional[str] = None,
                  ssh_authentication: Optional[SshCredentialSshAuthenticationArgs] = None,
                  usage_scopes: Optional[Sequence[SshCredentialUsageScopeArgs]] = None)
    func NewSshCredential(ctx *Context, name string, args *SshCredentialArgs, opts ...ResourceOption) (*SshCredential, error)
    public SshCredential(string name, SshCredentialArgs? args = null, CustomResourceOptions? opts = null)
    public SshCredential(String name, SshCredentialArgs args)
public SshCredential(String name, SshCredentialArgs args, CustomResourceOptions options)

    type: harness:SshCredential
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 SshCredentialArgs
    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 SshCredentialArgs
    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 SshCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SshCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SshCredentialArgs
    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 sshCredentialResource = new Harness.SshCredential("sshCredentialResource", new()
{
    KerberosAuthentication = new Harness.Inputs.SshCredentialKerberosAuthenticationArgs
    {
        Port = 0,
        Principal = "string",
        Realm = "string",
        TgtGenerationMethod = new Harness.Inputs.SshCredentialKerberosAuthenticationTgtGenerationMethodArgs
        {
            KerberosPasswordId = "string",
            KeyTabFilePath = "string",
        },
    },
    Name = "string",
    SshAuthentication = new Harness.Inputs.SshCredentialSshAuthenticationArgs
    {
        Port = 0,
        Username = "string",
        InlineSsh = new Harness.Inputs.SshCredentialSshAuthenticationInlineSshArgs
        {
            SshKeyFileId = "string",
            PassphraseSecretId = "string",
        },
        ServerPassword = new Harness.Inputs.SshCredentialSshAuthenticationServerPasswordArgs
        {
            PasswordSecretId = "string",
        },
        SshKeyFile = new Harness.Inputs.SshCredentialSshAuthenticationSshKeyFileArgs
        {
            Path = "string",
            PassphraseSecretId = "string",
        },
    },
    UsageScopes = new[]
    {
        new Harness.Inputs.SshCredentialUsageScopeArgs
        {
            ApplicationId = "string",
            EnvironmentFilterType = "string",
            EnvironmentId = "string",
        },
    },
});

    example, err := harness.NewSshCredential(ctx, "sshCredentialResource", &harness.SshCredentialArgs{
	KerberosAuthentication: &harness.SshCredentialKerberosAuthenticationArgs{
		Port:      pulumi.Int(0),
		Principal: pulumi.String("string"),
		Realm:     pulumi.String("string"),
		TgtGenerationMethod: &harness.SshCredentialKerberosAuthenticationTgtGenerationMethodArgs{
			KerberosPasswordId: pulumi.String("string"),
			KeyTabFilePath:     pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	SshAuthentication: &harness.SshCredentialSshAuthenticationArgs{
		Port:     pulumi.Int(0),
		Username: pulumi.String("string"),
		InlineSsh: &harness.SshCredentialSshAuthenticationInlineSshArgs{
			SshKeyFileId:       pulumi.String("string"),
			PassphraseSecretId: pulumi.String("string"),
		},
		ServerPassword: &harness.SshCredentialSshAuthenticationServerPasswordArgs{
			PasswordSecretId: pulumi.String("string"),
		},
		SshKeyFile: &harness.SshCredentialSshAuthenticationSshKeyFileArgs{
			Path:               pulumi.String("string"),
			PassphraseSecretId: pulumi.String("string"),
		},
	},
	UsageScopes: harness.SshCredentialUsageScopeArray{
		&harness.SshCredentialUsageScopeArgs{
			ApplicationId:         pulumi.String("string"),
			EnvironmentFilterType: pulumi.String("string"),
			EnvironmentId:         pulumi.String("string"),
		},
	},
})

    var sshCredentialResource = new SshCredential("sshCredentialResource", SshCredentialArgs.builder()
    .kerberosAuthentication(SshCredentialKerberosAuthenticationArgs.builder()
        .port(0)
        .principal("string")
        .realm("string")
        .tgtGenerationMethod(SshCredentialKerberosAuthenticationTgtGenerationMethodArgs.builder()
            .kerberosPasswordId("string")
            .keyTabFilePath("string")
            .build())
        .build())
    .name("string")
    .sshAuthentication(SshCredentialSshAuthenticationArgs.builder()
        .port(0)
        .username("string")
        .inlineSsh(SshCredentialSshAuthenticationInlineSshArgs.builder()
            .sshKeyFileId("string")
            .passphraseSecretId("string")
            .build())
        .serverPassword(SshCredentialSshAuthenticationServerPasswordArgs.builder()
            .passwordSecretId("string")
            .build())
        .sshKeyFile(SshCredentialSshAuthenticationSshKeyFileArgs.builder()
            .path("string")
            .passphraseSecretId("string")
            .build())
        .build())
    .usageScopes(SshCredentialUsageScopeArgs.builder()
        .applicationId("string")
        .environmentFilterType("string")
        .environmentId("string")
        .build())
    .build());

    ssh_credential_resource = harness.SshCredential("sshCredentialResource",
    kerberos_authentication={
        "port": 0,
        "principal": "string",
        "realm": "string",
        "tgt_generation_method": {
            "kerberos_password_id": "string",
            "key_tab_file_path": "string",
        },
    },
    name="string",
    ssh_authentication={
        "port": 0,
        "username": "string",
        "inline_ssh": {
            "ssh_key_file_id": "string",
            "passphrase_secret_id": "string",
        },
        "server_password": {
            "password_secret_id": "string",
        },
        "ssh_key_file": {
            "path": "string",
            "passphrase_secret_id": "string",
        },
    },
    usage_scopes=[{
        "application_id": "string",
        "environment_filter_type": "string",
        "environment_id": "string",
    }])

    const sshCredentialResource = new harness.SshCredential("sshCredentialResource", {
    kerberosAuthentication: {
        port: 0,
        principal: "string",
        realm: "string",
        tgtGenerationMethod: {
            kerberosPasswordId: "string",
            keyTabFilePath: "string",
        },
    },
    name: "string",
    sshAuthentication: {
        port: 0,
        username: "string",
        inlineSsh: {
            sshKeyFileId: "string",
            passphraseSecretId: "string",
        },
        serverPassword: {
            passwordSecretId: "string",
        },
        sshKeyFile: {
            path: "string",
            passphraseSecretId: "string",
        },
    },
    usageScopes: [{
        applicationId: "string",
        environmentFilterType: "string",
        environmentId: "string",
    }],
});

    type: harness:SshCredential
properties:
    kerberosAuthentication:
        port: 0
        principal: string
        realm: string
        tgtGenerationMethod:
            kerberosPasswordId: string
            keyTabFilePath: string
    name: string
    sshAuthentication:
        inlineSsh:
            passphraseSecretId: string
            sshKeyFileId: string
        port: 0
        serverPassword:
            passwordSecretId: string
        sshKeyFile:
            passphraseSecretId: string
            path: string
        username: string
    usageScopes:
        - applicationId: string
          environmentFilterType: string
          environmentId: string

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

    KerberosAuthentication SshCredentialKerberosAuthentication
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    Name string
    Name of the encrypted text secret
    SshAuthentication SshCredentialSshAuthentication
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    UsageScopes List<SshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    KerberosAuthentication SshCredentialKerberosAuthenticationArgs
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    Name string
    Name of the encrypted text secret
    SshAuthentication SshCredentialSshAuthenticationArgs
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    UsageScopes []SshCredentialUsageScopeArgs
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberosAuthentication SshCredentialKerberosAuthentication
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name String
    Name of the encrypted text secret
    sshAuthentication SshCredentialSshAuthentication
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usageScopes List<SshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberosAuthentication SshCredentialKerberosAuthentication
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name string
    Name of the encrypted text secret
    sshAuthentication SshCredentialSshAuthentication
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usageScopes SshCredentialUsageScope[]
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberos_authentication SshCredentialKerberosAuthenticationArgs
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name str
    Name of the encrypted text secret
    ssh_authentication SshCredentialSshAuthenticationArgs
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usage_scopes Sequence[SshCredentialUsageScopeArgs]
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberosAuthentication Property Map
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name String
    Name of the encrypted text secret
    sshAuthentication Property Map
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usageScopes List<Property Map>
    This block is used for scoping the resource to a specific set of applications or environments.

    Outputs

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

    Get an existing SshCredential 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?: SshCredentialState, opts?: CustomResourceOptions): SshCredential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        kerberos_authentication: Optional[SshCredentialKerberosAuthenticationArgs] = None,
        name: Optional[str] = None,
        ssh_authentication: Optional[SshCredentialSshAuthenticationArgs] = None,
        usage_scopes: Optional[Sequence[SshCredentialUsageScopeArgs]] = None) -> SshCredential
    func GetSshCredential(ctx *Context, name string, id IDInput, state *SshCredentialState, opts ...ResourceOption) (*SshCredential, error)
    public static SshCredential Get(string name, Input<string> id, SshCredentialState? state, CustomResourceOptions? opts = null)
    public static SshCredential get(String name, Output<String> id, SshCredentialState state, CustomResourceOptions options)
    resources:  _:    type: harness:SshCredential    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:
    KerberosAuthentication SshCredentialKerberosAuthentication
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    Name string
    Name of the encrypted text secret
    SshAuthentication SshCredentialSshAuthentication
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    UsageScopes List<SshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    KerberosAuthentication SshCredentialKerberosAuthenticationArgs
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    Name string
    Name of the encrypted text secret
    SshAuthentication SshCredentialSshAuthenticationArgs
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    UsageScopes []SshCredentialUsageScopeArgs
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberosAuthentication SshCredentialKerberosAuthentication
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name String
    Name of the encrypted text secret
    sshAuthentication SshCredentialSshAuthentication
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usageScopes List<SshCredentialUsageScope>
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberosAuthentication SshCredentialKerberosAuthentication
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name string
    Name of the encrypted text secret
    sshAuthentication SshCredentialSshAuthentication
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usageScopes SshCredentialUsageScope[]
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberos_authentication SshCredentialKerberosAuthenticationArgs
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name str
    Name of the encrypted text secret
    ssh_authentication SshCredentialSshAuthenticationArgs
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usage_scopes Sequence[SshCredentialUsageScopeArgs]
    This block is used for scoping the resource to a specific set of applications or environments.
    kerberosAuthentication Property Map
    Kerberos authentication for SSH. Cannot be used if ssh*authentication is specified
    name String
    Name of the encrypted text secret
    sshAuthentication Property Map
    Authentication method for SSH. Cannot be used if kerberos*authentication is specified. Only one of inline_ssh, server_password, or ssh_key_file should be set
    usageScopes List<Property Map>
    This block is used for scoping the resource to a specific set of applications or environments.

    Supporting Types

    SshCredentialKerberosAuthentication, SshCredentialKerberosAuthenticationArgs

    Port int
    Port to use for Kerberos authentication
    Principal string
    Name of the principal for authentication
    Realm string
    Realm associated with the Kerberos authentication
    TgtGenerationMethod SshCredentialKerberosAuthenticationTgtGenerationMethod
    TGT generation method
    Port int
    Port to use for Kerberos authentication
    Principal string
    Name of the principal for authentication
    Realm string
    Realm associated with the Kerberos authentication
    TgtGenerationMethod SshCredentialKerberosAuthenticationTgtGenerationMethod
    TGT generation method
    port Integer
    Port to use for Kerberos authentication
    principal String
    Name of the principal for authentication
    realm String
    Realm associated with the Kerberos authentication
    tgtGenerationMethod SshCredentialKerberosAuthenticationTgtGenerationMethod
    TGT generation method
    port number
    Port to use for Kerberos authentication
    principal string
    Name of the principal for authentication
    realm string
    Realm associated with the Kerberos authentication
    tgtGenerationMethod SshCredentialKerberosAuthenticationTgtGenerationMethod
    TGT generation method
    port int
    Port to use for Kerberos authentication
    principal str
    Name of the principal for authentication
    realm str
    Realm associated with the Kerberos authentication
    tgt_generation_method SshCredentialKerberosAuthenticationTgtGenerationMethod
    TGT generation method
    port Number
    Port to use for Kerberos authentication
    principal String
    Name of the principal for authentication
    realm String
    Realm associated with the Kerberos authentication
    tgtGenerationMethod Property Map
    TGT generation method

    SshCredentialKerberosAuthenticationTgtGenerationMethod, SshCredentialKerberosAuthenticationTgtGenerationMethodArgs

    KerberosPasswordId string
    The id of the encrypted text secret
    KeyTabFilePath string
    The path to the key tab file
    KerberosPasswordId string
    The id of the encrypted text secret
    KeyTabFilePath string
    The path to the key tab file
    kerberosPasswordId String
    The id of the encrypted text secret
    keyTabFilePath String
    The path to the key tab file
    kerberosPasswordId string
    The id of the encrypted text secret
    keyTabFilePath string
    The path to the key tab file
    kerberos_password_id str
    The id of the encrypted text secret
    key_tab_file_path str
    The path to the key tab file
    kerberosPasswordId String
    The id of the encrypted text secret
    keyTabFilePath String
    The path to the key tab file

    SshCredentialSshAuthentication, SshCredentialSshAuthenticationArgs

    Port int
    The port to connect to
    Username string
    The username to use when connecting to ssh
    InlineSsh SshCredentialSshAuthenticationInlineSsh
    Inline SSH authentication configuration. Only ond of passphrase_secret_id or ssh_key_file_id should be used
    ServerPassword SshCredentialSshAuthenticationServerPassword
    Server password authentication configuration
    SshKeyFile SshCredentialSshAuthenticationSshKeyFile
    Use ssh key file for authentication
    Port int
    The port to connect to
    Username string
    The username to use when connecting to ssh
    InlineSsh SshCredentialSshAuthenticationInlineSsh
    Inline SSH authentication configuration. Only ond of passphrase_secret_id or ssh_key_file_id should be used
    ServerPassword SshCredentialSshAuthenticationServerPassword
    Server password authentication configuration
    SshKeyFile SshCredentialSshAuthenticationSshKeyFile
    Use ssh key file for authentication
    port Integer
    The port to connect to
    username String
    The username to use when connecting to ssh
    inlineSsh SshCredentialSshAuthenticationInlineSsh
    Inline SSH authentication configuration. Only ond of passphrase_secret_id or ssh_key_file_id should be used
    serverPassword SshCredentialSshAuthenticationServerPassword
    Server password authentication configuration
    sshKeyFile SshCredentialSshAuthenticationSshKeyFile
    Use ssh key file for authentication
    port number
    The port to connect to
    username string
    The username to use when connecting to ssh
    inlineSsh SshCredentialSshAuthenticationInlineSsh
    Inline SSH authentication configuration. Only ond of passphrase_secret_id or ssh_key_file_id should be used
    serverPassword SshCredentialSshAuthenticationServerPassword
    Server password authentication configuration
    sshKeyFile SshCredentialSshAuthenticationSshKeyFile
    Use ssh key file for authentication
    port int
    The port to connect to
    username str
    The username to use when connecting to ssh
    inline_ssh SshCredentialSshAuthenticationInlineSsh
    Inline SSH authentication configuration. Only ond of passphrase_secret_id or ssh_key_file_id should be used
    server_password SshCredentialSshAuthenticationServerPassword
    Server password authentication configuration
    ssh_key_file SshCredentialSshAuthenticationSshKeyFile
    Use ssh key file for authentication
    port Number
    The port to connect to
    username String
    The username to use when connecting to ssh
    inlineSsh Property Map
    Inline SSH authentication configuration. Only ond of passphrase_secret_id or ssh_key_file_id should be used
    serverPassword Property Map
    Server password authentication configuration
    sshKeyFile Property Map
    Use ssh key file for authentication

    SshCredentialSshAuthenticationInlineSsh, SshCredentialSshAuthenticationInlineSshArgs

    SshKeyFileId string
    The id of the secret containing the SSH key
    PassphraseSecretId string
    The id of the encrypted secret to use
    SshKeyFileId string
    The id of the secret containing the SSH key
    PassphraseSecretId string
    The id of the encrypted secret to use
    sshKeyFileId String
    The id of the secret containing the SSH key
    passphraseSecretId String
    The id of the encrypted secret to use
    sshKeyFileId string
    The id of the secret containing the SSH key
    passphraseSecretId string
    The id of the encrypted secret to use
    ssh_key_file_id str
    The id of the secret containing the SSH key
    passphrase_secret_id str
    The id of the encrypted secret to use
    sshKeyFileId String
    The id of the secret containing the SSH key
    passphraseSecretId String
    The id of the encrypted secret to use

    SshCredentialSshAuthenticationServerPassword, SshCredentialSshAuthenticationServerPasswordArgs

    PasswordSecretId string
    The id of the encrypted secret
    PasswordSecretId string
    The id of the encrypted secret
    passwordSecretId String
    The id of the encrypted secret
    passwordSecretId string
    The id of the encrypted secret
    password_secret_id str
    The id of the encrypted secret
    passwordSecretId String
    The id of the encrypted secret

    SshCredentialSshAuthenticationSshKeyFile, SshCredentialSshAuthenticationSshKeyFileArgs

    Path string
    The path to the key file on the delegate
    PassphraseSecretId string
    The id of the secret containing the password to use for the ssh key
    Path string
    The path to the key file on the delegate
    PassphraseSecretId string
    The id of the secret containing the password to use for the ssh key
    path String
    The path to the key file on the delegate
    passphraseSecretId String
    The id of the secret containing the password to use for the ssh key
    path string
    The path to the key file on the delegate
    passphraseSecretId string
    The id of the secret containing the password to use for the ssh key
    path str
    The path to the key file on the delegate
    passphrase_secret_id str
    The id of the secret containing the password to use for the ssh key
    path String
    The path to the key file on the delegate
    passphraseSecretId String
    The id of the secret containing the password to use for the ssh key

    SshCredentialUsageScope, SshCredentialUsageScopeArgs

    ApplicationId string
    Id of the application to scope to. If empty then this scope applies to all applications.
    EnvironmentFilterType string
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    EnvironmentId string
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    ApplicationId string
    Id of the application to scope to. If empty then this scope applies to all applications.
    EnvironmentFilterType string
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    EnvironmentId string
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    applicationId String
    Id of the application to scope to. If empty then this scope applies to all applications.
    environmentFilterType String
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environmentId String
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    applicationId string
    Id of the application to scope to. If empty then this scope applies to all applications.
    environmentFilterType string
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environmentId string
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    application_id str
    Id of the application to scope to. If empty then this scope applies to all applications.
    environment_filter_type str
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environment_id str
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.
    applicationId String
    Id of the application to scope to. If empty then this scope applies to all applications.
    environmentFilterType String
    Type of environment filter applied. Cannot be used with environment_id. Valid options are NONPRODUCTIONENVIRONMENTS, PRODUCTION_ENVIRONMENTS.
    environmentId String
    Id of the id of the specific environment to scope to. Cannot be used with environment_filter_type.

    Import

    Import using the Harness ssh credential id

    $ pulumi import harness:index/sshCredential:SshCredential example <credential_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.6.0 published on Tuesday, Mar 25, 2025 by Pulumi
    pulumi/pulumi-harness