Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Temporalcloud Provider
  3. API Docs
  4. Apikey
temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

temporalcloud.Apikey

Explore with Pulumi AI

temporalcloud logo
temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

    Provisions a Temporal Cloud API key.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as temporalcloud from "@pulumi/temporalcloud";

const globalServiceAccount = new temporalcloud.ServiceAccount("globalServiceAccount", {accountAccess: "Admin"});
const globalApikey = new temporalcloud.Apikey("globalApikey", {
    displayName: "admin",
    ownerType: "service-account",
    ownerId: globalServiceAccount.id,
    expiryTime: "2024-11-01T00:00:00Z",
    disabled: false,
});

    import pulumi
import pulumi_temporalcloud as temporalcloud

global_service_account = temporalcloud.ServiceAccount("globalServiceAccount", account_access="Admin")
global_apikey = temporalcloud.Apikey("globalApikey",
    display_name="admin",
    owner_type="service-account",
    owner_id=global_service_account.id,
    expiry_time="2024-11-01T00:00:00Z",
    disabled=False)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/temporalcloud/temporalcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		globalServiceAccount, err := temporalcloud.NewServiceAccount(ctx, "globalServiceAccount", &temporalcloud.ServiceAccountArgs{
			AccountAccess: pulumi.String("Admin"),
		})
		if err != nil {
			return err
		}
		_, err = temporalcloud.NewApikey(ctx, "globalApikey", &temporalcloud.ApikeyArgs{
			DisplayName: pulumi.String("admin"),
			OwnerType:   pulumi.String("service-account"),
			OwnerId:     globalServiceAccount.ID(),
			ExpiryTime:  pulumi.String("2024-11-01T00:00:00Z"),
			Disabled:    pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Temporalcloud = Pulumi.Temporalcloud;

return await Deployment.RunAsync(() => 
{
    var globalServiceAccount = new Temporalcloud.ServiceAccount("globalServiceAccount", new()
    {
        AccountAccess = "Admin",
    });

    var globalApikey = new Temporalcloud.Apikey("globalApikey", new()
    {
        DisplayName = "admin",
        OwnerType = "service-account",
        OwnerId = globalServiceAccount.Id,
        ExpiryTime = "2024-11-01T00:00:00Z",
        Disabled = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.temporalcloud.ServiceAccount;
import com.pulumi.temporalcloud.ServiceAccountArgs;
import com.pulumi.temporalcloud.Apikey;
import com.pulumi.temporalcloud.ApikeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var globalServiceAccount = new ServiceAccount("globalServiceAccount", ServiceAccountArgs.builder()
            .accountAccess("Admin")
            .build());

        var globalApikey = new Apikey("globalApikey", ApikeyArgs.builder()
            .displayName("admin")
            .ownerType("service-account")
            .ownerId(globalServiceAccount.id())
            .expiryTime("2024-11-01T00:00:00Z")
            .disabled(false)
            .build());

    }
}

    resources:
  globalServiceAccount:
    type: temporalcloud:ServiceAccount
    properties:
      accountAccess: Admin
  globalApikey:
    type: temporalcloud:Apikey
    properties:
      displayName: admin
      ownerType: service-account
      ownerId: ${globalServiceAccount.id}
      expiryTime: 2024-11-01T00:00:00Z
      disabled: false

    Create Apikey Resource

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

    Constructor syntax

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

@overload
def Apikey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           display_name: Optional[str] = None,
           expiry_time: Optional[str] = None,
           owner_id: Optional[str] = None,
           owner_type: Optional[str] = None,
           description: Optional[str] = None,
           disabled: Optional[bool] = None,
           timeouts: Optional[ApikeyTimeoutsArgs] = None)
    func NewApikey(ctx *Context, name string, args ApikeyArgs, opts ...ResourceOption) (*Apikey, error)
    public Apikey(string name, ApikeyArgs args, CustomResourceOptions? opts = null)
    public Apikey(String name, ApikeyArgs args)
public Apikey(String name, ApikeyArgs args, CustomResourceOptions options)

    type: temporalcloud:Apikey
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 ApikeyArgs
    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 ApikeyArgs
    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 ApikeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApikeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApikeyArgs
    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 apikeyResource = new Temporalcloud.Apikey("apikeyResource", new()
{
    DisplayName = "string",
    ExpiryTime = "string",
    OwnerId = "string",
    OwnerType = "string",
    Description = "string",
    Disabled = false,
    Timeouts = new Temporalcloud.Inputs.ApikeyTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := temporalcloud.NewApikey(ctx, "apikeyResource", &temporalcloud.ApikeyArgs{
DisplayName: pulumi.String("string"),
ExpiryTime: pulumi.String("string"),
OwnerId: pulumi.String("string"),
OwnerType: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Timeouts: &.ApikeyTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})

    var apikeyResource = new Apikey("apikeyResource", ApikeyArgs.builder()
    .displayName("string")
    .expiryTime("string")
    .ownerId("string")
    .ownerType("string")
    .description("string")
    .disabled(false)
    .timeouts(ApikeyTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    apikey_resource = temporalcloud.Apikey("apikeyResource",
    display_name="string",
    expiry_time="string",
    owner_id="string",
    owner_type="string",
    description="string",
    disabled=False,
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const apikeyResource = new temporalcloud.Apikey("apikeyResource", {
    displayName: "string",
    expiryTime: "string",
    ownerId: "string",
    ownerType: "string",
    description: "string",
    disabled: false,
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: temporalcloud:Apikey
properties:
    description: string
    disabled: false
    displayName: string
    expiryTime: string
    ownerId: string
    ownerType: string
    timeouts:
        create: string
        delete: string

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

    DisplayName string
    The display name for the API key.
    ExpiryTime string
    The expiry time for the API key in ISO 8601 format.
    OwnerId string
    The ID of the owner to create the API key for.
    OwnerType string
    The type of the owner to create the API key.
    Description string
    The description for the API key.
    Disabled bool
    Whether the API key is disabled.
    Timeouts ApikeyTimeouts
    DisplayName string
    The display name for the API key.
    ExpiryTime string
    The expiry time for the API key in ISO 8601 format.
    OwnerId string
    The ID of the owner to create the API key for.
    OwnerType string
    The type of the owner to create the API key.
    Description string
    The description for the API key.
    Disabled bool
    Whether the API key is disabled.
    Timeouts ApikeyTimeoutsArgs
    displayName String
    The display name for the API key.
    expiryTime String
    The expiry time for the API key in ISO 8601 format.
    ownerId String
    The ID of the owner to create the API key for.
    ownerType String
    The type of the owner to create the API key.
    description String
    The description for the API key.
    disabled Boolean
    Whether the API key is disabled.
    timeouts ApikeyTimeouts
    displayName string
    The display name for the API key.
    expiryTime string
    The expiry time for the API key in ISO 8601 format.
    ownerId string
    The ID of the owner to create the API key for.
    ownerType string
    The type of the owner to create the API key.
    description string
    The description for the API key.
    disabled boolean
    Whether the API key is disabled.
    timeouts ApikeyTimeouts
    display_name str
    The display name for the API key.
    expiry_time str
    The expiry time for the API key in ISO 8601 format.
    owner_id str
    The ID of the owner to create the API key for.
    owner_type str
    The type of the owner to create the API key.
    description str
    The description for the API key.
    disabled bool
    Whether the API key is disabled.
    timeouts ApikeyTimeoutsArgs
    displayName String
    The display name for the API key.
    expiryTime String
    The expiry time for the API key in ISO 8601 format.
    ownerId String
    The ID of the owner to create the API key for.
    ownerType String
    The type of the owner to create the API key.
    description String
    The description for the API key.
    disabled Boolean
    Whether the API key is disabled.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the API key.
    Token string
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the API key.
    Token string
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the API key.
    token String
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the API key.
    token string
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the API key.
    token str
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the API key.
    token String

    Look up Existing Apikey Resource

    Get an existing Apikey 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?: ApikeyState, opts?: CustomResourceOptions): Apikey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disabled: Optional[bool] = None,
        display_name: Optional[str] = None,
        expiry_time: Optional[str] = None,
        owner_id: Optional[str] = None,
        owner_type: Optional[str] = None,
        state: Optional[str] = None,
        timeouts: Optional[ApikeyTimeoutsArgs] = None,
        token: Optional[str] = None) -> Apikey
    func GetApikey(ctx *Context, name string, id IDInput, state *ApikeyState, opts ...ResourceOption) (*Apikey, error)
    public static Apikey Get(string name, Input<string> id, ApikeyState? state, CustomResourceOptions? opts = null)
    public static Apikey get(String name, Output<String> id, ApikeyState state, CustomResourceOptions options)
    resources:  _:    type: temporalcloud:Apikey    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:
    Description string
    The description for the API key.
    Disabled bool
    Whether the API key is disabled.
    DisplayName string
    The display name for the API key.
    ExpiryTime string
    The expiry time for the API key in ISO 8601 format.
    OwnerId string
    The ID of the owner to create the API key for.
    OwnerType string
    The type of the owner to create the API key.
    State string
    The current state of the API key.
    Timeouts ApikeyTimeouts
    Token string
    Description string
    The description for the API key.
    Disabled bool
    Whether the API key is disabled.
    DisplayName string
    The display name for the API key.
    ExpiryTime string
    The expiry time for the API key in ISO 8601 format.
    OwnerId string
    The ID of the owner to create the API key for.
    OwnerType string
    The type of the owner to create the API key.
    State string
    The current state of the API key.
    Timeouts ApikeyTimeoutsArgs
    Token string
    description String
    The description for the API key.
    disabled Boolean
    Whether the API key is disabled.
    displayName String
    The display name for the API key.
    expiryTime String
    The expiry time for the API key in ISO 8601 format.
    ownerId String
    The ID of the owner to create the API key for.
    ownerType String
    The type of the owner to create the API key.
    state String
    The current state of the API key.
    timeouts ApikeyTimeouts
    token String
    description string
    The description for the API key.
    disabled boolean
    Whether the API key is disabled.
    displayName string
    The display name for the API key.
    expiryTime string
    The expiry time for the API key in ISO 8601 format.
    ownerId string
    The ID of the owner to create the API key for.
    ownerType string
    The type of the owner to create the API key.
    state string
    The current state of the API key.
    timeouts ApikeyTimeouts
    token string
    description str
    The description for the API key.
    disabled bool
    Whether the API key is disabled.
    display_name str
    The display name for the API key.
    expiry_time str
    The expiry time for the API key in ISO 8601 format.
    owner_id str
    The ID of the owner to create the API key for.
    owner_type str
    The type of the owner to create the API key.
    state str
    The current state of the API key.
    timeouts ApikeyTimeoutsArgs
    token str
    description String
    The description for the API key.
    disabled Boolean
    Whether the API key is disabled.
    displayName String
    The display name for the API key.
    expiryTime String
    The expiry time for the API key in ISO 8601 format.
    ownerId String
    The ID of the owner to create the API key for.
    ownerType String
    The type of the owner to create the API key.
    state String
    The current state of the API key.
    timeouts Property Map
    token String

    Supporting Types

    ApikeyTimeouts, ApikeyTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Package Details

    Repository
    temporalcloud temporalio/terraform-provider-temporalcloud
    License
    Notes
    This Pulumi package is based on the temporalcloud Terraform Provider.
    temporalcloud logo
    temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
    temporalio/terraform-provider-temporalcloud