@formalco/pulumi
Version:
A Pulumi package for creating and managing Formal resources.
140 lines (139 loc) • 4.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creating a Policy in Formal.
*/
export declare class Policy extends pulumi.CustomResource {
/**
* Get an existing Policy 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?: PolicyState, opts?: pulumi.CustomResourceOptions): Policy;
/**
* Returns true if the given object is an instance of Policy. 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 Policy;
/**
* When the policy was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Policy Description.
*/
readonly description: pulumi.Output<string>;
/**
* The module describing how the policy works. Create one in the Formal Console.
*/
readonly module: pulumi.Output<string>;
/**
* Policy Name
*/
readonly name: pulumi.Output<string>;
/**
* Notification settings for this policy.
*/
readonly notification: pulumi.Output<string>;
/**
* Owner of this policy: it can be either a group name or a user email.
*/
readonly owner: pulumi.Output<string>;
/**
* Defines the current status of the policy. It can be one of the following: 'draft', 'dry-run', or 'active'.
*/
readonly status: pulumi.Output<string>;
/**
* If set to true, this Policy cannot be deleted.
*/
readonly terminationProtection: pulumi.Output<boolean | undefined>;
/**
* Last update time.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a Policy 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: PolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Policy resources.
*/
export interface PolicyState {
/**
* When the policy was created.
*/
createdAt?: pulumi.Input<string>;
/**
* Policy Description.
*/
description?: pulumi.Input<string>;
/**
* The module describing how the policy works. Create one in the Formal Console.
*/
module?: pulumi.Input<string>;
/**
* Policy Name
*/
name?: pulumi.Input<string>;
/**
* Notification settings for this policy.
*/
notification?: pulumi.Input<string>;
/**
* Owner of this policy: it can be either a group name or a user email.
*/
owner?: pulumi.Input<string>;
/**
* Defines the current status of the policy. It can be one of the following: 'draft', 'dry-run', or 'active'.
*/
status?: pulumi.Input<string>;
/**
* If set to true, this Policy cannot be deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
/**
* Last update time.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Policy resource.
*/
export interface PolicyArgs {
/**
* Policy Description.
*/
description: pulumi.Input<string>;
/**
* The module describing how the policy works. Create one in the Formal Console.
*/
module: pulumi.Input<string>;
/**
* Policy Name
*/
name?: pulumi.Input<string>;
/**
* Notification settings for this policy.
*/
notification: pulumi.Input<string>;
/**
* Owner of this policy: it can be either a group name or a user email.
*/
owner: pulumi.Input<string>;
/**
* Defines the current status of the policy. It can be one of the following: 'draft', 'dry-run', or 'active'.
*/
status: pulumi.Input<string>;
/**
* If set to true, this Policy cannot be deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
}