prefect 2.22.4, Mar 26 25

prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq

prefect.UserApiKey

Explore with Pulumi AI

prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq

The resource user_api_key represents a Prefect User API Key. User API Keys are used to authenticate requests to the Prefect API and are specifically bound to Prefect Users (and not Service Accounts - see prefect.ServiceAccount). API Keys via prefect.UserApiKey resources are not updateable, and any changes to the name or expiration attributes will force a replacement of the API key.

This feature is available in the following product plan(s): Prefect Cloud (Free), Prefect Cloud (Pro), Prefect Cloud (Enterprise).

Create UserApiKey Resource

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

Constructor syntax

new UserApiKey(name: string, args: UserApiKeyArgs, opts?: CustomResourceOptions);

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

@overload
def UserApiKey(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               user_id: Optional[str] = None,
               expiration: Optional[str] = None,
               name: Optional[str] = None)

func NewUserApiKey(ctx *Context, name string, args UserApiKeyArgs, opts ...ResourceOption) (*UserApiKey, error)

public UserApiKey(string name, UserApiKeyArgs args, CustomResourceOptions? opts = null)

public UserApiKey(String name, UserApiKeyArgs args)
public UserApiKey(String name, UserApiKeyArgs args, CustomResourceOptions options)

type: prefect:UserApiKey
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 UserApiKeyArgs: 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 UserApiKeyArgs: 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 UserApiKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args UserApiKeyArgs: 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 userApiKeyResource = new Prefect.UserApiKey("userApiKeyResource", new()
{
    UserId = "string",
    Expiration = "string",
    Name = "string",
});

example, err := prefect.NewUserApiKey(ctx, "userApiKeyResource", &prefect.UserApiKeyArgs{
UserId: pulumi.String("string"),
Expiration: pulumi.String("string"),
Name: pulumi.String("string"),
})

var userApiKeyResource = new UserApiKey("userApiKeyResource", UserApiKeyArgs.builder()
    .userId("string")
    .expiration("string")
    .name("string")
    .build());

user_api_key_resource = prefect.UserApiKey("userApiKeyResource",
    user_id="string",
    expiration="string",
    name="string")

const userApiKeyResource = new prefect.UserApiKey("userApiKeyResource", {
    userId: "string",
    expiration: "string",
    name: "string",
});

type: prefect:UserApiKey
properties:
    expiration: string
    name: string
    userId: string

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

UserId string: User ID (UUID)
Expiration string: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
Name string: Name of the API key

UserId string: User ID (UUID)
Expiration string: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
Name string: Name of the API key

userId String: User ID (UUID)
expiration String: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
name String: Name of the API key

userId string: User ID (UUID)
expiration string: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
name string: Name of the API key

user_id str: User ID (UUID)
expiration str: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
name str: Name of the API key

userId String: User ID (UUID)
expiration String: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
name String: Name of the API key

Outputs

All input properties are implicitly available as output properties. Additionally, the UserApiKey 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.
Key string: Value of the API key

Created string: Timestamp of when the resource was created (RFC3339)
Id string: The provider-assigned unique ID for this managed resource.
Key string: Value of the API key

created String: Timestamp of when the resource was created (RFC3339)
id String: The provider-assigned unique ID for this managed resource.
key String: Value of the API key

created string: Timestamp of when the resource was created (RFC3339)
id string: The provider-assigned unique ID for this managed resource.
key string: Value of the API key

created str: Timestamp of when the resource was created (RFC3339)
id str: The provider-assigned unique ID for this managed resource.
key str: Value of the API key

created String: Timestamp of when the resource was created (RFC3339)
id String: The provider-assigned unique ID for this managed resource.
key String: Value of the API key

Look up Existing UserApiKey Resource

Get an existing UserApiKey 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?: UserApiKeyState, opts?: CustomResourceOptions): UserApiKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        expiration: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        user_id: Optional[str] = None) -> UserApiKey

func GetUserApiKey(ctx *Context, name string, id IDInput, state *UserApiKeyState, opts ...ResourceOption) (*UserApiKey, error)

public static UserApiKey Get(string name, Input<string> id, UserApiKeyState? state, CustomResourceOptions? opts = null)

public static UserApiKey get(String name, Output<String> id, UserApiKeyState state, CustomResourceOptions options)

resources:  _:    type: prefect:UserApiKey    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:

Created string: Timestamp of when the resource was created (RFC3339)
Expiration string: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
Key string: Value of the API key
Name string: Name of the API key
UserId string: User ID (UUID)

Created string: Timestamp of when the resource was created (RFC3339)
Expiration string: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
Key string: Value of the API key
Name string: Name of the API key
UserId string: User ID (UUID)

created String: Timestamp of when the resource was created (RFC3339)
expiration String: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
key String: Value of the API key
name String: Name of the API key
userId String: User ID (UUID)

created string: Timestamp of when the resource was created (RFC3339)
expiration string: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
key string: Value of the API key
name string: Name of the API key
userId string: User ID (UUID)

created str: Timestamp of when the resource was created (RFC3339)
expiration str: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
key str: Value of the API key
name str: Name of the API key
user_id str: User ID (UUID)

created String: Timestamp of when the resource was created (RFC3339)
expiration String: Expiration of the API key (RFC3339). If left as null, the API key will not expire. Modify this attribute to re-create the API key.
key String: Value of the API key
name String: Name of the API key
userId String: User ID (UUID)

Package Details

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

prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq

prefecthq/terraform-provider-prefect

prefect.UserApiKey

On this page

On this page

Create UserApiKey Resource

Constructor syntax

Parameters

Constructor example

UserApiKey Resource Properties

Inputs

Outputs

Look up Existing UserApiKey Resource

Package Details

On this page

On this page