@pierskarsenbarg/sdm
Version:
A Pulumi package for creating and managing StrongDM cloud resources.
163 lines (162 loc) • 7.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Workflows are the collection of rules that define the resources to which access can be requested,
* the users that can request that access, and the mechanism for approving those requests which can either
* but automatic approval or a set of users authorized to approve the requests.
* ## Import
*
* A Workflow can be imported using the id, e.g.,
*
* ```sh
* $ pulumi import sdm:index/workflow:Workflow example aw-12345678
* ```
*/
export declare class Workflow extends pulumi.CustomResource {
/**
* Get an existing Workflow 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?: WorkflowState, opts?: pulumi.CustomResourceOptions): Workflow;
/**
* Returns true if the given object is an instance of Workflow. 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 Workflow;
/**
* Fixed Duration of access requests bound to this workflow. If fixed duration is provided, max duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.
*/
readonly accessRequestFixedDuration: pulumi.Output<string | undefined>;
/**
* Maximum Duration of access requests bound to this workflow. If max duration is provided, fixed duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.
*/
readonly accessRequestMaxDuration: pulumi.Output<string | undefined>;
/**
* AccessRules is a list of access rules defining the resources this Workflow provides access to.
*/
readonly accessRules: pulumi.Output<string>;
/**
* Optional approval flow ID identifies an approval flow that linked to the workflow
*/
readonly approvalFlowId: pulumi.Output<string | undefined>;
/**
* Optional auto grant setting to automatically approve requests or not, defaults to false.
*
* @deprecated auto_grant is deprecated, see docs for more info
*/
readonly autoGrant: pulumi.Output<boolean | undefined>;
/**
* Optional description of the Workflow.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Optional enabled state for workflow. This setting may be overridden by the system if the workflow doesn't meet the requirements to be enabled or if other conditions prevent enabling the workflow. The requirements to enable a workflow are that the workflow must be either set up for with auto grant enabled or have one or more WorkflowApprovers created for the workflow.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Unique human-readable name of the Workflow.
*/
readonly name: pulumi.Output<string>;
/**
* Optional weight for workflow to specify it's priority in matching a request.
*/
readonly weight: pulumi.Output<number>;
/**
* Create a Workflow 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?: WorkflowArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Workflow resources.
*/
export interface WorkflowState {
/**
* Fixed Duration of access requests bound to this workflow. If fixed duration is provided, max duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.
*/
accessRequestFixedDuration?: pulumi.Input<string>;
/**
* Maximum Duration of access requests bound to this workflow. If max duration is provided, fixed duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.
*/
accessRequestMaxDuration?: pulumi.Input<string>;
/**
* AccessRules is a list of access rules defining the resources this Workflow provides access to.
*/
accessRules?: pulumi.Input<string>;
/**
* Optional approval flow ID identifies an approval flow that linked to the workflow
*/
approvalFlowId?: pulumi.Input<string>;
/**
* Optional auto grant setting to automatically approve requests or not, defaults to false.
*
* @deprecated auto_grant is deprecated, see docs for more info
*/
autoGrant?: pulumi.Input<boolean>;
/**
* Optional description of the Workflow.
*/
description?: pulumi.Input<string>;
/**
* Optional enabled state for workflow. This setting may be overridden by the system if the workflow doesn't meet the requirements to be enabled or if other conditions prevent enabling the workflow. The requirements to enable a workflow are that the workflow must be either set up for with auto grant enabled or have one or more WorkflowApprovers created for the workflow.
*/
enabled?: pulumi.Input<boolean>;
/**
* Unique human-readable name of the Workflow.
*/
name?: pulumi.Input<string>;
/**
* Optional weight for workflow to specify it's priority in matching a request.
*/
weight?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Workflow resource.
*/
export interface WorkflowArgs {
/**
* Fixed Duration of access requests bound to this workflow. If fixed duration is provided, max duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.
*/
accessRequestFixedDuration?: pulumi.Input<string>;
/**
* Maximum Duration of access requests bound to this workflow. If max duration is provided, fixed duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.
*/
accessRequestMaxDuration?: pulumi.Input<string>;
/**
* AccessRules is a list of access rules defining the resources this Workflow provides access to.
*/
accessRules?: pulumi.Input<string>;
/**
* Optional approval flow ID identifies an approval flow that linked to the workflow
*/
approvalFlowId?: pulumi.Input<string>;
/**
* Optional auto grant setting to automatically approve requests or not, defaults to false.
*
* @deprecated auto_grant is deprecated, see docs for more info
*/
autoGrant?: pulumi.Input<boolean>;
/**
* Optional description of the Workflow.
*/
description?: pulumi.Input<string>;
/**
* Optional enabled state for workflow. This setting may be overridden by the system if the workflow doesn't meet the requirements to be enabled or if other conditions prevent enabling the workflow. The requirements to enable a workflow are that the workflow must be either set up for with auto grant enabled or have one or more WorkflowApprovers created for the workflow.
*/
enabled?: pulumi.Input<boolean>;
/**
* Unique human-readable name of the Workflow.
*/
name?: pulumi.Input<string>;
/**
* Optional weight for workflow to specify it's priority in matching a request.
*/
weight?: pulumi.Input<number>;
}