@formalco/pulumi/permission.d.ts

A Pulumi package for creating and managing Formal resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Creating a Permission in Formal.
 */
export declare class Permission extends pulumi.CustomResource {
    /**
     * Get an existing Permission 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?: PermissionState, opts?: pulumi.CustomResourceOptions): Permission;
    /**
     * Returns true if the given object is an instance of Permission.  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 Permission;
    /**
     * The code describing how the permission works. Create one in the Formal Console.
     */
    readonly code: pulumi.Output<string>;
    /**
     * Permission Description.
     */
    readonly description: pulumi.Output<string>;
    /**
     * Permission Name
     */
    readonly name: pulumi.Output<string>;
    /**
     * Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
     */
    readonly status: pulumi.Output<string>;
    /**
     * If set to true, this Permission cannot be deleted.
     */
    readonly terminationProtection: pulumi.Output<boolean | undefined>;
    /**
     * Create a Permission 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: PermissionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Permission resources.
 */
export interface PermissionState {
    /**
     * The code describing how the permission works. Create one in the Formal Console.
     */
    code?: pulumi.Input<string>;
    /**
     * Permission Description.
     */
    description?: pulumi.Input<string>;
    /**
     * Permission Name
     */
    name?: pulumi.Input<string>;
    /**
     * Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
     */
    status?: pulumi.Input<string>;
    /**
     * If set to true, this Permission cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a Permission resource.
 */
export interface PermissionArgs {
    /**
     * The code describing how the permission works. Create one in the Formal Console.
     */
    code: pulumi.Input<string>;
    /**
     * Permission Description.
     */
    description: pulumi.Input<string>;
    /**
     * Permission Name
     */
    name?: pulumi.Input<string>;
    /**
     * Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
     */
    status: pulumi.Input<string>;
    /**
     * If set to true, this Permission cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
}