prefect 2.89.0, Oct 16 25

prefect 2.89.0 published on Thursday, Oct 16, 2025 by prefecthq

prefect.Provider

prefect 2.89.0 published on Thursday, Oct 16, 2025 by prefecthq

The provider type for the prefect package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             account_id: Optional[str] = None,
             api_key: Optional[str] = None,
             basic_auth_key: Optional[str] = None,
             csrf_enabled: Optional[bool] = None,
             endpoint: Optional[str] = None,
             profile: Optional[str] = None,
             profile_file: Optional[str] = None,
             workspace_id: Optional[str] = None)

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:prefect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

AccountId string: Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_ID environment variable.
ApiKey string: Prefect Cloud API key. Can also be set via the PREFECT_API_KEY environment variable.
BasicAuthKey string: Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEY environment variable.
CsrfEnabled bool: Enable CSRF protection for API requests. Defaults to false. If enabled, the provider will fetch a CSRF token from the Prefect API and include it in all requests. This should be enabled if your Prefect server instance has CSRF protection active. Can also be set via the PREFECT_CSRF_ENABLED environment variable.
Endpoint string: The Prefect API URL. Can also be set via the PREFECT_API_URL environment variable. Defaults to https://api.prefect.cloud if not configured. Can optionally include the default account ID and workspace ID in the following format: https://api.prefect.cloud/api/accounts/<accountID>/workspaces/<workspaceID>. This is the same format used for the PREFECT_API_URL value in the Prefect CLI configuration file. The account_id and workspace_id attributes and their matching environment variables will take priority over any account and workspace ID values provided in the endpoint attribute.
Profile string: Prefect profile name to use for authentication. If not specified, uses the active profile from ~/.prefect/profiles.toml. This allows you to use a specific profile instead of the active one.
ProfileFile string: Path to the Prefect profiles file. If not specified, uses the default location ~/.prefect/profiles.toml. This allows you to use a custom profiles file location.
WorkspaceId string: Default Prefect Cloud Workspace ID.

AccountId string: Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_ID environment variable.
ApiKey string: Prefect Cloud API key. Can also be set via the PREFECT_API_KEY environment variable.
BasicAuthKey string: Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEY environment variable.
CsrfEnabled bool: Enable CSRF protection for API requests. Defaults to false. If enabled, the provider will fetch a CSRF token from the Prefect API and include it in all requests. This should be enabled if your Prefect server instance has CSRF protection active. Can also be set via the PREFECT_CSRF_ENABLED environment variable.
Endpoint string: The Prefect API URL. Can also be set via the PREFECT_API_URL environment variable. Defaults to https://api.prefect.cloud if not configured. Can optionally include the default account ID and workspace ID in the following format: https://api.prefect.cloud/api/accounts/<accountID>/workspaces/<workspaceID>. This is the same format used for the PREFECT_API_URL value in the Prefect CLI configuration file. The account_id and workspace_id attributes and their matching environment variables will take priority over any account and workspace ID values provided in the endpoint attribute.
Profile string: Prefect profile name to use for authentication. If not specified, uses the active profile from ~/.prefect/profiles.toml. This allows you to use a specific profile instead of the active one.
ProfileFile string: Path to the Prefect profiles file. If not specified, uses the default location ~/.prefect/profiles.toml. This allows you to use a custom profiles file location.
WorkspaceId string: Default Prefect Cloud Workspace ID.

accountId String: Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_ID environment variable.
apiKey String: Prefect Cloud API key. Can also be set via the PREFECT_API_KEY environment variable.
basicAuthKey String: Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEY environment variable.
csrfEnabled Boolean: Enable CSRF protection for API requests. Defaults to false. If enabled, the provider will fetch a CSRF token from the Prefect API and include it in all requests. This should be enabled if your Prefect server instance has CSRF protection active. Can also be set via the PREFECT_CSRF_ENABLED environment variable.
endpoint String: The Prefect API URL. Can also be set via the PREFECT_API_URL environment variable. Defaults to https://api.prefect.cloud if not configured. Can optionally include the default account ID and workspace ID in the following format: https://api.prefect.cloud/api/accounts/<accountID>/workspaces/<workspaceID>. This is the same format used for the PREFECT_API_URL value in the Prefect CLI configuration file. The account_id and workspace_id attributes and their matching environment variables will take priority over any account and workspace ID values provided in the endpoint attribute.
profile String: Prefect profile name to use for authentication. If not specified, uses the active profile from ~/.prefect/profiles.toml. This allows you to use a specific profile instead of the active one.
profileFile String: Path to the Prefect profiles file. If not specified, uses the default location ~/.prefect/profiles.toml. This allows you to use a custom profiles file location.
workspaceId String: Default Prefect Cloud Workspace ID.

accountId string: Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_ID environment variable.
apiKey string: Prefect Cloud API key. Can also be set via the PREFECT_API_KEY environment variable.
basicAuthKey string: Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEY environment variable.
csrfEnabled boolean: Enable CSRF protection for API requests. Defaults to false. If enabled, the provider will fetch a CSRF token from the Prefect API and include it in all requests. This should be enabled if your Prefect server instance has CSRF protection active. Can also be set via the PREFECT_CSRF_ENABLED environment variable.
endpoint string: The Prefect API URL. Can also be set via the PREFECT_API_URL environment variable. Defaults to https://api.prefect.cloud if not configured. Can optionally include the default account ID and workspace ID in the following format: https://api.prefect.cloud/api/accounts/<accountID>/workspaces/<workspaceID>. This is the same format used for the PREFECT_API_URL value in the Prefect CLI configuration file. The account_id and workspace_id attributes and their matching environment variables will take priority over any account and workspace ID values provided in the endpoint attribute.
profile string: Prefect profile name to use for authentication. If not specified, uses the active profile from ~/.prefect/profiles.toml. This allows you to use a specific profile instead of the active one.
profileFile string: Path to the Prefect profiles file. If not specified, uses the default location ~/.prefect/profiles.toml. This allows you to use a custom profiles file location.
workspaceId string: Default Prefect Cloud Workspace ID.

account_id str: Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_ID environment variable.
api_key str: Prefect Cloud API key. Can also be set via the PREFECT_API_KEY environment variable.
basic_auth_key str: Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEY environment variable.
csrf_enabled bool: Enable CSRF protection for API requests. Defaults to false. If enabled, the provider will fetch a CSRF token from the Prefect API and include it in all requests. This should be enabled if your Prefect server instance has CSRF protection active. Can also be set via the PREFECT_CSRF_ENABLED environment variable.
endpoint str: The Prefect API URL. Can also be set via the PREFECT_API_URL environment variable. Defaults to https://api.prefect.cloud if not configured. Can optionally include the default account ID and workspace ID in the following format: https://api.prefect.cloud/api/accounts/<accountID>/workspaces/<workspaceID>. This is the same format used for the PREFECT_API_URL value in the Prefect CLI configuration file. The account_id and workspace_id attributes and their matching environment variables will take priority over any account and workspace ID values provided in the endpoint attribute.
profile str: Prefect profile name to use for authentication. If not specified, uses the active profile from ~/.prefect/profiles.toml. This allows you to use a specific profile instead of the active one.
profile_file str: Path to the Prefect profiles file. If not specified, uses the default location ~/.prefect/profiles.toml. This allows you to use a custom profiles file location.
workspace_id str: Default Prefect Cloud Workspace ID.

accountId String: Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_ID environment variable.
apiKey String: Prefect Cloud API key. Can also be set via the PREFECT_API_KEY environment variable.
basicAuthKey String: Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEY environment variable.
csrfEnabled Boolean: Enable CSRF protection for API requests. Defaults to false. If enabled, the provider will fetch a CSRF token from the Prefect API and include it in all requests. This should be enabled if your Prefect server instance has CSRF protection active. Can also be set via the PREFECT_CSRF_ENABLED environment variable.
endpoint String: The Prefect API URL. Can also be set via the PREFECT_API_URL environment variable. Defaults to https://api.prefect.cloud if not configured. Can optionally include the default account ID and workspace ID in the following format: https://api.prefect.cloud/api/accounts/<accountID>/workspaces/<workspaceID>. This is the same format used for the PREFECT_API_URL value in the Prefect CLI configuration file. The account_id and workspace_id attributes and their matching environment variables will take priority over any account and workspace ID values provided in the endpoint attribute.
profile String: Prefect profile name to use for authentication. If not specified, uses the active profile from ~/.prefect/profiles.toml. This allows you to use a specific profile instead of the active one.
profileFile String: Path to the Prefect profiles file. If not specified, uses the default location ~/.prefect/profiles.toml. This allows you to use a custom profiles file location.
workspaceId String: Default Prefect Cloud Workspace ID.

Outputs

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

Package Details

Repository: prefect prefecthq/terraform-provider-prefect
License
Notes: This Pulumi package is based on the prefect Terraform Provider.

prefect 2.89.0 published on Thursday, Oct 16, 2025 by prefecthq

prefecthq/terraform-provider-prefect

prefect.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Package Details

On this page

On this page