@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
127 lines (126 loc) • 4.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* 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 `createBeforeDestroy = true` lifecycle setting.
*
* ## Example Usage
*
* ```typescript
* 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.",
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import using the Harness application id and service id
*
* ```sh
* $ pulumi import harness:service/ssh:Ssh example <app_id>/<svc_id>
* ```
*/
export declare class Ssh extends pulumi.CustomResource {
/**
* Get an existing Ssh resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SshState, opts?: pulumi.CustomResourceOptions): Ssh;
/**
* Returns true if the given object is an instance of Ssh. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Ssh;
/**
* The id of the application the service belongs to
*/
readonly appId: pulumi.Output<string>;
/**
* The type of artifact to deploy.
*/
readonly artifactType: pulumi.Output<string>;
/**
* Description of th service
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Name of the service
*/
readonly name: pulumi.Output<string>;
/**
* Variables to be used in the service
*/
readonly variables: pulumi.Output<outputs.service.SshVariable[] | undefined>;
/**
* Create a Ssh resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SshArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Ssh resources.
*/
export interface SshState {
/**
* The id of the application the service belongs to
*/
appId?: pulumi.Input<string>;
/**
* The type of artifact to deploy.
*/
artifactType?: pulumi.Input<string>;
/**
* Description of th service
*/
description?: pulumi.Input<string>;
/**
* Name of the service
*/
name?: pulumi.Input<string>;
/**
* Variables to be used in the service
*/
variables?: pulumi.Input<pulumi.Input<inputs.service.SshVariable>[]>;
}
/**
* The set of arguments for constructing a Ssh resource.
*/
export interface SshArgs {
/**
* The id of the application the service belongs to
*/
appId: pulumi.Input<string>;
/**
* The type of artifact to deploy.
*/
artifactType: pulumi.Input<string>;
/**
* Description of th service
*/
description?: pulumi.Input<string>;
/**
* Name of the service
*/
name?: pulumi.Input<string>;
/**
* Variables to be used in the service
*/
variables?: pulumi.Input<pulumi.Input<inputs.service.SshVariable>[]>;
}