pulumi-stripe/entitlementsFeature.d.ts

A Pulumi package for creating and managing Stripe resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * With this resource, you can create Entitlements Feature for your products - [Stripe API entitlements feature documentation](https://docs.stripe.com/api/entitlements/feature)
 *
 * Entitlements Features can be assigned to products, and when those products are purchased,
 * Stripe will create an entitlement to the feature for the purchasing customer.
 *
 * > Removal of the Entitlements Feature isn't supported through the Stripe API.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as stripe from "pulumi-stripe";
 *
 * // Entitlements Feature
 * const feature = new stripe.EntitlementsFeature("feature", {lookupKey: "key"});
 * ```
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import stripe:index/entitlementsFeature:EntitlementsFeature feature <feature_id>
 * ```
 */
export declare class EntitlementsFeature extends pulumi.CustomResource {
    /**
     * Get an existing EntitlementsFeature 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?: EntitlementsFeatureState, opts?: pulumi.CustomResourceOptions): EntitlementsFeature;
    /**
     * Returns true if the given object is an instance of EntitlementsFeature.  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 EntitlementsFeature;
    /**
     * Inactive features cannot be attached to new products.
     */
    readonly active: pulumi.Output<boolean>;
    /**
     * Bool. Has the value `true` if the object exists in live mode or the value `false`
     * if the object exists in test mode.
     */
    readonly livemode: pulumi.Output<boolean>;
    /**
     * String. A unique key you provide as your own system identifier. This may be up to 80 characters.
     */
    readonly lookupKey: pulumi.Output<string>;
    /**
     * Map(String). Set of key-value pairs that you can attach to an object.
     * This can be useful for storing additional information about the object in a structured format.
     */
    readonly metadata: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * String. The feature’s name, for your own purpose, not meant to be displayable to the customer.
     */
    readonly name: pulumi.Output<string>;
    /**
     * String representing the object’s type. Objects of the same type share the same value.
     */
    readonly object: pulumi.Output<string>;
    /**
     * Create a EntitlementsFeature 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: EntitlementsFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering EntitlementsFeature resources.
 */
export interface EntitlementsFeatureState {
    /**
     * Inactive features cannot be attached to new products.
     */
    active?: pulumi.Input<boolean>;
    /**
     * Bool. Has the value `true` if the object exists in live mode or the value `false`
     * if the object exists in test mode.
     */
    livemode?: pulumi.Input<boolean>;
    /**
     * String. A unique key you provide as your own system identifier. This may be up to 80 characters.
     */
    lookupKey?: pulumi.Input<string>;
    /**
     * Map(String). Set of key-value pairs that you can attach to an object.
     * This can be useful for storing additional information about the object in a structured format.
     */
    metadata?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * String. The feature’s name, for your own purpose, not meant to be displayable to the customer.
     */
    name?: pulumi.Input<string>;
    /**
     * String representing the object’s type. Objects of the same type share the same value.
     */
    object?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a EntitlementsFeature resource.
 */
export interface EntitlementsFeatureArgs {
    /**
     * String. A unique key you provide as your own system identifier. This may be up to 80 characters.
     */
    lookupKey: pulumi.Input<string>;
    /**
     * Map(String). Set of key-value pairs that you can attach to an object.
     * This can be useful for storing additional information about the object in a structured format.
     */
    metadata?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * String. The feature’s name, for your own purpose, not meant to be displayable to the customer.
     */
    name?: pulumi.Input<string>;
}