@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
224 lines (223 loc) • 6.76 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating secret of type secret text
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const inline = new harness.platform.SecretText("inline", {
* identifier: "identifier",
* name: "name",
* description: "example",
* tags: ["foo:bar"],
* secretManagerIdentifier: "harnessSecretManager",
* valueType: "Inline",
* value: "secret",
* });
* const reference = new harness.platform.SecretText("reference", {
* identifier: "identifier",
* name: "name",
* description: "example",
* tags: ["foo:bar"],
* secretManagerIdentifier: "azureSecretManager",
* valueType: "Reference",
* value: "secret",
* });
* const gcpSecretManagerReference = new harness.platform.SecretText("gcp_secret_manager_reference", {
* identifier: "identifier",
* name: "name",
* description: "example",
* tags: ["foo:bar"],
* secretManagerIdentifier: "gcpSecretManager",
* valueType: "Reference",
* value: "secret",
* additionalMetadatas: [{
* values: [{
* version: "1",
* }],
* }],
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import account level secret text
*
* ```sh
* $ pulumi import harness:platform/secretText:SecretText example <secret_text_id>
* ```
*
* Import org level secret text
*
* ```sh
* $ pulumi import harness:platform/secretText:SecretText example <ord_id>/<secret_text_id>
* ```
*
* Import project level secret text
*
* ```sh
* $ pulumi import harness:platform/secretText:SecretText example <org_id>/<project_id>/<secret_text_id>
* ```
*/
export declare class SecretText extends pulumi.CustomResource {
/**
* Get an existing SecretText 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?: SecretTextState, opts?: pulumi.CustomResourceOptions): SecretText;
/**
* Returns true if the given object is an instance of SecretText. 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 SecretText;
/**
* Additional Metadata for the Secret
*/
readonly additionalMetadatas: pulumi.Output<outputs.platform.SecretTextAdditionalMetadata[] | undefined>;
/**
* Description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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>;
/**
* Value of the Secret
*/
readonly value: pulumi.Output<string | undefined>;
/**
* This has details to specify if the secret value is Inline or Reference.
*/
readonly valueType: pulumi.Output<string>;
/**
* Create a SecretText 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: SecretTextArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecretText resources.
*/
export interface SecretTextState {
/**
* Additional Metadata for the Secret
*/
additionalMetadatas?: pulumi.Input<pulumi.Input<inputs.platform.SecretTextAdditionalMetadata>[]>;
/**
* Description of the resource.
*/
description?: 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>[]>;
/**
* Value of the Secret
*/
value?: pulumi.Input<string>;
/**
* This has details to specify if the secret value is Inline or Reference.
*/
valueType?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SecretText resource.
*/
export interface SecretTextArgs {
/**
* Additional Metadata for the Secret
*/
additionalMetadatas?: pulumi.Input<pulumi.Input<inputs.platform.SecretTextAdditionalMetadata>[]>;
/**
* Description of the resource.
*/
description?: 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>[]>;
/**
* Value of the Secret
*/
value?: pulumi.Input<string>;
/**
* This has details to specify if the secret value is Inline or Reference.
*/
valueType: pulumi.Input<string>;
}