@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
163 lines (162 loc) • 4.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for creating an environment SDK key for Feature Flags.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const testserverapikey = new harness.platform.FeatureFlagApiKey("testserverapikey", {
* identifier: "testserver",
* name: "TestServer",
* description: "this is a server SDK key",
* orgId: "test",
* projectId: "testff",
* envId: "testenv",
* expiredAt: 1713729225,
* type: "Server",
* });
* export const serversdkkey = testserverapikey.apiKey;
* ```
*/
export declare class FeatureFlagApiKey extends pulumi.CustomResource {
/**
* Get an existing FeatureFlagApiKey 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?: FeatureFlagApiKeyState, opts?: pulumi.CustomResourceOptions): FeatureFlagApiKey;
/**
* Returns true if the given object is an instance of FeatureFlagApiKey. 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 FeatureFlagApiKey;
/**
* The value of the SDK API Key
*/
readonly apiKey: pulumi.Output<string>;
/**
* Description of the SDK API Key
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Environment Identifier
*/
readonly envId: pulumi.Output<string>;
/**
* Expiration datetime of the SDK API Key
*/
readonly expiredAt: pulumi.Output<number | undefined>;
/**
* Identifier of the SDK API Key
*/
readonly identifier: pulumi.Output<string>;
/**
* Name of the SDK API Key
*/
readonly name: pulumi.Output<string>;
/**
* Organization Identifier
*/
readonly orgId: pulumi.Output<string>;
/**
* Project Identifier
*/
readonly projectId: pulumi.Output<string>;
/**
* Type of SDK. Valid values are `Server` or `Client`.
*/
readonly type: pulumi.Output<string>;
/**
* Create a FeatureFlagApiKey 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: FeatureFlagApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FeatureFlagApiKey resources.
*/
export interface FeatureFlagApiKeyState {
/**
* The value of the SDK API Key
*/
apiKey?: pulumi.Input<string>;
/**
* Description of the SDK API Key
*/
description?: pulumi.Input<string>;
/**
* Environment Identifier
*/
envId?: pulumi.Input<string>;
/**
* Expiration datetime of the SDK API Key
*/
expiredAt?: pulumi.Input<number>;
/**
* Identifier of the SDK API Key
*/
identifier?: pulumi.Input<string>;
/**
* Name of the SDK API Key
*/
name?: pulumi.Input<string>;
/**
* Organization Identifier
*/
orgId?: pulumi.Input<string>;
/**
* Project Identifier
*/
projectId?: pulumi.Input<string>;
/**
* Type of SDK. Valid values are `Server` or `Client`.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FeatureFlagApiKey resource.
*/
export interface FeatureFlagApiKeyArgs {
/**
* Description of the SDK API Key
*/
description?: pulumi.Input<string>;
/**
* Environment Identifier
*/
envId: pulumi.Input<string>;
/**
* Expiration datetime of the SDK API Key
*/
expiredAt?: pulumi.Input<number>;
/**
* Identifier of the SDK API Key
*/
identifier: pulumi.Input<string>;
/**
* Name of the SDK API Key
*/
name?: pulumi.Input<string>;
/**
* Organization Identifier
*/
orgId: pulumi.Input<string>;
/**
* Project Identifier
*/
projectId: pulumi.Input<string>;
/**
* Type of SDK. Valid values are `Server` or `Client`.
*/
type: pulumi.Input<string>;
}