1. Packages
  2. Prefect Provider
  3. API Docs
  4. DeploymentAccess
prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq

prefect.DeploymentAccess

Explore with Pulumi AI

The resource deployment_access represents a connection between an accessor (User, Service Account or Team) with a Deployment. This resource specifies an actor’s access level to a specific Deployment 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 Flow and Deployment, and grant access to the Deployment
const testFlow = new prefect.Flow("testFlow", {
    workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id),
    tags: ["test"],
});
const testDeployment = new prefect.Deployment("testDeployment", {
    workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id),
    flowId: testFlow.id,
});
const testDeploymentAccess = new prefect.DeploymentAccess("testDeploymentAccess", {
    workspaceId: testWorkspace.then(testWorkspace => testWorkspace.id),
    deploymentId: testDeployment.id,
    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 Flow and Deployment, and grant access to the Deployment
test_flow = prefect.Flow("testFlow",
    workspace_id=test_workspace.id,
    tags=["test"])
test_deployment = prefect.Deployment("testDeployment",
    workspace_id=test_workspace.id,
    flow_id=test_flow.id)
test_deployment_access = prefect.DeploymentAccess("testDeploymentAccess",
    workspace_id=test_workspace.id,
    deployment_id=test_deployment.id,
    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
		}
		testFlow, err := prefect.NewFlow(ctx, "testFlow", &prefect.FlowArgs{
			WorkspaceId: pulumi.String(testWorkspace.Id),
			Tags: pulumi.StringArray{
				pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		testDeployment, err := prefect.NewDeployment(ctx, "testDeployment", &prefect.DeploymentArgs{
			WorkspaceId: pulumi.String(testWorkspace.Id),
			FlowId:      testFlow.ID(),
		})
		if err != nil {
			return err
		}
		_, err = prefect.NewDeploymentAccess(ctx, "testDeploymentAccess", &prefect.DeploymentAccessArgs{
			WorkspaceId:  pulumi.String(testWorkspace.Id),
			DeploymentId: testDeployment.ID(),
			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 Flow and Deployment, and grant access to the Deployment
    var testFlow = new Prefect.Flow("testFlow", new()
    {
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
        Tags = new[]
        {
            "test",
        },
    });

    var testDeployment = new Prefect.Deployment("testDeployment", new()
    {
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
        FlowId = testFlow.Id,
    });

    var testDeploymentAccess = new Prefect.DeploymentAccess("testDeploymentAccess", new()
    {
        WorkspaceId = testWorkspace.Apply(getWorkspaceResult => getWorkspaceResult.Id),
        DeploymentId = testDeployment.Id,
        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.Flow;
import com.pulumi.prefect.FlowArgs;
import com.pulumi.prefect.Deployment;
import com.pulumi.prefect.DeploymentArgs;
import com.pulumi.prefect.DeploymentAccess;
import com.pulumi.prefect.DeploymentAccessArgs;
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 Flow and Deployment, and grant access to the Deployment
        var testFlow = new Flow("testFlow", FlowArgs.builder()
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .tags("test")
            .build());

        var testDeployment = new Deployment("testDeployment", DeploymentArgs.builder()
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .flowId(testFlow.id())
            .build());

        var testDeploymentAccess = new DeploymentAccess("testDeploymentAccess", DeploymentAccessArgs.builder()
            .workspaceId(testWorkspace.applyValue(getWorkspaceResult -> getWorkspaceResult.id()))
            .deploymentId(testDeployment.id())
            .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 Flow and Deployment, and grant access to the Deployment
    type: prefect:WorkspaceAccess
    properties:
      accessorType: TEAM
      accessorId: ${testTeam.id}
      workspaceRoleId: ${developer.id}
      workspaceId: ${testWorkspace.id}
  testFlow:
    type: prefect:Flow
    properties:
      workspaceId: ${testWorkspace.id}
      tags:
        - test
  testDeployment:
    type: prefect:Deployment
    properties:
      workspaceId: ${testWorkspace.id}
      flowId: ${testFlow.id}
  testDeploymentAccess:
    type: prefect:DeploymentAccess
    properties:
      workspaceId: ${testWorkspace.id}
      deploymentId: ${testDeployment.id}
      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 DeploymentAccess Resource

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

Constructor syntax

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

@overload
def DeploymentAccess(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     deployment_id: 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 NewDeploymentAccess(ctx *Context, name string, args DeploymentAccessArgs, opts ...ResourceOption) (*DeploymentAccess, error)
public DeploymentAccess(string name, DeploymentAccessArgs args, CustomResourceOptions? opts = null)
public DeploymentAccess(String name, DeploymentAccessArgs args)
public DeploymentAccess(String name, DeploymentAccessArgs args, CustomResourceOptions options)
type: prefect:DeploymentAccess
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. DeploymentAccessArgs
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. DeploymentAccessArgs
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. DeploymentAccessArgs
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. DeploymentAccessArgs
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. DeploymentAccessArgs
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 deploymentAccessResource = new Prefect.DeploymentAccess("deploymentAccessResource", new()
{
    DeploymentId = "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.NewDeploymentAccess(ctx, "deploymentAccessResource", &prefect.DeploymentAccessArgs{
DeploymentId: 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 deploymentAccessResource = new DeploymentAccess("deploymentAccessResource", DeploymentAccessArgs.builder()
    .deploymentId("string")
    .accountId("string")
    .manageActorIds("string")
    .manageTeamIds("string")
    .runActorIds("string")
    .runTeamIds("string")
    .viewActorIds("string")
    .viewTeamIds("string")
    .workspaceId("string")
    .build());
Copy
deployment_access_resource = prefect.DeploymentAccess("deploymentAccessResource",
    deployment_id="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 deploymentAccessResource = new prefect.DeploymentAccess("deploymentAccessResource", {
    deploymentId: "string",
    accountId: "string",
    manageActorIds: ["string"],
    manageTeamIds: ["string"],
    runActorIds: ["string"],
    runTeamIds: ["string"],
    viewActorIds: ["string"],
    viewTeamIds: ["string"],
    workspaceId: "string",
});
Copy
type: prefect:DeploymentAccess
properties:
    accountId: string
    deploymentId: string
    manageActorIds:
        - string
    manageTeamIds:
        - string
    runActorIds:
        - string
    runTeamIds:
        - string
    viewActorIds:
        - string
    viewTeamIds:
        - string
    workspaceId: string
Copy

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

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

Outputs

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

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