1. Packages
  2. Prefect Provider
  3. API Docs
  4. Provider
prefect 2.25.0 published on Monday, Apr 21, 2025 by prefecthq

prefect.Provider

Explore with Pulumi AI

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,
             endpoint: 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.