ApiKey

HTML/CSS to Image v0.2.0, Sep 29 26

Viewing docs for HTML/CSS to Image v0.2.0
published on Tuesday, Sep 29, 2026 by htmlcsstoimage

Schema (JSON)

htmlcsstoimage/pulumi-html-css-to-image

HTML/CSS to Image

Viewing docs for HTML/CSS to Image v0.2.0
published on Tuesday, Sep 29, 2026 by htmlcsstoimage

Schema (JSON)

htmlcsstoimage/pulumi-html-css-to-image

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: Optional[ApiKeyArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           all_future_permissions: Optional[bool] = None,
           description: Optional[str] = None,
           disabled: Optional[bool] = None,
           name: Optional[str] = None,
           permissions: Optional[Sequence[str]] = None)

func NewApiKey(ctx *Context, name string, args *ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)

public ApiKey(string name, ApiKeyArgs? args = null, CustomResourceOptions? opts = null)

public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

type: html-css-to-image:ApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "html-css-to-image_api_key" "name" {
    # resource properties
}

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 HtmlCssToImage.ApiKey("apiKeyResource", new()
{
    AllFuturePermissions = false,
    Description = "string",
    Disabled = false,
    Name = "string",
    Permissions = new[]
    {
        "string",
    },
});

example, err := htmlcsstoimage.NewApiKey(ctx, "apiKeyResource", &htmlcsstoimage.ApiKeyArgs{
AllFuturePermissions: pulumi.Bool(false),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Name: pulumi.String("string"),
Permissions: pulumi.StringArray{
pulumi.String("string"),
},
})

resource "html-css-to-image_api_key" "apiKeyResource" {
  lifecycle {
    create_before_destroy = true
  }
  all_future_permissions = false
  description            = "string"
  disabled               = false
  name                   = "string"
  permissions            = ["string"]
}

var apiKeyResource = new ApiKey("apiKeyResource", ApiKeyArgs.builder()
    .allFuturePermissions(false)
    .description("string")
    .disabled(false)
    .name("string")
    .permissions("string")
    .build());

api_key_resource = html_css_to_image.ApiKey("apiKeyResource",
    all_future_permissions=False,
    description="string",
    disabled=False,
    name="string",
    permissions=["string"])

const apiKeyResource = new html_css_to_image.ApiKey("apiKeyResource", {
    allFuturePermissions: false,
    description: "string",
    disabled: false,
    name: "string",
    permissions: ["string"],
});

type: html-css-to-image:ApiKey
properties:
    allFuturePermissions: false
    description: string
    disabled: false
    name: string
    permissions:
        - 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:

AllFuturePermissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
Description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
Disabled bool: Disable authentication with the key. Defaults to false.
Name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
Permissions List<string>: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.

AllFuturePermissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
Description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
Disabled bool: Disable authentication with the key. Defaults to false.
Name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
Permissions []string: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.

all_future_permissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled bool: Disable authentication with the key. Defaults to false.
name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions list(string): Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.

allFuturePermissions Boolean: Grant all current and future permissions. Requires caller authority. Defaults to false.
description String: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled Boolean: Disable authentication with the key. Defaults to false.
name String: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions List<String>: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.

allFuturePermissions boolean: Grant all current and future permissions. Requires caller authority. Defaults to false.
description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled boolean: Disable authentication with the key. Defaults to false.
name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions string[]: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.

all_future_permissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
description str: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled bool: Disable authentication with the key. Defaults to false.
name str: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions Sequence[str]: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.

allFuturePermissions Boolean: Grant all current and future permissions. Requires caller authority. Defaults to false.
description String: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled Boolean: Disable authentication with the key. Defaults to false.
name String: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions List<String>: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.

Outputs

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

ApiId string: API ID used to authenticate with this key.
CreatedAt string: Creation timestamp.
EffectiveName string: Actual display name returned by the API, including a generated name when name is omitted.
EffectivePermissions List<string>: Current grants returned by the API, including expansion of all_future_permissions.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: Last update timestamp.
Value string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.

ApiId string: API ID used to authenticate with this key.
ApiKey string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
CreatedAt string: Creation timestamp.
EffectiveName string: Actual display name returned by the API, including a generated name when name is omitted.
EffectivePermissions []string: Current grants returned by the API, including expansion of all_future_permissions.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: Last update timestamp.

api_id string: API ID used to authenticate with this key.
api_key string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
created_at string: Creation timestamp.
effective_name string: Actual display name returned by the API, including a generated name when name is omitted.
effective_permissions list(string): Current grants returned by the API, including expansion of all_future_permissions.
id string: The provider-assigned unique ID for this managed resource.
updated_at string: Last update timestamp.

apiId String: API ID used to authenticate with this key.
apiKey String: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
createdAt String: Creation timestamp.
effectiveName String: Actual display name returned by the API, including a generated name when name is omitted.
effectivePermissions List<String>: Current grants returned by the API, including expansion of all_future_permissions.
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: Last update timestamp.

apiId string: API ID used to authenticate with this key.
apiKey string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
createdAt string: Creation timestamp.
effectiveName string: Actual display name returned by the API, including a generated name when name is omitted.
effectivePermissions string[]: Current grants returned by the API, including expansion of all_future_permissions.
id string: The provider-assigned unique ID for this managed resource.
updatedAt string: Last update timestamp.

api_id str: API ID used to authenticate with this key.
api_key str: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
created_at str: Creation timestamp.
effective_name str: Actual display name returned by the API, including a generated name when name is omitted.
effective_permissions Sequence[str]: Current grants returned by the API, including expansion of all_future_permissions.
id str: The provider-assigned unique ID for this managed resource.
updated_at str: Last update timestamp.

apiId String: API ID used to authenticate with this key.
apiKey String: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
createdAt String: Creation timestamp.
effectiveName String: Actual display name returned by the API, including a generated name when name is omitted.
effectivePermissions List<String>: Current grants returned by the API, including expansion of all_future_permissions.
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: Last update timestamp.

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,
        all_future_permissions: Optional[bool] = None,
        api_id: Optional[str] = None,
        api_key: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        disabled: Optional[bool] = None,
        effective_name: Optional[str] = None,
        effective_permissions: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None,
        updated_at: 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: html-css-to-image:ApiKey    get:      id: ${id}

import {
  to = html-css-to-image_api_key.example
  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:

AllFuturePermissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
ApiId string: API ID used to authenticate with this key.
CreatedAt string: Creation timestamp.
Description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
Disabled bool: Disable authentication with the key. Defaults to false.
EffectiveName string: Actual display name returned by the API, including a generated name when name is omitted.
EffectivePermissions List<string>: Current grants returned by the API, including expansion of all_future_permissions.
Name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
Permissions List<string>: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.
UpdatedAt string: Last update timestamp.
Value string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.

AllFuturePermissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
ApiId string: API ID used to authenticate with this key.
ApiKey string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
CreatedAt string: Creation timestamp.
Description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
Disabled bool: Disable authentication with the key. Defaults to false.
EffectiveName string: Actual display name returned by the API, including a generated name when name is omitted.
EffectivePermissions []string: Current grants returned by the API, including expansion of all_future_permissions.
Name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
Permissions []string: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.
UpdatedAt string: Last update timestamp.

all_future_permissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
api_id string: API ID used to authenticate with this key.
api_key string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
created_at string: Creation timestamp.
description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled bool: Disable authentication with the key. Defaults to false.
effective_name string: Actual display name returned by the API, including a generated name when name is omitted.
effective_permissions list(string): Current grants returned by the API, including expansion of all_future_permissions.
name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions list(string): Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.
updated_at string: Last update timestamp.

allFuturePermissions Boolean: Grant all current and future permissions. Requires caller authority. Defaults to false.
apiId String: API ID used to authenticate with this key.
apiKey String: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
createdAt String: Creation timestamp.
description String: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled Boolean: Disable authentication with the key. Defaults to false.
effectiveName String: Actual display name returned by the API, including a generated name when name is omitted.
effectivePermissions List<String>: Current grants returned by the API, including expansion of all_future_permissions.
name String: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions List<String>: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.
updatedAt String: Last update timestamp.

allFuturePermissions boolean: Grant all current and future permissions. Requires caller authority. Defaults to false.
apiId string: API ID used to authenticate with this key.
apiKey string: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
createdAt string: Creation timestamp.
description string: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled boolean: Disable authentication with the key. Defaults to false.
effectiveName string: Actual display name returned by the API, including a generated name when name is omitted.
effectivePermissions string[]: Current grants returned by the API, including expansion of all_future_permissions.
name string: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions string[]: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.
updatedAt string: Last update timestamp.

all_future_permissions bool: Grant all current and future permissions. Requires caller authority. Defaults to false.
api_id str: API ID used to authenticate with this key.
api_key str: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
created_at str: Creation timestamp.
description str: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled bool: Disable authentication with the key. Defaults to false.
effective_name str: Actual display name returned by the API, including a generated name when name is omitted.
effective_permissions Sequence[str]: Current grants returned by the API, including expansion of all_future_permissions.
name str: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions Sequence[str]: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.
updated_at str: Last update timestamp.

allFuturePermissions Boolean: Grant all current and future permissions. Requires caller authority. Defaults to false.
apiId String: API ID used to authenticate with this key.
apiKey String: Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
createdAt String: Creation timestamp.
description String: Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
disabled Boolean: Disable authentication with the key. Defaults to false.
effectiveName String: Actual display name returned by the API, including a generated name when name is omitted.
effectivePermissions List<String>: Current grants returned by the API, including expansion of all_future_permissions.
name String: Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
permissions List<String>: Complete permission set. Required when allFuturePermissions is false; [] grants no permissions. Must be omitted or empty when allFuturePermissions is true.
updatedAt String: Last update timestamp.

Package Details

Repository: html-css-to-image htmlcsstoimage/pulumi-html-css-to-image
License: MIT
Notes: This Pulumi package is based on the html-css-to-image Terraform Provider.

HTML/CSS to Image

Viewing docs for HTML/CSS to Image v0.2.0
published on Tuesday, Sep 29, 2026 by htmlcsstoimage

Schema (JSON)

htmlcsstoimage/pulumi-html-css-to-image

html-css-to-image.ApiKey

On this page

On this page

Create ApiKey Resource

Constructor syntax

Parameters

Constructor example

ApiKey Resource Properties

Inputs

Outputs

Look up Existing ApiKey Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

html-css-to-image.ApiKey

On this page

On this page

Create ApiKey Resource

Constructor syntax

Parameters

Constructor example

ApiKey Resource Properties

Inputs

Outputs

Look up Existing ApiKey Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.