@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
174 lines (173 loc) • 5.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for creating a secret of type secret file in Harness.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const example = new harness.platform.SecretFile("example", {
* identifier: "identifier",
* name: "name",
* description: "test",
* tags: ["foo:bar"],
* filePath: "file_path",
* secretManagerIdentifier: "harnessSecretManager",
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import account level secret file
*
* ```sh
* $ pulumi import harness:platform/secretFile:SecretFile example <secret_file_id>
* ```
*
* Import org level secret file
*
* ```sh
* $ pulumi import harness:platform/secretFile:SecretFile example <ord_id>/<secret_file_id>
* ```
*
* Import project level secret file
*
* ```sh
* $ pulumi import harness:platform/secretFile:SecretFile example <org_id>/<project_id>/<secret_file_id>
* ```
*/
export declare class SecretFile extends pulumi.CustomResource {
/**
* Get an existing SecretFile 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?: SecretFileState, opts?: pulumi.CustomResourceOptions): SecretFile;
/**
* Returns true if the given object is an instance of SecretFile. 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 SecretFile;
/**
* Description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Path of the file containing secret value
*/
readonly filePath: pulumi.Output<string>;
/**
* Unique identifier of the resource.
*/
readonly identifier: pulumi.Output<string>;
/**
* Name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* Unique identifier of the organization.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Unique identifier of the project.
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* Identifier of the Secret Manager used to manage the secret.
*/
readonly secretManagerIdentifier: pulumi.Output<string>;
/**
* Tags to associate with the resource.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a SecretFile 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: SecretFileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecretFile resources.
*/
export interface SecretFileState {
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Path of the file containing secret value
*/
filePath?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier?: pulumi.Input<string>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* Identifier of the Secret Manager used to manage the secret.
*/
secretManagerIdentifier?: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a SecretFile resource.
*/
export interface SecretFileArgs {
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Path of the file containing secret value
*/
filePath: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier: pulumi.Input<string>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* Identifier of the Secret Manager used to manage the secret.
*/
secretManagerIdentifier: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}