Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. StrongDM
  3. API Docs
  4. WorkflowRole
StrongDM v1.26.0 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-sdm

sdm.WorkflowRole

Explore with Pulumi AI

StrongDM v1.26.0 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-sdm

WorkflowRole links a role to a workflow. The linked roles indicate which roles a user must be a part of to request access to a resource via the workflow.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sdm from "@pierskarsenbarg/sdm";

const workflowRoleExample = new sdm.WorkflowRole("workflowRoleExample", {
    roleId: "r-243561",
    workflowId: "aw-343865",
});
Copy
import pulumi
import pierskarsenbarg_pulumi_sdm as sdm

workflow_role_example = sdm.WorkflowRole("workflowRoleExample",
    role_id="r-243561",
    workflow_id="aw-343865")
Copy
package main

import (
	"github.com/pierskarsenbarg/pulumi-sdm/sdk/go/sdm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdm.NewWorkflowRole(ctx, "workflowRoleExample", &sdm.WorkflowRoleArgs{
			RoleId:     pulumi.String("r-243561"),
			WorkflowId: pulumi.String("aw-343865"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdm = PiersKarsenbarg.Sdm;

return await Deployment.RunAsync(() => 
{
    var workflowRoleExample = new Sdm.WorkflowRole("workflowRoleExample", new()
    {
        RoleId = "r-243561",
        WorkflowId = "aw-343865",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdm.WorkflowRole;
import com.pulumi.sdm.WorkflowRoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workflowRoleExample = new WorkflowRole("workflowRoleExample", WorkflowRoleArgs.builder()
            .roleId("r-243561")
            .workflowId("aw-343865")
            .build());

    }
}
Copy
resources:
  workflowRoleExample:
    type: sdm:WorkflowRole
    properties:
      roleId: r-243561
      workflowId: aw-343865
Copy

This resource can be imported using the import command.

Create WorkflowRole Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkflowRole(name: string, args: WorkflowRoleArgs, opts?: CustomResourceOptions);
@overload
def WorkflowRole(resource_name: str,
                 args: WorkflowRoleArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def WorkflowRole(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 role_id: Optional[str] = None,
                 workflow_id: Optional[str] = None)
func NewWorkflowRole(ctx *Context, name string, args WorkflowRoleArgs, opts ...ResourceOption) (*WorkflowRole, error)
public WorkflowRole(string name, WorkflowRoleArgs args, CustomResourceOptions? opts = null)
public WorkflowRole(String name, WorkflowRoleArgs args)
public WorkflowRole(String name, WorkflowRoleArgs args, CustomResourceOptions options)

type: sdm:WorkflowRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkflowRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkflowRoleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkflowRoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkflowRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkflowRoleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workflowRoleResource = new Sdm.WorkflowRole("workflowRoleResource", new()
{
    RoleId = "string",
    WorkflowId = "string",
});
Copy
example, err := sdm.NewWorkflowRole(ctx, "workflowRoleResource", &sdm.WorkflowRoleArgs{
	RoleId:     pulumi.String("string"),
	WorkflowId: pulumi.String("string"),
})
Copy
var workflowRoleResource = new WorkflowRole("workflowRoleResource", WorkflowRoleArgs.builder()
    .roleId("string")
    .workflowId("string")
    .build());
Copy
workflow_role_resource = sdm.WorkflowRole("workflowRoleResource",
    role_id="string",
    workflow_id="string")
Copy
const workflowRoleResource = new sdm.WorkflowRole("workflowRoleResource", {
    roleId: "string",
    workflowId: "string",
});
Copy
type: sdm:WorkflowRole
properties:
    roleId: string
    workflowId: string
Copy

WorkflowRole Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkflowRole resource accepts the following input properties:

RoleId
This property is required.
Changes to this property will trigger replacement.
string
The role id.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
string
The workflow id.
RoleId
This property is required.
Changes to this property will trigger replacement.
string
The role id.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
string
The workflow id.
roleId
This property is required.
Changes to this property will trigger replacement.
String
The role id.
workflowId
This property is required.
Changes to this property will trigger replacement.
String
The workflow id.
roleId
This property is required.
Changes to this property will trigger replacement.
string
The role id.
workflowId
This property is required.
Changes to this property will trigger replacement.
string
The workflow id.
role_id
This property is required.
Changes to this property will trigger replacement.
str
The role id.
workflow_id
This property is required.
Changes to this property will trigger replacement.
str
The workflow id.
roleId
This property is required.
Changes to this property will trigger replacement.
String
The role id.
workflowId
This property is required.
Changes to this property will trigger replacement.
String
The workflow id.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkflowRole resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing WorkflowRole Resource

Get an existing WorkflowRole resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WorkflowRoleState, opts?: CustomResourceOptions): WorkflowRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        role_id: Optional[str] = None,
        workflow_id: Optional[str] = None) -> WorkflowRole
func GetWorkflowRole(ctx *Context, name string, id IDInput, state *WorkflowRoleState, opts ...ResourceOption) (*WorkflowRole, error)
public static WorkflowRole Get(string name, Input<string> id, WorkflowRoleState? state, CustomResourceOptions? opts = null)
public static WorkflowRole get(String name, Output<String> id, WorkflowRoleState state, CustomResourceOptions options)
resources:  _:    type: sdm:WorkflowRole    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
RoleId Changes to this property will trigger replacement. string
The role id.
WorkflowId Changes to this property will trigger replacement. string
The workflow id.
RoleId Changes to this property will trigger replacement. string
The role id.
WorkflowId Changes to this property will trigger replacement. string
The workflow id.
roleId Changes to this property will trigger replacement. String
The role id.
workflowId Changes to this property will trigger replacement. String
The workflow id.
roleId Changes to this property will trigger replacement. string
The role id.
workflowId Changes to this property will trigger replacement. string
The workflow id.
role_id Changes to this property will trigger replacement. str
The role id.
workflow_id Changes to this property will trigger replacement. str
The workflow id.
roleId Changes to this property will trigger replacement. String
The role id.
workflowId Changes to this property will trigger replacement. String
The workflow id.

Import

A WorkflowRole can be imported using the id, e.g.,

$ pulumi import sdm:index/workflowRole:WorkflowRole example wr-12345678
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
sdm pierskarsenbarg/pulumi-sdm
License
Apache-2.0
Notes
This Pulumi package is based on the sdm Terraform Provider.
StrongDM v1.26.0 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-sdm