Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prefect Provider
  3. API Docs
  4. Account
prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq
prefecthq/terraform-provider-prefect

prefect.Account

Explore with Pulumi AI

prefect logo
prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq
prefecthq/terraform-provider-prefect

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example:
    type: prefect:Account
    properties:
      billingEmail: marvin@prefect.io
      description: A cool account
      settings:
        ai_log_summaries: false
        allow_public_workspaces: true
        managed_execution: false

    Create Account Resource

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

    Constructor syntax

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

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            handle: Optional[str] = None,
            billing_email: Optional[str] = None,
            domain_names: Optional[Sequence[str]] = None,
            link: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            settings: Optional[AccountSettingsArgs] = None)
    func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
    public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
    public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)

    type: prefect:Account
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 AccountArgs
    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 AccountArgs
    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 AccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountArgs
    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 accountResource = new Prefect.Account("accountResource", new()
{
    Handle = "string",
    BillingEmail = "string",
    DomainNames = new[]
    {
        "string",
    },
    Link = "string",
    Location = "string",
    Name = "string",
    Settings = new Prefect.Inputs.AccountSettingsArgs
    {
        AiLogSummaries = false,
        AllowPublicWorkspaces = false,
        ManagedExecution = false,
    },
});

    example, err := prefect.NewAccount(ctx, "accountResource", &prefect.AccountArgs{
Handle: pulumi.String("string"),
BillingEmail: pulumi.String("string"),
DomainNames: pulumi.StringArray{
pulumi.String("string"),
},
Link: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Settings: &.AccountSettingsArgs{
AiLogSummaries: pulumi.Bool(false),
AllowPublicWorkspaces: pulumi.Bool(false),
ManagedExecution: pulumi.Bool(false),
},
})

    var accountResource = new Account("accountResource", AccountArgs.builder()
    .handle("string")
    .billingEmail("string")
    .domainNames("string")
    .link("string")
    .location("string")
    .name("string")
    .settings(AccountSettingsArgs.builder()
        .aiLogSummaries(false)
        .allowPublicWorkspaces(false)
        .managedExecution(false)
        .build())
    .build());

    account_resource = prefect.Account("accountResource",
    handle="string",
    billing_email="string",
    domain_names=["string"],
    link="string",
    location="string",
    name="string",
    settings={
        "ai_log_summaries": False,
        "allow_public_workspaces": False,
        "managed_execution": False,
    })

    const accountResource = new prefect.Account("accountResource", {
    handle: "string",
    billingEmail: "string",
    domainNames: ["string"],
    link: "string",
    location: "string",
    name: "string",
    settings: {
        aiLogSummaries: false,
        allowPublicWorkspaces: false,
        managedExecution: false,
    },
});

    type: prefect:Account
properties:
    billingEmail: string
    domainNames:
        - string
    handle: string
    link: string
    location: string
    name: string
    settings:
        aiLogSummaries: false
        allowPublicWorkspaces: false
        managedExecution: false

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

    Handle string
    Unique handle of the account
    BillingEmail string
    Billing email to apply to the account's Stripe customer
    DomainNames List<string>
    The list of domain names for enabling SSO in Prefect Cloud.
    Link string
    An optional for an external url associated with the account, e.g. https://prefect.io/
    Location string
    An optional physical location for the account, e.g. Washington, D.C.
    Name string
    Name of the account
    Settings AccountSettings
    Group of settings related to accounts
    Handle string
    Unique handle of the account
    BillingEmail string
    Billing email to apply to the account's Stripe customer
    DomainNames []string
    The list of domain names for enabling SSO in Prefect Cloud.
    Link string
    An optional for an external url associated with the account, e.g. https://prefect.io/
    Location string
    An optional physical location for the account, e.g. Washington, D.C.
    Name string
    Name of the account
    Settings AccountSettingsArgs
    Group of settings related to accounts
    handle String
    Unique handle of the account
    billingEmail String
    Billing email to apply to the account's Stripe customer
    domainNames List<String>
    The list of domain names for enabling SSO in Prefect Cloud.
    link String
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location String
    An optional physical location for the account, e.g. Washington, D.C.
    name String
    Name of the account
    settings AccountSettings
    Group of settings related to accounts
    handle string
    Unique handle of the account
    billingEmail string
    Billing email to apply to the account's Stripe customer
    domainNames string[]
    The list of domain names for enabling SSO in Prefect Cloud.
    link string
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location string
    An optional physical location for the account, e.g. Washington, D.C.
    name string
    Name of the account
    settings AccountSettings
    Group of settings related to accounts
    handle str
    Unique handle of the account
    billing_email str
    Billing email to apply to the account's Stripe customer
    domain_names Sequence[str]
    The list of domain names for enabling SSO in Prefect Cloud.
    link str
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location str
    An optional physical location for the account, e.g. Washington, D.C.
    name str
    Name of the account
    settings AccountSettingsArgs
    Group of settings related to accounts
    handle String
    Unique handle of the account
    billingEmail String
    Billing email to apply to the account's Stripe customer
    domainNames List<String>
    The list of domain names for enabling SSO in Prefect Cloud.
    link String
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location String
    An optional physical location for the account, e.g. Washington, D.C.
    name String
    Name of the account
    settings Property Map
    Group of settings related to accounts

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Account resource produces the following output properties:

    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    Timestamp of when the resource was updated (RFC3339)
    created string
    Timestamp of when the resource was created (RFC3339)
    id string
    The provider-assigned unique ID for this managed resource.
    updated string
    Timestamp of when the resource was updated (RFC3339)
    created str
    Timestamp of when the resource was created (RFC3339)
    id str
    The provider-assigned unique ID for this managed resource.
    updated str
    Timestamp of when the resource was updated (RFC3339)
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    Timestamp of when the resource was updated (RFC3339)

    Look up Existing Account Resource

    Get an existing Account 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?: AccountState, opts?: CustomResourceOptions): Account
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        billing_email: Optional[str] = None,
        created: Optional[str] = None,
        domain_names: Optional[Sequence[str]] = None,
        handle: Optional[str] = None,
        link: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        settings: Optional[AccountSettingsArgs] = None,
        updated: Optional[str] = None) -> Account
    func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
    public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
    public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
    resources:  _:    type: prefect:Account    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    BillingEmail string
    Billing email to apply to the account's Stripe customer
    Created string
    Timestamp of when the resource was created (RFC3339)
    DomainNames List<string>
    The list of domain names for enabling SSO in Prefect Cloud.
    Handle string
    Unique handle of the account
    Link string
    An optional for an external url associated with the account, e.g. https://prefect.io/
    Location string
    An optional physical location for the account, e.g. Washington, D.C.
    Name string
    Name of the account
    Settings AccountSettings
    Group of settings related to accounts
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    BillingEmail string
    Billing email to apply to the account's Stripe customer
    Created string
    Timestamp of when the resource was created (RFC3339)
    DomainNames []string
    The list of domain names for enabling SSO in Prefect Cloud.
    Handle string
    Unique handle of the account
    Link string
    An optional for an external url associated with the account, e.g. https://prefect.io/
    Location string
    An optional physical location for the account, e.g. Washington, D.C.
    Name string
    Name of the account
    Settings AccountSettingsArgs
    Group of settings related to accounts
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    billingEmail String
    Billing email to apply to the account's Stripe customer
    created String
    Timestamp of when the resource was created (RFC3339)
    domainNames List<String>
    The list of domain names for enabling SSO in Prefect Cloud.
    handle String
    Unique handle of the account
    link String
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location String
    An optional physical location for the account, e.g. Washington, D.C.
    name String
    Name of the account
    settings AccountSettings
    Group of settings related to accounts
    updated String
    Timestamp of when the resource was updated (RFC3339)
    billingEmail string
    Billing email to apply to the account's Stripe customer
    created string
    Timestamp of when the resource was created (RFC3339)
    domainNames string[]
    The list of domain names for enabling SSO in Prefect Cloud.
    handle string
    Unique handle of the account
    link string
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location string
    An optional physical location for the account, e.g. Washington, D.C.
    name string
    Name of the account
    settings AccountSettings
    Group of settings related to accounts
    updated string
    Timestamp of when the resource was updated (RFC3339)
    billing_email str
    Billing email to apply to the account's Stripe customer
    created str
    Timestamp of when the resource was created (RFC3339)
    domain_names Sequence[str]
    The list of domain names for enabling SSO in Prefect Cloud.
    handle str
    Unique handle of the account
    link str
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location str
    An optional physical location for the account, e.g. Washington, D.C.
    name str
    Name of the account
    settings AccountSettingsArgs
    Group of settings related to accounts
    updated str
    Timestamp of when the resource was updated (RFC3339)
    billingEmail String
    Billing email to apply to the account's Stripe customer
    created String
    Timestamp of when the resource was created (RFC3339)
    domainNames List<String>
    The list of domain names for enabling SSO in Prefect Cloud.
    handle String
    Unique handle of the account
    link String
    An optional for an external url associated with the account, e.g. https://prefect.io/
    location String
    An optional physical location for the account, e.g. Washington, D.C.
    name String
    Name of the account
    settings Property Map
    Group of settings related to accounts
    updated String
    Timestamp of when the resource was updated (RFC3339)

    Supporting Types

    AccountSettings, AccountSettingsArgs

    AiLogSummaries bool
    Whether to use AI to generate log summaries.
    AllowPublicWorkspaces bool
    Whether or not this account allows public workspaces
    ManagedExecution bool
    Whether to enable the use of managed work pools
    AiLogSummaries bool
    Whether to use AI to generate log summaries.
    AllowPublicWorkspaces bool
    Whether or not this account allows public workspaces
    ManagedExecution bool
    Whether to enable the use of managed work pools
    aiLogSummaries Boolean
    Whether to use AI to generate log summaries.
    allowPublicWorkspaces Boolean
    Whether or not this account allows public workspaces
    managedExecution Boolean
    Whether to enable the use of managed work pools
    aiLogSummaries boolean
    Whether to use AI to generate log summaries.
    allowPublicWorkspaces boolean
    Whether or not this account allows public workspaces
    managedExecution boolean
    Whether to enable the use of managed work pools
    ai_log_summaries bool
    Whether to use AI to generate log summaries.
    allow_public_workspaces bool
    Whether or not this account allows public workspaces
    managed_execution bool
    Whether to enable the use of managed work pools
    aiLogSummaries Boolean
    Whether to use AI to generate log summaries.
    allowPublicWorkspaces Boolean
    Whether or not this account allows public workspaces
    managedExecution Boolean
    Whether to enable the use of managed work pools

    Import

    Prefect Accounts can be imported using the account’s UUID

    $ pulumi import prefect:index/account:Account example 00000000-0000-0000-0000-000000000000

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    prefect prefecthq/terraform-provider-prefect
    License
    Notes
    This Pulumi package is based on the prefect Terraform Provider.
    prefect logo
    prefect 2.22.3 published on Thursday, Mar 20, 2025 by prefecthq
    prefecthq/terraform-provider-prefect