Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prefect Provider
  3. API Docs
  4. WorkPoolAccess
prefect 2.24.1 published on Tuesday, Apr 15, 2025 by prefecthq
prefecthq/terraform-provider-prefect

prefect.WorkPoolAccess

Explore with Pulumi AI

prefect 2.24.1 published on Tuesday, Apr 15, 2025 by prefecthq
prefecthq/terraform-provider-prefect

The resource work_pool_access represents a connection between an accessor (User, Service Account or Team) with a Work Pool. This resource specifies an actor’s access level to a specific Work Pool in the Account. For more information, see object access control lists.

This feature is available in the following product plan(s): Prefect Cloud (Pro), Prefect Cloud (Enterprise).

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as prefect from "@pulumi/prefect";

const testWorkspace = prefect.getWorkspace({
    handle: "my-workspace",
});
const developer = prefect.getWorkspaceRole({
    name: "Developer",
});
const testServiceAccount = new prefect.ServiceAccount("testServiceAccount", {});
const testWorkspaceAccess = new prefect.WorkspaceAccess("testWorkspaceAccess", {
    accessorType: "SERVICE_ACCOUNT",
    accessorId: testServiceAccount.id,
    workspaceRoleId: developer.then(developer => developer.id),
    workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id),
});
// Example: invite a Team to the Workspace and grant it Developer access
const testTeam = prefect.getTeam({
    name: "my-team",
});
const testTeamWorkspaceAccess = new prefect.WorkspaceAccess("testTeamWorkspaceAccess", {
    accessorType: "TEAM",
    accessorId: testTeam.then(testTeam => testTeam.id),
    workspaceRoleId: developer.then(developer => developer.id),
    workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id),
});
// Define the Work Pool and grant access to the Work Pool
const testWorkPool = new prefect.WorkPool("testWorkPool", {workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id)});
const testWorkPoolAccess = new prefect.WorkPoolAccess("testWorkPoolAccess", {
    workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id),
    workPoolName: testWorkPool.name,
    manageActorIds: [testServiceAccount.actorId],
    runActorIds: [testServiceAccount.actorId],
    viewActorIds: [testServiceAccount.actorId],
    manageTeamIds: [testTeam.then(testTeam => testTeam.id)],
    runTeamIds: [testTeam.then(testTeam => testTeam.id)],
    viewTeamIds: [testTeam.then(testTeam => testTeam.id)],
});
Copy
import pulumi
import pulumi_prefect as prefect

test_workspace = prefect.get_workspace(handle="my-workspace")
developer = prefect.get_workspace_role(name="Developer")
test_service_account = prefect.ServiceAccount("testServiceAccount")
test_workspace_access = prefect.WorkspaceAccess("testWorkspaceAccess",
    accessor_type="SERVICE_ACCOUNT",
    accessor_id=test_service_account.id,
    workspace_role_id=developer.id,
    workspace_id=test_workspace.id)
# Example: invite a Team to the Workspace and grant it Developer access
test_team = prefect.get_team(name="my-team")
test_team_workspace_access = prefect.WorkspaceAccess("testTeamWorkspaceAccess",
    accessor_type="TEAM",
    accessor_id=test_team.id,
    workspace_role_id=developer.id,
    workspace_id=test_workspace.id)
# Define the Work Pool and grant access to the Work Pool
test_work_pool = prefect.WorkPool("testWorkPool", workspace_id=test_workspace.id)
test_work_pool_access = prefect.WorkPoolAccess("testWorkPoolAccess",
    workspace_id=test_workspace.id,
    work_pool_name=test_work_pool.name,
    manage_actor_ids=[test_service_account.actor_id],
    run_actor_ids=[test_service_account.actor_id],
    view_actor_ids=[test_service_account.actor_id],
    manage_team_ids=[test_team.id],
    run_team_ids=[test_team.id],
    view_team_ids=[test_team.id])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prefect/v2/prefect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testWorkspace, err := prefect.LookupWorkspace(ctx, &prefect.LookupWorkspaceArgs{
			Handle: pulumi.StringRef("my-workspace"),
		}, nil)
		if err != nil {
			return err
		}
		developer, err := prefect.LookupWorkspaceRole(ctx, &prefect.LookupWorkspaceRoleArgs{
			Name: "Developer",
		}, nil)
		if err != nil {
			return err
		}
		testServiceAccount, err := prefect.NewServiceAccount(ctx, "testServiceAccount", nil)
		if err != nil {
			return err
		}
		_, err = prefect.NewWorkspaceAccess(ctx, "testWorkspaceAccess", &prefect.WorkspaceAccessArgs{
			AccessorType:    pulumi.String("SERVICE_ACCOUNT"),
			AccessorId:      testServiceAccount.ID(),
			WorkspaceRoleId: pulumi.String(developer.Id),
			WorkspaceId:     pulumi.String(testWorkspace.Id),
		})
		if err != nil {
			return err
		}
		testTeam, err := prefect.LookupTeam(ctx, &prefect.LookupTeamArgs{
			Name: pulumi.StringRef("my-team"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = prefect.NewWorkspaceAccess(ctx, "testTeamWorkspaceAccess", &prefect.WorkspaceAccessArgs{
			AccessorType:    pulumi.String("TEAM"),
			AccessorId:      pulumi.String(testTeam.Id),
			WorkspaceRoleId: pulumi.String(developer.Id),
			WorkspaceId:     pulumi.String(testWorkspace.Id),
		})
		if err != nil {
			return err
		}
		testWorkPool, err := prefect.NewWorkPool(ctx, "testWorkPool", &prefect.WorkPoolArgs{
			WorkspaceId: pulumi.String(testWorkspace.Id),
		})
		if err != nil {
			return err
		}
		_, err = prefect.NewWorkPoolAccess(ctx, "testWorkPoolAccess", &prefect.WorkPoolAccessArgs{
			WorkspaceId:  pulumi.String(testWorkspace.Id),
			WorkPoolName: testWorkPool.Name,
			ManageActorIds: pulumi.StringArray{
				testServiceAccount.ActorId,
			},
			RunActorIds: pulumi.StringArray{
				testServiceAccount.ActorId,
			},
			ViewActorIds: pulumi.StringArray{
				testServiceAccount.ActorId,
			},
			ManageTeamIds: pulumi.StringArray{
				pulumi.String(testTeam.Id),
			},
			RunTeamIds: pulumi.StringArray{
				pulumi.String(testTeam.Id),
			},
			ViewTeamIds: pulumi.StringArray{
				pulumi.String(testTeam.Id),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prefect = Pulumi.Prefect;

return await Deployment.RunAsync(() => 
{
    var testWorkspace = Prefect.GetWorkspace.Invoke(new()
    {
        Handle = "my-workspace",
    });

    var developer = Prefect.GetWorkspaceRole.Invoke(new()
    {
        Name = "Developer",
    });

    var testServiceAccount = new Prefect.ServiceAccount("testServiceAccount");

    var testWorkspaceAccess = new Prefect.WorkspaceAccess("testWorkspaceAccess", new()
    {
        AccessorType = "SERVICE_ACCOUNT",
        AccessorId = testServiceAccount.Id,
        WorkspaceRoleId = developer.Apply(getWorkspaceRoleResult => getWorkspaceRoleResult.Id),
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
    });

    // Example: invite a Team to the Workspace and grant it Developer access
    var testTeam = Prefect.GetTeam.Invoke(new()
    {
        Name = "my-team",
    });

    var testTeamWorkspaceAccess = new Prefect.WorkspaceAccess("testTeamWorkspaceAccess", new()
    {
        AccessorType = "TEAM",
        AccessorId = testTeam.Apply(getTeamResult => getTeamResult.Id),
        WorkspaceRoleId = developer.Apply(getWorkspaceRoleResult => getWorkspaceRoleResult.Id),
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
    });

    // Define the Work Pool and grant access to the Work Pool
    var testWorkPool = new Prefect.WorkPool("testWorkPool", new()
    {
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
    });

    var testWorkPoolAccess = new Prefect.WorkPoolAccess("testWorkPoolAccess", new()
    {
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
        WorkPoolName = testWorkPool.Name,
        ManageActorIds = new[]
        {
            testServiceAccount.ActorId,
        },
        RunActorIds = new[]
        {
            testServiceAccount.ActorId,
        },
        ViewActorIds = new[]
        {
            testServiceAccount.ActorId,
        },
        ManageTeamIds = new[]
        {
            testTeam.Apply(getTeamResult => getTeamResult.Id),
        },
        RunTeamIds = new[]
        {
            testTeam.Apply(getTeamResult => getTeamResult.Id),
        },
        ViewTeamIds = new[]
        {
            testTeam.Apply(getTeamResult => getTeamResult.Id),
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.PrefectFunctions;
import com.pulumi.prefect.inputs.GetWorkspaceArgs;
import com.pulumi.prefect.inputs.GetWorkspaceRoleArgs;
import com.pulumi.prefect.ServiceAccount;
import com.pulumi.prefect.WorkspaceAccess;
import com.pulumi.prefect.WorkspaceAccessArgs;
import com.pulumi.prefect.inputs.GetTeamArgs;
import com.pulumi.prefect.WorkPool;
import com.pulumi.prefect.WorkPoolArgs;
import com.pulumi.prefect.WorkPoolAccess;
import com.pulumi.prefect.WorkPoolAccessArgs;
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) {
        final var testWorkspace = PrefectFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .handle("my-workspace")
            .build());

        final var developer = PrefectFunctions.getWorkspaceRole(GetWorkspaceRoleArgs.builder()
            .name("Developer")
            .build());

        var testServiceAccount = new ServiceAccount("testServiceAccount");

        var testWorkspaceAccess = new WorkspaceAccess("testWorkspaceAccess", WorkspaceAccessArgs.builder()
            .accessorType("SERVICE_ACCOUNT")
            .accessorId(testServiceAccount.id())
            .workspaceRoleId(developer.applyValue(getWorkspaceRoleResult -> getWorkspaceRoleResult.id()))
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .build());

        // Example: invite a Team to the Workspace and grant it Developer access
        final var testTeam = PrefectFunctions.getTeam(GetTeamArgs.builder()
            .name("my-team")
            .build());

        var testTeamWorkspaceAccess = new WorkspaceAccess("testTeamWorkspaceAccess", WorkspaceAccessArgs.builder()
            .accessorType("TEAM")
            .accessorId(testTeam.applyValue(getTeamResult -> getTeamResult.id()))
            .workspaceRoleId(developer.applyValue(getWorkspaceRoleResult -> getWorkspaceRoleResult.id()))
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .build());

        // Define the Work Pool and grant access to the Work Pool
        var testWorkPool = new WorkPool("testWorkPool", WorkPoolArgs.builder()
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .build());

        var testWorkPoolAccess = new WorkPoolAccess("testWorkPoolAccess", WorkPoolAccessArgs.builder()
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .workPoolName(testWorkPool.name())
            .manageActorIds(testServiceAccount.actorId())
            .runActorIds(testServiceAccount.actorId())
            .viewActorIds(testServiceAccount.actorId())
            .manageTeamIds(testTeam.applyValue(getTeamResult -> getTeamResult.id()))
            .runTeamIds(testTeam.applyValue(getTeamResult -> getTeamResult.id()))
            .viewTeamIds(testTeam.applyValue(getTeamResult -> getTeamResult.id()))
            .build());

    }
}
Copy
resources:
  testServiceAccount:
    type: prefect:ServiceAccount
  testWorkspaceAccess: # Example: invite a Team to the Workspace and grant it Developer access
    type: prefect:WorkspaceAccess
    properties:
      accessorType: SERVICE_ACCOUNT
      accessorId: ${testServiceAccount.id}
      workspaceRoleId: ${developer.id}
      workspaceId: ${testWorkspace.id}
  testTeamWorkspaceAccess: # Define the Work Pool and grant access to the Work Pool
    type: prefect:WorkspaceAccess
    properties:
      accessorType: TEAM
      accessorId: ${testTeam.id}
      workspaceRoleId: ${developer.id}
      workspaceId: ${testWorkspace.id}
  testWorkPool:
    type: prefect:WorkPool
    properties:
      workspaceId: ${testWorkspace.id}
  testWorkPoolAccess:
    type: prefect:WorkPoolAccess
    properties:
      workspaceId: ${testWorkspace.id}
      workPoolName: ${testWorkPool.name}
      manageActorIds:
        - ${testServiceAccount.actorId}
      runActorIds:
        - ${testServiceAccount.actorId}
      viewActorIds:
        - ${testServiceAccount.actorId}
      manageTeamIds:
        - ${testTeam.id}
      runTeamIds:
        - ${testTeam.id}
      viewTeamIds:
        - ${testTeam.id}
variables:
  testWorkspace:
    fn::invoke:
      function: prefect:getWorkspace
      arguments:
        handle: my-workspace
  developer: # Example: invite a Service Account to the Workspace and grant it Developer access
    fn::invoke:
      function: prefect:getWorkspaceRole
      arguments:
        name: Developer
  testTeam:
    fn::invoke:
      function: prefect:getTeam
      arguments:
        name: my-team
Copy

Create WorkPoolAccess Resource

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

Constructor syntax

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

@overload
def WorkPoolAccess(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   work_pool_name: Optional[str] = None,
                   account_id: Optional[str] = None,
                   manage_actor_ids: Optional[Sequence[str]] = None,
                   manage_team_ids: Optional[Sequence[str]] = None,
                   run_actor_ids: Optional[Sequence[str]] = None,
                   run_team_ids: Optional[Sequence[str]] = None,
                   view_actor_ids: Optional[Sequence[str]] = None,
                   view_team_ids: Optional[Sequence[str]] = None,
                   workspace_id: Optional[str] = None)
func NewWorkPoolAccess(ctx *Context, name string, args WorkPoolAccessArgs, opts ...ResourceOption) (*WorkPoolAccess, error)
public WorkPoolAccess(string name, WorkPoolAccessArgs args, CustomResourceOptions? opts = null)
public WorkPoolAccess(String name, WorkPoolAccessArgs args)
public WorkPoolAccess(String name, WorkPoolAccessArgs args, CustomResourceOptions options)

type: prefect:WorkPoolAccess
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. WorkPoolAccessArgs
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. WorkPoolAccessArgs
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. WorkPoolAccessArgs
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. WorkPoolAccessArgs
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. WorkPoolAccessArgs
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 workPoolAccessResource = new Prefect.WorkPoolAccess("workPoolAccessResource", new()
{
    WorkPoolName = "string",
    AccountId = "string",
    ManageActorIds = new[]
    {
        "string",
    },
    ManageTeamIds = new[]
    {
        "string",
    },
    RunActorIds = new[]
    {
        "string",
    },
    RunTeamIds = new[]
    {
        "string",
    },
    ViewActorIds = new[]
    {
        "string",
    },
    ViewTeamIds = new[]
    {
        "string",
    },
    WorkspaceId = "string",
});
Copy
example, err := prefect.NewWorkPoolAccess(ctx, "workPoolAccessResource", &prefect.WorkPoolAccessArgs{
WorkPoolName: pulumi.String("string"),
AccountId: pulumi.String("string"),
ManageActorIds: pulumi.StringArray{
pulumi.String("string"),
},
ManageTeamIds: pulumi.StringArray{
pulumi.String("string"),
},
RunActorIds: pulumi.StringArray{
pulumi.String("string"),
},
RunTeamIds: pulumi.StringArray{
pulumi.String("string"),
},
ViewActorIds: pulumi.StringArray{
pulumi.String("string"),
},
ViewTeamIds: pulumi.StringArray{
pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
})
Copy
var workPoolAccessResource = new WorkPoolAccess("workPoolAccessResource", WorkPoolAccessArgs.builder()
    .workPoolName("string")
    .accountId("string")
    .manageActorIds("string")
    .manageTeamIds("string")
    .runActorIds("string")
    .runTeamIds("string")
    .viewActorIds("string")
    .viewTeamIds("string")
    .workspaceId("string")
    .build());
Copy
work_pool_access_resource = prefect.WorkPoolAccess("workPoolAccessResource",
    work_pool_name="string",
    account_id="string",
    manage_actor_ids=["string"],
    manage_team_ids=["string"],
    run_actor_ids=["string"],
    run_team_ids=["string"],
    view_actor_ids=["string"],
    view_team_ids=["string"],
    workspace_id="string")
Copy
const workPoolAccessResource = new prefect.WorkPoolAccess("workPoolAccessResource", {
    workPoolName: "string",
    accountId: "string",
    manageActorIds: ["string"],
    manageTeamIds: ["string"],
    runActorIds: ["string"],
    runTeamIds: ["string"],
    viewActorIds: ["string"],
    viewTeamIds: ["string"],
    workspaceId: "string",
});
Copy
type: prefect:WorkPoolAccess
properties:
    accountId: string
    manageActorIds:
        - string
    manageTeamIds:
        - string
    runActorIds:
        - string
    runTeamIds:
        - string
    viewActorIds:
        - string
    viewTeamIds:
        - string
    workPoolName: string
    workspaceId: string
Copy

WorkPoolAccess 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 WorkPoolAccess resource accepts the following input properties:

WorkPoolName This property is required. string
The name of the Work Pool
AccountId string
Account ID (UUID)
ManageActorIds List<string>
List of actor IDs with manage access to the Work Pool
ManageTeamIds List<string>
List of team IDs with manage access to the Work Pool
RunActorIds List<string>
List of actor IDs with run access to the Work Pool
RunTeamIds List<string>
List of team IDs with run access to the Work Pool
ViewActorIds List<string>
List of actor IDs with view access to the Work Pool
ViewTeamIds List<string>
List of team IDs with view access to the Work Pool
WorkspaceId string
Workspace ID (UUID)
WorkPoolName This property is required. string
The name of the Work Pool
AccountId string
Account ID (UUID)
ManageActorIds []string
List of actor IDs with manage access to the Work Pool
ManageTeamIds []string
List of team IDs with manage access to the Work Pool
RunActorIds []string
List of actor IDs with run access to the Work Pool
RunTeamIds []string
List of team IDs with run access to the Work Pool
ViewActorIds []string
List of actor IDs with view access to the Work Pool
ViewTeamIds []string
List of team IDs with view access to the Work Pool
WorkspaceId string
Workspace ID (UUID)
workPoolName This property is required. String
The name of the Work Pool
accountId String
Account ID (UUID)
manageActorIds List<String>
List of actor IDs with manage access to the Work Pool
manageTeamIds List<String>
List of team IDs with manage access to the Work Pool
runActorIds List<String>
List of actor IDs with run access to the Work Pool
runTeamIds List<String>
List of team IDs with run access to the Work Pool
viewActorIds List<String>
List of actor IDs with view access to the Work Pool
viewTeamIds List<String>
List of team IDs with view access to the Work Pool
workspaceId String
Workspace ID (UUID)
workPoolName This property is required. string
The name of the Work Pool
accountId string
Account ID (UUID)
manageActorIds string[]
List of actor IDs with manage access to the Work Pool
manageTeamIds string[]
List of team IDs with manage access to the Work Pool
runActorIds string[]
List of actor IDs with run access to the Work Pool
runTeamIds string[]
List of team IDs with run access to the Work Pool
viewActorIds string[]
List of actor IDs with view access to the Work Pool
viewTeamIds string[]
List of team IDs with view access to the Work Pool
workspaceId string
Workspace ID (UUID)
work_pool_name This property is required. str
The name of the Work Pool
account_id str
Account ID (UUID)
manage_actor_ids Sequence[str]
List of actor IDs with manage access to the Work Pool
manage_team_ids Sequence[str]
List of team IDs with manage access to the Work Pool
run_actor_ids Sequence[str]
List of actor IDs with run access to the Work Pool
run_team_ids Sequence[str]
List of team IDs with run access to the Work Pool
view_actor_ids Sequence[str]
List of actor IDs with view access to the Work Pool
view_team_ids Sequence[str]
List of team IDs with view access to the Work Pool
workspace_id str
Workspace ID (UUID)
workPoolName This property is required. String
The name of the Work Pool
accountId String
Account ID (UUID)
manageActorIds List<String>
List of actor IDs with manage access to the Work Pool
manageTeamIds List<String>
List of team IDs with manage access to the Work Pool
runActorIds List<String>
List of actor IDs with run access to the Work Pool
runTeamIds List<String>
List of team IDs with run access to the Work Pool
viewActorIds List<String>
List of actor IDs with view access to the Work Pool
viewTeamIds List<String>
List of team IDs with view access to the Work Pool
workspaceId String
Workspace ID (UUID)

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkPoolAccess 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 WorkPoolAccess Resource

Get an existing WorkPoolAccess 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?: WorkPoolAccessState, opts?: CustomResourceOptions): WorkPoolAccess
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        manage_actor_ids: Optional[Sequence[str]] = None,
        manage_team_ids: Optional[Sequence[str]] = None,
        run_actor_ids: Optional[Sequence[str]] = None,
        run_team_ids: Optional[Sequence[str]] = None,
        view_actor_ids: Optional[Sequence[str]] = None,
        view_team_ids: Optional[Sequence[str]] = None,
        work_pool_name: Optional[str] = None,
        workspace_id: Optional[str] = None) -> WorkPoolAccess
func GetWorkPoolAccess(ctx *Context, name string, id IDInput, state *WorkPoolAccessState, opts ...ResourceOption) (*WorkPoolAccess, error)
public static WorkPoolAccess Get(string name, Input<string> id, WorkPoolAccessState? state, CustomResourceOptions? opts = null)
public static WorkPoolAccess get(String name, Output<String> id, WorkPoolAccessState state, CustomResourceOptions options)
resources:  _:    type: prefect:WorkPoolAccess    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:
AccountId string
Account ID (UUID)
ManageActorIds List<string>
List of actor IDs with manage access to the Work Pool
ManageTeamIds List<string>
List of team IDs with manage access to the Work Pool
RunActorIds List<string>
List of actor IDs with run access to the Work Pool
RunTeamIds List<string>
List of team IDs with run access to the Work Pool
ViewActorIds List<string>
List of actor IDs with view access to the Work Pool
ViewTeamIds List<string>
List of team IDs with view access to the Work Pool
WorkPoolName string
The name of the Work Pool
WorkspaceId string
Workspace ID (UUID)
AccountId string
Account ID (UUID)
ManageActorIds []string
List of actor IDs with manage access to the Work Pool
ManageTeamIds []string
List of team IDs with manage access to the Work Pool
RunActorIds []string
List of actor IDs with run access to the Work Pool
RunTeamIds []string
List of team IDs with run access to the Work Pool
ViewActorIds []string
List of actor IDs with view access to the Work Pool
ViewTeamIds []string
List of team IDs with view access to the Work Pool
WorkPoolName string
The name of the Work Pool
WorkspaceId string
Workspace ID (UUID)
accountId String
Account ID (UUID)
manageActorIds List<String>
List of actor IDs with manage access to the Work Pool
manageTeamIds List<String>
List of team IDs with manage access to the Work Pool
runActorIds List<String>
List of actor IDs with run access to the Work Pool
runTeamIds List<String>
List of team IDs with run access to the Work Pool
viewActorIds List<String>
List of actor IDs with view access to the Work Pool
viewTeamIds List<String>
List of team IDs with view access to the Work Pool
workPoolName String
The name of the Work Pool
workspaceId String
Workspace ID (UUID)
accountId string
Account ID (UUID)
manageActorIds string[]
List of actor IDs with manage access to the Work Pool
manageTeamIds string[]
List of team IDs with manage access to the Work Pool
runActorIds string[]
List of actor IDs with run access to the Work Pool
runTeamIds string[]
List of team IDs with run access to the Work Pool
viewActorIds string[]
List of actor IDs with view access to the Work Pool
viewTeamIds string[]
List of team IDs with view access to the Work Pool
workPoolName string
The name of the Work Pool
workspaceId string
Workspace ID (UUID)
account_id str
Account ID (UUID)
manage_actor_ids Sequence[str]
List of actor IDs with manage access to the Work Pool
manage_team_ids Sequence[str]
List of team IDs with manage access to the Work Pool
run_actor_ids Sequence[str]
List of actor IDs with run access to the Work Pool
run_team_ids Sequence[str]
List of team IDs with run access to the Work Pool
view_actor_ids Sequence[str]
List of actor IDs with view access to the Work Pool
view_team_ids Sequence[str]
List of team IDs with view access to the Work Pool
work_pool_name str
The name of the Work Pool
workspace_id str
Workspace ID (UUID)
accountId String
Account ID (UUID)
manageActorIds List<String>
List of actor IDs with manage access to the Work Pool
manageTeamIds List<String>
List of team IDs with manage access to the Work Pool
runActorIds List<String>
List of actor IDs with run access to the Work Pool
runTeamIds List<String>
List of team IDs with run access to the Work Pool
viewActorIds List<String>
List of actor IDs with view access to the Work Pool
viewTeamIds List<String>
List of team IDs with view access to the Work Pool
workPoolName String
The name of the Work Pool
workspaceId String
Workspace ID (UUID)

Package Details

Repository
prefect prefecthq/terraform-provider-prefect
License
Notes
This Pulumi package is based on the prefect Terraform Provider.
prefect 2.24.1 published on Tuesday, Apr 15, 2025 by prefecthq
prefecthq/terraform-provider-prefect