pulumi-stripe/productFeature.d.ts

A Pulumi package for creating and managing Stripe resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * With this resource, you can create Product Feature - [Stripe API product feature documentation](https://docs.stripe.com/api/product-feature)
 *
 * A Product Feature represents an attachment between a feature and a product.
 * When a product is purchased that has a feature attached,
 * Stripe will create an entitlement to the feature for the purchasing customer.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as stripe from "pulumi-stripe";
 *
 * // Product Feature attaches an Entitlement Feature to a Product
 * const productFeature = new stripe.ProductFeature("productFeature", {
 *     entitlementsFeature: stripe_entitlements_feature.feature.id,
 *     product: stripe_product.product.id,
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import stripe:index/productFeature:ProductFeature product_feature <product_feature_id>
 * ```
 */
export declare class ProductFeature extends pulumi.CustomResource {
    /**
     * Get an existing ProductFeature 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?: ProductFeatureState, opts?: pulumi.CustomResourceOptions): ProductFeature;
    /**
     * Returns true if the given object is an instance of ProductFeature.  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 ProductFeature;
    /**
     * String. The ID of the Entitlements Feature the product will be attached to
     */
    readonly entitlementsFeature: pulumi.Output<string>;
    /**
     * 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 representing the object’s type. Objects of the same type share the same value.
     */
    readonly object: pulumi.Output<string>;
    /**
     * String. The ID of the product that this Entitlements Feature will be attached to.
     */
    readonly product: pulumi.Output<string>;
    /**
     * Create a ProductFeature 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: ProductFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ProductFeature resources.
 */
export interface ProductFeatureState {
    /**
     * String. The ID of the Entitlements Feature the product will be attached to
     */
    entitlementsFeature?: pulumi.Input<string>;
    /**
     * 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 representing the object’s type. Objects of the same type share the same value.
     */
    object?: pulumi.Input<string>;
    /**
     * String. The ID of the product that this Entitlements Feature will be attached to.
     */
    product?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ProductFeature resource.
 */
export interface ProductFeatureArgs {
    /**
     * String. The ID of the Entitlements Feature the product will be attached to
     */
    entitlementsFeature: pulumi.Input<string>;
    /**
     * String. The ID of the product that this Entitlements Feature will be attached to.
     */
    product: pulumi.Input<string>;
}