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 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_IDenvironment variable.
- ApiKey string
- Prefect Cloud API key. Can also be set via the PREFECT_API_KEYenvironment variable.
- BasicAuth stringKey 
- Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEYenvironment variable.
- Endpoint string
- The Prefect API URL. Can also be set via the PREFECT_API_URLenvironment variable. Defaults tohttps://api.prefect.cloudif 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 thePREFECT_API_URLvalue in the Prefect CLI configuration file. Theaccount_idandworkspace_idattributes and their matching environment variables will take priority over any account and workspace ID values provided in theendpointattribute.
- WorkspaceId string
- Default Prefect Cloud Workspace ID.
- AccountId string
- Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_IDenvironment variable.
- ApiKey string
- Prefect Cloud API key. Can also be set via the PREFECT_API_KEYenvironment variable.
- BasicAuth stringKey 
- Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEYenvironment variable.
- Endpoint string
- The Prefect API URL. Can also be set via the PREFECT_API_URLenvironment variable. Defaults tohttps://api.prefect.cloudif 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 thePREFECT_API_URLvalue in the Prefect CLI configuration file. Theaccount_idandworkspace_idattributes and their matching environment variables will take priority over any account and workspace ID values provided in theendpointattribute.
- WorkspaceId string
- Default Prefect Cloud Workspace ID.
- accountId String
- Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_IDenvironment variable.
- apiKey String
- Prefect Cloud API key. Can also be set via the PREFECT_API_KEYenvironment variable.
- basicAuth StringKey 
- Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEYenvironment variable.
- endpoint String
- The Prefect API URL. Can also be set via the PREFECT_API_URLenvironment variable. Defaults tohttps://api.prefect.cloudif 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 thePREFECT_API_URLvalue in the Prefect CLI configuration file. Theaccount_idandworkspace_idattributes and their matching environment variables will take priority over any account and workspace ID values provided in theendpointattribute.
- workspaceId String
- Default Prefect Cloud Workspace ID.
- accountId string
- Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_IDenvironment variable.
- apiKey string
- Prefect Cloud API key. Can also be set via the PREFECT_API_KEYenvironment variable.
- basicAuth stringKey 
- Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEYenvironment variable.
- endpoint string
- The Prefect API URL. Can also be set via the PREFECT_API_URLenvironment variable. Defaults tohttps://api.prefect.cloudif 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 thePREFECT_API_URLvalue in the Prefect CLI configuration file. Theaccount_idandworkspace_idattributes and their matching environment variables will take priority over any account and workspace ID values provided in theendpointattribute.
- workspaceId string
- Default Prefect Cloud Workspace ID.
- account_id str
- Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_IDenvironment variable.
- api_key str
- Prefect Cloud API key. Can also be set via the PREFECT_API_KEYenvironment variable.
- basic_auth_ strkey 
- Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEYenvironment variable.
- endpoint str
- The Prefect API URL. Can also be set via the PREFECT_API_URLenvironment variable. Defaults tohttps://api.prefect.cloudif 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 thePREFECT_API_URLvalue in the Prefect CLI configuration file. Theaccount_idandworkspace_idattributes and their matching environment variables will take priority over any account and workspace ID values provided in theendpointattribute.
- workspace_id str
- Default Prefect Cloud Workspace ID.
- accountId String
- Default Prefect Cloud Account ID. Can also be set via the PREFECT_CLOUD_ACCOUNT_IDenvironment variable.
- apiKey String
- Prefect Cloud API key. Can also be set via the PREFECT_API_KEYenvironment variable.
- basicAuth StringKey 
- Prefect basic auth key. Can also be set via the PREFECT_BASIC_AUTH_KEYenvironment variable.
- endpoint String
- The Prefect API URL. Can also be set via the PREFECT_API_URLenvironment variable. Defaults tohttps://api.prefect.cloudif 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 thePREFECT_API_URLvalue in the Prefect CLI configuration file. Theaccount_idandworkspace_idattributes and their matching environment variables will take priority over any account and workspace ID values provided in theendpointattribute.
- 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 prefectTerraform Provider.