Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. service
  5. Ssh
Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness

harness.service.Ssh

Explore with Pulumi AI

Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness

Resource for creating an SSH service. This resource uses the config-as-code API’s. When updating the name or path of this resource you should typically also set the create_before_destroy = true lifecycle setting.

Example Usage

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

const example = new harness.Application("example", {name: "example"});
const exampleSsh = new harness.service.Ssh("example", {
    appId: example.id,
    artifactType: "TAR",
    name: "ssh-example",
    description: "Service for deploying applications with SSH.",
});
Copy
import pulumi
import pulumi_harness as harness

example = harness.Application("example", name="example")
example_ssh = harness.service.Ssh("example",
    app_id=example.id,
    artifact_type="TAR",
    name="ssh-example",
    description="Service for deploying applications with SSH.")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := harness.NewApplication(ctx, "example", &harness.ApplicationArgs{
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = service.NewSsh(ctx, "example", &service.SshArgs{
			AppId:        example.ID(),
			ArtifactType: pulumi.String("TAR"),
			Name:         pulumi.String("ssh-example"),
			Description:  pulumi.String("Service for deploying applications with SSH."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var example = new Harness.Application("example", new()
    {
        Name = "example",
    });

    var exampleSsh = new Harness.Service.Ssh("example", new()
    {
        AppId = example.Id,
        ArtifactType = "TAR",
        Name = "ssh-example",
        Description = "Service for deploying applications with SSH.",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.Application;
import com.pulumi.harness.ApplicationArgs;
import com.pulumi.harness.service.Ssh;
import com.pulumi.harness.service.SshArgs;
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 example = new Application("example", ApplicationArgs.builder()
            .name("example")
            .build());

        var exampleSsh = new Ssh("exampleSsh", SshArgs.builder()
            .appId(example.id())
            .artifactType("TAR")
            .name("ssh-example")
            .description("Service for deploying applications with SSH.")
            .build());

    }
}
Copy
resources:
  example:
    type: harness:Application
    properties:
      name: example
  exampleSsh:
    type: harness:service:Ssh
    name: example
    properties:
      appId: ${example.id}
      artifactType: TAR
      name: ssh-example
      description: Service for deploying applications with SSH.
Copy

Create Ssh Resource

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

Constructor syntax

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

@overload
def Ssh(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        artifact_type: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        variables: Optional[Sequence[SshVariableArgs]] = None)
func NewSsh(ctx *Context, name string, args SshArgs, opts ...ResourceOption) (*Ssh, error)
public Ssh(string name, SshArgs args, CustomResourceOptions? opts = null)
public Ssh(String name, SshArgs args)
public Ssh(String name, SshArgs args, CustomResourceOptions options)

type: harness:service:Ssh
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SshArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SshArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SshArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SshArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SshArgs
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 sshResource = new Harness.Service.Ssh("sshResource", new()
{
    AppId = "string",
    ArtifactType = "string",
    Description = "string",
    Name = "string",
    Variables = new[]
    {
        new Harness.Service.Inputs.SshVariableArgs
        {
            Name = "string",
            Type = "string",
            Value = "string",
        },
    },
});
Copy
example, err := service.NewSsh(ctx, "sshResource", &service.SshArgs{
	AppId:        pulumi.String("string"),
	ArtifactType: pulumi.String("string"),
	Description:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	Variables: service.SshVariableArray{
		&service.SshVariableArgs{
			Name:  pulumi.String("string"),
			Type:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})
Copy
var sshResource = new Ssh("sshResource", SshArgs.builder()
    .appId("string")
    .artifactType("string")
    .description("string")
    .name("string")
    .variables(SshVariableArgs.builder()
        .name("string")
        .type("string")
        .value("string")
        .build())
    .build());
Copy
ssh_resource = harness.service.Ssh("sshResource",
    app_id="string",
    artifact_type="string",
    description="string",
    name="string",
    variables=[{
        "name": "string",
        "type": "string",
        "value": "string",
    }])
Copy
const sshResource = new harness.service.Ssh("sshResource", {
    appId: "string",
    artifactType: "string",
    description: "string",
    name: "string",
    variables: [{
        name: "string",
        type: "string",
        value: "string",
    }],
});
Copy
type: harness:service:Ssh
properties:
    appId: string
    artifactType: string
    description: string
    name: string
    variables:
        - name: string
          type: string
          value: string
Copy

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

AppId
This property is required.
Changes to this property will trigger replacement.
string
The id of the application the service belongs to
ArtifactType
This property is required.
Changes to this property will trigger replacement.
string
The type of artifact to deploy.
Description string
Description of th service
Name string
Name of the service
Variables List<SshVariable>
Variables to be used in the service
AppId
This property is required.
Changes to this property will trigger replacement.
string
The id of the application the service belongs to
ArtifactType
This property is required.
Changes to this property will trigger replacement.
string
The type of artifact to deploy.
Description string
Description of th service
Name string
Name of the service
Variables []SshVariableArgs
Variables to be used in the service
appId
This property is required.
Changes to this property will trigger replacement.
String
The id of the application the service belongs to
artifactType
This property is required.
Changes to this property will trigger replacement.
String
The type of artifact to deploy.
description String
Description of th service
name String
Name of the service
variables List<SshVariable>
Variables to be used in the service
appId
This property is required.
Changes to this property will trigger replacement.
string
The id of the application the service belongs to
artifactType
This property is required.
Changes to this property will trigger replacement.
string
The type of artifact to deploy.
description string
Description of th service
name string
Name of the service
variables SshVariable[]
Variables to be used in the service
app_id
This property is required.
Changes to this property will trigger replacement.
str
The id of the application the service belongs to
artifact_type
This property is required.
Changes to this property will trigger replacement.
str
The type of artifact to deploy.
description str
Description of th service
name str
Name of the service
variables Sequence[SshVariableArgs]
Variables to be used in the service
appId
This property is required.
Changes to this property will trigger replacement.
String
The id of the application the service belongs to
artifactType
This property is required.
Changes to this property will trigger replacement.
String
The type of artifact to deploy.
description String
Description of th service
name String
Name of the service
variables List<Property Map>
Variables to be used in the service

Outputs

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

Get an existing Ssh 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?: SshState, opts?: CustomResourceOptions): Ssh
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        artifact_type: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        variables: Optional[Sequence[SshVariableArgs]] = None) -> Ssh
func GetSsh(ctx *Context, name string, id IDInput, state *SshState, opts ...ResourceOption) (*Ssh, error)
public static Ssh Get(string name, Input<string> id, SshState? state, CustomResourceOptions? opts = null)
public static Ssh get(String name, Output<String> id, SshState state, CustomResourceOptions options)
resources:  _:    type: harness:service:Ssh    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AppId Changes to this property will trigger replacement. string
The id of the application the service belongs to
ArtifactType Changes to this property will trigger replacement. string
The type of artifact to deploy.
Description string
Description of th service
Name string
Name of the service
Variables List<SshVariable>
Variables to be used in the service
AppId Changes to this property will trigger replacement. string
The id of the application the service belongs to
ArtifactType Changes to this property will trigger replacement. string
The type of artifact to deploy.
Description string
Description of th service
Name string
Name of the service
Variables []SshVariableArgs
Variables to be used in the service
appId Changes to this property will trigger replacement. String
The id of the application the service belongs to
artifactType Changes to this property will trigger replacement. String
The type of artifact to deploy.
description String
Description of th service
name String
Name of the service
variables List<SshVariable>
Variables to be used in the service
appId Changes to this property will trigger replacement. string
The id of the application the service belongs to
artifactType Changes to this property will trigger replacement. string
The type of artifact to deploy.
description string
Description of th service
name string
Name of the service
variables SshVariable[]
Variables to be used in the service
app_id Changes to this property will trigger replacement. str
The id of the application the service belongs to
artifact_type Changes to this property will trigger replacement. str
The type of artifact to deploy.
description str
Description of th service
name str
Name of the service
variables Sequence[SshVariableArgs]
Variables to be used in the service
appId Changes to this property will trigger replacement. String
The id of the application the service belongs to
artifactType Changes to this property will trigger replacement. String
The type of artifact to deploy.
description String
Description of th service
name String
Name of the service
variables List<Property Map>
Variables to be used in the service

Supporting Types

SshVariable
, SshVariableArgs

Name This property is required. string
Name of the variable
Type This property is required. string
Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
Value This property is required. string
Value of the variable
Name This property is required. string
Name of the variable
Type This property is required. string
Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
Value This property is required. string
Value of the variable
name This property is required. String
Name of the variable
type This property is required. String
Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
value This property is required. String
Value of the variable
name This property is required. string
Name of the variable
type This property is required. string
Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
value This property is required. string
Value of the variable
name This property is required. str
Name of the variable
type This property is required. str
Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
value This property is required. str
Value of the variable
name This property is required. String
Name of the variable
type This property is required. String
Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'
value This property is required. String
Value of the variable

Import

Import using the Harness application id and service id

$ pulumi import harness:service/ssh:Ssh example <app_id>/<svc_id>
Copy

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 v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness