1. Packages
  2. Harness
  3. API Docs
  4. service
  5. Ssh
Harness v0.0.5 published on Monday, Oct 31, 2022 by lbrlabs

harness.service.Ssh

Explore with Pulumi AI

harness logo
Harness v0.0.5 published on Monday, Oct 31, 2022 by lbrlabs

    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

    using System.Collections.Generic;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleApplication = new Harness.Application("exampleApplication");
    
        var exampleSsh = new Harness.Service.Ssh("exampleSsh", new()
        {
            AppId = exampleApplication.Id,
            ArtifactType = "TAR",
            Description = "Service for deploying applications with SSH.",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness"
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/service"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleApplication, err := harness.NewApplication(ctx, "exampleApplication", nil)
    		if err != nil {
    			return err
    		}
    		_, err = service.NewSsh(ctx, "exampleSsh", &service.SshArgs{
    			AppId:        exampleApplication.ID(),
    			ArtifactType: pulumi.String("TAR"),
    			Description:  pulumi.String("Service for deploying applications with SSH."),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.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 exampleApplication = new Application("exampleApplication");
    
            var exampleSsh = new Ssh("exampleSsh", SshArgs.builder()        
                .appId(exampleApplication.id())
                .artifactType("TAR")
                .description("Service for deploying applications with SSH.")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    example_application = harness.Application("exampleApplication")
    example_ssh = harness.service.Ssh("exampleSsh",
        app_id=example_application.id,
        artifact_type="TAR",
        description="Service for deploying applications with SSH.")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@lbrlabs/pulumi-harness";
    
    const exampleApplication = new harness.Application("exampleApplication", {});
    const exampleSsh = new harness.service.Ssh("exampleSsh", {
        appId: exampleApplication.id,
        artifactType: "TAR",
        description: "Service for deploying applications with SSH.",
    });
    
    resources:
      exampleApplication:
        type: harness:Application
      exampleSsh:
        type: harness:service:Ssh
        properties:
          appId: ${exampleApplication.id}
          artifactType: TAR
          description: Service for deploying applications with SSH.
    

    Create Ssh Resource

    new Ssh(name: string, args: SshArgs, opts?: CustomResourceOptions);
    @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)
    @overload
    def Ssh(resource_name: str,
            args: SshArgs,
            opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args SshArgs
    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 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 string
    The unique name of the resource.
    args SshArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SshArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The Ssh resource accepts the following input properties:

    AppId string

    The id of the application the service belongs to

    ArtifactType string

    The type of artifact to deploy.

    Description string

    Description of th service

    Name string

    Name of the service

    Variables List<Lbrlabs.PulumiPackage.Harness.Service.Inputs.SshVariableArgs>

    Variables to be used in the service

    AppId string

    The id of the application the service belongs to

    ArtifactType 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 String

    The id of the application the service belongs to

    artifactType String

    The type of artifact to deploy.

    description String

    Description of th service

    name String

    Name of the service

    variables List<SshVariableArgs>

    Variables to be used in the service

    appId string

    The id of the application the service belongs to

    artifactType 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

    app_id str

    The id of the application the service belongs to

    artifact_type 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 String

    The id of the application the service belongs to

    artifactType 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)
    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:
    AppId string

    The id of the application the service belongs to

    ArtifactType string

    The type of artifact to deploy.

    Description string

    Description of th service

    Name string

    Name of the service

    Variables List<Lbrlabs.PulumiPackage.Harness.Service.Inputs.SshVariableArgs>

    Variables to be used in the service

    AppId string

    The id of the application the service belongs to

    ArtifactType 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 String

    The id of the application the service belongs to

    artifactType String

    The type of artifact to deploy.

    description String

    Description of th service

    name String

    Name of the service

    variables List<SshVariableArgs>

    Variables to be used in the service

    appId string

    The id of the application the service belongs to

    artifactType 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

    app_id str

    The id of the application the service belongs to

    artifact_type 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 String

    The id of the application the service belongs to

    artifactType 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

    Name string

    Name of the variable

    Type string

    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'

    Value string

    Value of the variable

    Name string

    Name of the variable

    Type string

    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'

    Value string

    Value of the variable

    name String

    Name of the variable

    type String

    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'

    value String

    Value of the variable

    name string

    Name of the variable

    type string

    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'

    value string

    Value of the variable

    name str

    Name of the variable

    type str

    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'

    value str

    Value of the variable

    name String

    Name of the variable

    type String

    Type of the variable. Options are 'TEXT' and 'ENCRYPTED_TEXT'

    value 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>
    

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the harness Terraform Provider.

    harness logo
    Harness v0.0.5 published on Monday, Oct 31, 2022 by lbrlabs