@pulumi/harness/platform/featureFlag.d.ts

A Pulumi package for creating and managing Harness resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Resource for managing Feature Flags.
 */
export declare class FeatureFlag extends pulumi.CustomResource {
    /**
     * Get an existing FeatureFlag 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?: FeatureFlagState, opts?: pulumi.CustomResourceOptions): FeatureFlag;
    /**
     * Returns true if the given object is an instance of FeatureFlag.  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 FeatureFlag;
    /**
     * Whether or not the flag is archived.
     */
    readonly archived: pulumi.Output<boolean | undefined>;
    /**
     * Which of the variations to use when the flag is toggled to off state
     */
    readonly defaultOffVariation: pulumi.Output<string>;
    /**
     * Which of the variations to use when the flag is toggled to on state
     */
    readonly defaultOnVariation: pulumi.Output<string>;
    /**
     * Description of the Feature Flag
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Environment Identifier
     */
    readonly environments: pulumi.Output<outputs.platform.FeatureFlagEnvironment[] | undefined>;
    /**
     * Identifier of the Feature Flag
     */
    readonly identifier: pulumi.Output<string>;
    /**
     * The type of data the flag represents. Valid values are `boolean`, `int`, `string`, `json`
     */
    readonly kind: pulumi.Output<string>;
    /**
     * Name of the Feature Flag
     */
    readonly name: pulumi.Output<string>;
    /**
     * Organization Identifier
     */
    readonly orgId: pulumi.Output<string>;
    /**
     * The owner of the flag
     */
    readonly owner: pulumi.Output<string | undefined>;
    /**
     * Whether or not the flag is permanent. If it is, it will never be flagged as stale
     */
    readonly permanent: pulumi.Output<boolean>;
    /**
     * Project Identifier
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * The tags for the flag
     */
    readonly tags: pulumi.Output<outputs.platform.FeatureFlagTag[] | undefined>;
    /**
     * The options available for your flag
     */
    readonly variations: pulumi.Output<outputs.platform.FeatureFlagVariation[]>;
    /**
     * Create a FeatureFlag 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: FeatureFlagArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FeatureFlag resources.
 */
export interface FeatureFlagState {
    /**
     * Whether or not the flag is archived.
     */
    archived?: pulumi.Input<boolean>;
    /**
     * Which of the variations to use when the flag is toggled to off state
     */
    defaultOffVariation?: pulumi.Input<string>;
    /**
     * Which of the variations to use when the flag is toggled to on state
     */
    defaultOnVariation?: pulumi.Input<string>;
    /**
     * Description of the Feature Flag
     */
    description?: pulumi.Input<string>;
    /**
     * Environment Identifier
     */
    environments?: pulumi.Input<pulumi.Input<inputs.platform.FeatureFlagEnvironment>[]>;
    /**
     * Identifier of the Feature Flag
     */
    identifier?: pulumi.Input<string>;
    /**
     * The type of data the flag represents. Valid values are `boolean`, `int`, `string`, `json`
     */
    kind?: pulumi.Input<string>;
    /**
     * Name of the Feature Flag
     */
    name?: pulumi.Input<string>;
    /**
     * Organization Identifier
     */
    orgId?: pulumi.Input<string>;
    /**
     * The owner of the flag
     */
    owner?: pulumi.Input<string>;
    /**
     * Whether or not the flag is permanent. If it is, it will never be flagged as stale
     */
    permanent?: pulumi.Input<boolean>;
    /**
     * Project Identifier
     */
    projectId?: pulumi.Input<string>;
    /**
     * The tags for the flag
     */
    tags?: pulumi.Input<pulumi.Input<inputs.platform.FeatureFlagTag>[]>;
    /**
     * The options available for your flag
     */
    variations?: pulumi.Input<pulumi.Input<inputs.platform.FeatureFlagVariation>[]>;
}
/**
 * The set of arguments for constructing a FeatureFlag resource.
 */
export interface FeatureFlagArgs {
    /**
     * Whether or not the flag is archived.
     */
    archived?: pulumi.Input<boolean>;
    /**
     * Which of the variations to use when the flag is toggled to off state
     */
    defaultOffVariation: pulumi.Input<string>;
    /**
     * Which of the variations to use when the flag is toggled to on state
     */
    defaultOnVariation: pulumi.Input<string>;
    /**
     * Description of the Feature Flag
     */
    description?: pulumi.Input<string>;
    /**
     * Environment Identifier
     */
    environments?: pulumi.Input<pulumi.Input<inputs.platform.FeatureFlagEnvironment>[]>;
    /**
     * Identifier of the Feature Flag
     */
    identifier: pulumi.Input<string>;
    /**
     * The type of data the flag represents. Valid values are `boolean`, `int`, `string`, `json`
     */
    kind: pulumi.Input<string>;
    /**
     * Name of the Feature Flag
     */
    name?: pulumi.Input<string>;
    /**
     * Organization Identifier
     */
    orgId: pulumi.Input<string>;
    /**
     * The owner of the flag
     */
    owner?: pulumi.Input<string>;
    /**
     * Whether or not the flag is permanent. If it is, it will never be flagged as stale
     */
    permanent: pulumi.Input<boolean>;
    /**
     * Project Identifier
     */
    projectId: pulumi.Input<string>;
    /**
     * The tags for the flag
     */
    tags?: pulumi.Input<pulumi.Input<inputs.platform.FeatureFlagTag>[]>;
    /**
     * The options available for your flag
     */
    variations: pulumi.Input<pulumi.Input<inputs.platform.FeatureFlagVariation>[]>;
}