@lbrlabs/pulumi-harness/platformApiKey.d.ts

A Pulumi package for creating and managing Harness resources.

import * as pulumi from "@pulumi/pulumi";
export declare class PlatformApiKey extends pulumi.CustomResource {
    /**
     * Get an existing PlatformApiKey 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?: PlatformApiKeyState, opts?: pulumi.CustomResourceOptions): PlatformApiKey;
    /**
     * Returns true if the given object is an instance of PlatformApiKey.  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 PlatformApiKey;
    /**
     * Account Identifier for the Entity
     */
    readonly accountId: pulumi.Output<string>;
    /**
     * Type of the API Key
     */
    readonly apikeyType: pulumi.Output<string>;
    /**
     * Default expiration time of the Token within API Key
     */
    readonly defaultTimeToExpireToken: pulumi.Output<number | undefined>;
    /**
     * Description of the API Key
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Identifier of the API Key
     */
    readonly identifier: pulumi.Output<string>;
    /**
     * Name of the API Key
     */
    readonly name: pulumi.Output<string>;
    /**
     * Organization Identifier for the Entity
     */
    readonly orgId: pulumi.Output<string | undefined>;
    /**
     * Parent Entity Identifier of the API Key
     */
    readonly parentId: pulumi.Output<string>;
    /**
     * Project Identifier for the Entity
     */
    readonly projectId: pulumi.Output<string | undefined>;
    /**
     * Tags for the API Key
     */
    readonly tags: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Create a PlatformApiKey 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: PlatformApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering PlatformApiKey resources.
 */
export interface PlatformApiKeyState {
    /**
     * Account Identifier for the Entity
     */
    accountId?: pulumi.Input<string>;
    /**
     * Type of the API Key
     */
    apikeyType?: pulumi.Input<string>;
    /**
     * Default expiration time of the Token within API Key
     */
    defaultTimeToExpireToken?: pulumi.Input<number>;
    /**
     * Description of the API Key
     */
    description?: pulumi.Input<string>;
    /**
     * Identifier of the API Key
     */
    identifier?: pulumi.Input<string>;
    /**
     * Name of the API Key
     */
    name?: pulumi.Input<string>;
    /**
     * Organization Identifier for the Entity
     */
    orgId?: pulumi.Input<string>;
    /**
     * Parent Entity Identifier of the API Key
     */
    parentId?: pulumi.Input<string>;
    /**
     * Project Identifier for the Entity
     */
    projectId?: pulumi.Input<string>;
    /**
     * Tags for the API Key
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}
/**
 * The set of arguments for constructing a PlatformApiKey resource.
 */
export interface PlatformApiKeyArgs {
    /**
     * Account Identifier for the Entity
     */
    accountId: pulumi.Input<string>;
    /**
     * Type of the API Key
     */
    apikeyType: pulumi.Input<string>;
    /**
     * Default expiration time of the Token within API Key
     */
    defaultTimeToExpireToken?: pulumi.Input<number>;
    /**
     * Description of the API Key
     */
    description?: pulumi.Input<string>;
    /**
     * Identifier of the API Key
     */
    identifier: pulumi.Input<string>;
    /**
     * Name of the API Key
     */
    name?: pulumi.Input<string>;
    /**
     * Organization Identifier for the Entity
     */
    orgId?: pulumi.Input<string>;
    /**
     * Parent Entity Identifier of the API Key
     */
    parentId: pulumi.Input<string>;
    /**
     * Project Identifier for the Entity
     */
    projectId?: pulumi.Input<string>;
    /**
     * Tags for the API Key
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}