htmlcsstoimage

package module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2026 License: MIT Imports: 7 Imported by: 0

README

HTML/CSS to Image Pulumi provider

Manage HTML/CSS to Image resources with TypeScript, Python, Go, C#, Java, or Pulumi YAML.

Website · Documentation · Management API · API reference

Create images and reusable templates alongside application API keys, proxies, storage destinations, and Open Graph configurations. The provider shares its implementation with the Terraform provider.

Installation

Install the SDK for your Pulumi project's language:

Language Install
TypeScript / JavaScript npm install @html-css-to-image/pulumi
Python pip install pulumi-html-css-to-image
Go go get github.com/htmlcsstoimage/pulumi-html-css-to-image/sdk/go
C# / .NET dotnet add package HtmlCssToImage.Pulumi

For Java, add this Maven dependency:

<dependency>
  <groupId>com.htmlcsstoimage</groupId>
  <artifactId>pulumi</artifactId>
  <version>0.3.0</version>
</dependency>

The SDK automatically downloads the matching provider plugin from GitHub Releases. YAML programs select the plugin directly, as shown below.

Example

In a Pulumi project for your language, install the SDK and configure credentials:

pulumi config set html-css-to-image:apiId YOUR_API_ID
pulumi config set --secret html-css-to-image:apiKey
package main

import (
    hcti "github.com/htmlcsstoimage/pulumi-html-css-to-image/sdk/go"
    "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        card, err := hcti.NewImageHtmlCss(ctx, "card", &hcti.ImageHtmlCssArgs{
            Html: pulumi.String("<h1>Hello from Pulumi</h1>"),
        })
        if err != nil {
            return err
        }
        ctx.Export("imageUrl", card.ImageUrl)
        return nil
    })
}

Run pulumi preview and pulumi up. Open the returned URL to render the image. Creation and refresh save/read metadata without rendering bytes. Input changes replace image definitions; template edits create new versions under a stable ID.

Configuration

Setting Environment fallback Description
html-css-to-image:apiId HCTI_API_ID API ID for your organization.
html-css-to-image:apiKey HCTI_API_KEY API key; use pulumi config set --secret when storing it in stack configuration.
html-css-to-image:baseUrl None Optional API origin; defaults to https://hcti.io.

The key needs the read/write/delete permissions for the resources you manage. Credentials and headers retain Pulumi secret markings. Version identifiers are decimal strings to preserve all int64 digits. Requests identify themselves with HCTIGo/<sdk-version> HCTIPulumi/<provider-version>.

Resources and lookups

See examples for complete YAML programs. In .NET, the API key secret is ApiKey.Value and the URL image operation URL is ImageUrl.RenderingUrl to avoid member/type name collisions.

Contributing

See development and releasing. API lifecycle behavior belongs in the Terraform provider; this repository maintains the bridge, exact version conversions, SDK metadata, and Pulumi examples.


HTML/CSS to Image · Documentation · Management API · Pulumi provider repository · Report an issue

Documentation

Overview

Create images and manage templates, API keys, webhooks, storage destinations, proxies, and Open Graph configurations with the HTML/CSS to Image provider for Pulumi.

Index

Constants

View Source
const (
	RequestOverrideResourceTypeBeacon      = RequestOverrideResourceType("beacon")
	RequestOverrideResourceTypeDocument    = RequestOverrideResourceType("document")
	RequestOverrideResourceTypeStylesheet  = RequestOverrideResourceType("stylesheet")
	RequestOverrideResourceTypeImage       = RequestOverrideResourceType("image")
	RequestOverrideResourceTypeImageSet    = RequestOverrideResourceType("image_set")
	RequestOverrideResourceTypeMedia       = RequestOverrideResourceType("media")
	RequestOverrideResourceTypeFont        = RequestOverrideResourceType("font")
	RequestOverrideResourceTypeScript      = RequestOverrideResourceType("script")
	RequestOverrideResourceTypeTextTrack   = RequestOverrideResourceType("text_track")
	RequestOverrideResourceTypeXhr         = RequestOverrideResourceType("xhr")
	RequestOverrideResourceTypeFetch       = RequestOverrideResourceType("fetch")
	RequestOverrideResourceTypeEventSource = RequestOverrideResourceType("event_source")
	RequestOverrideResourceTypeManifest    = RequestOverrideResourceType("manifest")
	RequestOverrideResourceTypePing        = RequestOverrideResourceType("ping")
	RequestOverrideResourceTypeImg         = RequestOverrideResourceType("img")
	RequestOverrideResourceTypeOther       = RequestOverrideResourceType("other")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiKey

type ApiKey struct {
	pulumi.CustomResourceState

	// Grant all current and future permissions. Requires caller authority. Defaults to false.
	AllFuturePermissions pulumi.BoolOutput `pulumi:"allFuturePermissions"`
	// API ID used to authenticate with this key.
	ApiId pulumi.StringOutput `pulumi:"apiId"`
	// Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
	ApiKey pulumi.StringOutput `pulumi:"apiKey"`
	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Disable authentication with the key. Defaults to false.
	Disabled pulumi.BoolOutput `pulumi:"disabled"`
	// Actual display name returned by the API, including a generated name when name is omitted.
	EffectiveName pulumi.StringOutput `pulumi:"effectiveName"`
	// Current grants returned by the API, including expansion of all_future_permissions.
	EffectivePermissions pulumi.StringArrayOutput `pulumi:"effectivePermissions"`
	// Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// Complete permission set. Required when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is false; [] grants no permissions. Must be omitted or empty when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is true.
	Permissions pulumi.StringArrayOutput `pulumi:"permissions"`
	// Last update timestamp.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

func GetApiKey

func GetApiKey(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApiKeyState, opts ...pulumi.ResourceOption) (*ApiKey, error)

GetApiKey gets an existing ApiKey resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApiKey

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

NewApiKey registers a new resource with the given unique name, arguments, and options.

func (*ApiKey) ElementType

func (*ApiKey) ElementType() reflect.Type

func (*ApiKey) ToApiKeyOutput

func (i *ApiKey) ToApiKeyOutput() ApiKeyOutput

func (*ApiKey) ToApiKeyOutputWithContext

func (i *ApiKey) ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput

type ApiKeyArgs

type ApiKeyArgs struct {
	// Grant all current and future permissions. Requires caller authority. Defaults to false.
	AllFuturePermissions pulumi.BoolPtrInput
	// Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
	Description pulumi.StringPtrInput
	// Disable authentication with the key. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
	Name pulumi.StringPtrInput
	// Complete permission set. Required when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is false; [] grants no permissions. Must be omitted or empty when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is true.
	Permissions pulumi.StringArrayInput
}

The set of arguments for constructing a ApiKey resource.

func (ApiKeyArgs) ElementType

func (ApiKeyArgs) ElementType() reflect.Type

type ApiKeyInput

type ApiKeyInput interface {
	pulumi.Input

	ToApiKeyOutput() ApiKeyOutput
	ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput
}

type ApiKeyOutput

type ApiKeyOutput struct{ *pulumi.OutputState }

func (ApiKeyOutput) AllFuturePermissions

func (o ApiKeyOutput) AllFuturePermissions() pulumi.BoolOutput

Grant all current and future permissions. Requires caller authority. Defaults to false.

func (ApiKeyOutput) ApiId

func (o ApiKeyOutput) ApiId() pulumi.StringOutput

API ID used to authenticate with this key.

func (ApiKeyOutput) ApiKey

func (o ApiKeyOutput) ApiKey() pulumi.StringOutput

Secret returned only at creation. Preserved during refresh and updates; unavailable after import.

func (ApiKeyOutput) CreatedAt

func (o ApiKeyOutput) CreatedAt() pulumi.StringOutput

Creation timestamp.

func (ApiKeyOutput) Description

func (o ApiKeyOutput) Description() pulumi.StringPtrOutput

Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.

func (ApiKeyOutput) Disabled

func (o ApiKeyOutput) Disabled() pulumi.BoolOutput

Disable authentication with the key. Defaults to false.

func (ApiKeyOutput) EffectiveName

func (o ApiKeyOutput) EffectiveName() pulumi.StringOutput

Actual display name returned by the API, including a generated name when name is omitted.

func (ApiKeyOutput) EffectivePermissions

func (o ApiKeyOutput) EffectivePermissions() pulumi.StringArrayOutput

Current grants returned by the API, including expansion of all_future_permissions.

func (ApiKeyOutput) ElementType

func (ApiKeyOutput) ElementType() reflect.Type

func (ApiKeyOutput) Name

Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.

func (ApiKeyOutput) Permissions

func (o ApiKeyOutput) Permissions() pulumi.StringArrayOutput

Complete permission set. Required when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is false; [] grants no permissions. Must be omitted or empty when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is true.

func (ApiKeyOutput) ToApiKeyOutput

func (o ApiKeyOutput) ToApiKeyOutput() ApiKeyOutput

func (ApiKeyOutput) ToApiKeyOutputWithContext

func (o ApiKeyOutput) ToApiKeyOutputWithContext(ctx context.Context) ApiKeyOutput

func (ApiKeyOutput) UpdatedAt

func (o ApiKeyOutput) UpdatedAt() pulumi.StringOutput

Last update timestamp.

type ApiKeyState

type ApiKeyState struct {
	// Grant all current and future permissions. Requires caller authority. Defaults to false.
	AllFuturePermissions pulumi.BoolPtrInput
	// API ID used to authenticate with this key.
	ApiId pulumi.StringPtrInput
	// Secret returned only at creation. Preserved during refresh and updates; unavailable after import.
	ApiKey pulumi.StringPtrInput
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// Purpose of the key, up to 2000 characters. Omitted, null, or blank clears it.
	Description pulumi.StringPtrInput
	// Disable authentication with the key. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// Actual display name returned by the API, including a generated name when name is omitted.
	EffectiveName pulumi.StringPtrInput
	// Current grants returned by the API, including expansion of all_future_permissions.
	EffectivePermissions pulumi.StringArrayInput
	// Display name, up to 255 characters. Omitted, null, or blank uses an API-generated name based on the original creation time.
	Name pulumi.StringPtrInput
	// Complete permission set. Required when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is false; [] grants no permissions. Must be omitted or empty when<span pulumi-lang-nodejs=" allFuturePermissions " pulumi-lang-dotnet=" AllFuturePermissions " pulumi-lang-go=" allFuturePermissions " pulumi-lang-python=" all_future_permissions " pulumi-lang-yaml=" allFuturePermissions " pulumi-lang-java=" allFuturePermissions " pulumi-lang-hcl=" all_future_permissions "> allFuturePermissions </span>is true.
	Permissions pulumi.StringArrayInput
	// Last update timestamp.
	UpdatedAt pulumi.StringPtrInput
}

func (ApiKeyState) ElementType

func (ApiKeyState) ElementType() reflect.Type

type GetAwsStorageExternalIdResult

type GetAwsStorageExternalIdResult struct {
	ExternalId    string `pulumi:"externalId"`
	WriterRoleArn string `pulumi:"writerRoleArn"`
}

A collection of values returned by getAwsStorageExternalId.

func GetAwsStorageExternalId

func GetAwsStorageExternalId(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetAwsStorageExternalIdResult, error)

Read the organization's external ID and HCTI writer role ARN before creating an AWS storage destination. No destination ID or input attributes are needed. This does not create a destination or test a bucket connection.

The caller requires `storage_destinations:create_update` for this lookup.

Use <span pulumi-lang-nodejs="`externalId`" pulumi-lang-dotnet="`ExternalId`" pulumi-lang-go="`externalId`" pulumi-lang-python="`external_id`" pulumi-lang-yaml="`externalId`" pulumi-lang-java="`externalId`" pulumi-lang-hcl="`external_id`">`externalId`</span> in the IAM role trust policy's `sts:ExternalId` condition, and <span pulumi-lang-nodejs="`writerRoleArn`" pulumi-lang-dotnet="`WriterRoleArn`" pulumi-lang-go="`writerRoleArn`" pulumi-lang-python="`writer_role_arn`" pulumi-lang-yaml="`writerRoleArn`" pulumi-lang-java="`writerRoleArn`" pulumi-lang-hcl="`writer_role_arn`">`writerRoleArn`</span> as its `Principal.AWS`, allowing `sts:AssumeRole`. An external-ID condition alone is not a complete trust policy. Reference the resulting role ARN from the storage destination so Terraform creates the role before HCTI tests the connection.

| Output | Meaning | | --- | --- | | <span pulumi-lang-nodejs="`externalId`" pulumi-lang-dotnet="`ExternalId`" pulumi-lang-go="`externalId`" pulumi-lang-python="`external_id`" pulumi-lang-yaml="`externalId`" pulumi-lang-java="`externalId`" pulumi-lang-hcl="`external_id`">`externalId`</span> | Organization-specific external ID for the AWS role trust policy. | | <span pulumi-lang-nodejs="`writerRoleArn`" pulumi-lang-dotnet="`WriterRoleArn`" pulumi-lang-go="`writerRoleArn`" pulumi-lang-python="`writer_role_arn`" pulumi-lang-yaml="`writerRoleArn`" pulumi-lang-java="`writerRoleArn`" pulumi-lang-hcl="`writer_role_arn`">`writerRoleArn`</span> | HCTI writer role ARN to use as the trust policy's AWS principal. |

Lookup failures remain errors, including authorization failures and HTTP 404.

The returned <span pulumi-lang-nodejs="`writerRoleArn`" pulumi-lang-dotnet="`WriterRoleArn`" pulumi-lang-go="`writerRoleArn`" pulumi-lang-python="`writer_role_arn`" pulumi-lang-yaml="`writerRoleArn`" pulumi-lang-java="`writerRoleArn`" pulumi-lang-hcl="`writer_role_arn`">`writerRoleArn`</span> identifies HCTI's caller role. The storage destination's <span pulumi-lang-nodejs="`roleArn`" pulumi-lang-dotnet="`RoleArn`" pulumi-lang-go="`roleArn`" pulumi-lang-python="`role_arn`" pulumi-lang-yaml="`roleArn`" pulumi-lang-java="`roleArn`" pulumi-lang-hcl="`role_arn`">`roleArn`</span> identifies the role you create in your own AWS account.

type GetAwsStorageExternalIdResultOutput

type GetAwsStorageExternalIdResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAwsStorageExternalId.

func (GetAwsStorageExternalIdResultOutput) ElementType

func (GetAwsStorageExternalIdResultOutput) ExternalId

func (GetAwsStorageExternalIdResultOutput) ToGetAwsStorageExternalIdResultOutput

func (o GetAwsStorageExternalIdResultOutput) ToGetAwsStorageExternalIdResultOutput() GetAwsStorageExternalIdResultOutput

func (GetAwsStorageExternalIdResultOutput) ToGetAwsStorageExternalIdResultOutputWithContext

func (o GetAwsStorageExternalIdResultOutput) ToGetAwsStorageExternalIdResultOutputWithContext(ctx context.Context) GetAwsStorageExternalIdResultOutput

func (GetAwsStorageExternalIdResultOutput) WriterRoleArn

type GetTemplateRequestOverride added in v0.2.0

type GetTemplateRequestOverride struct {
	Action        string                        `pulumi:"action"`
	ResourceTypes []RequestOverrideResourceType `pulumi:"resourceTypes"`
	Url           string                        `pulumi:"url"`
}

type GetTemplateRequestOverrideArgs added in v0.2.0

type GetTemplateRequestOverrideArgs struct {
	Action        pulumi.StringInput                    `pulumi:"action"`
	ResourceTypes RequestOverrideResourceTypeArrayInput `pulumi:"resourceTypes"`
	Url           pulumi.StringInput                    `pulumi:"url"`
}

func (GetTemplateRequestOverrideArgs) ElementType added in v0.2.0

func (GetTemplateRequestOverrideArgs) ToGetTemplateRequestOverrideOutput added in v0.2.0

func (i GetTemplateRequestOverrideArgs) ToGetTemplateRequestOverrideOutput() GetTemplateRequestOverrideOutput

func (GetTemplateRequestOverrideArgs) ToGetTemplateRequestOverrideOutputWithContext added in v0.2.0

func (i GetTemplateRequestOverrideArgs) ToGetTemplateRequestOverrideOutputWithContext(ctx context.Context) GetTemplateRequestOverrideOutput

type GetTemplateRequestOverrideArray added in v0.2.0

type GetTemplateRequestOverrideArray []GetTemplateRequestOverrideInput

func (GetTemplateRequestOverrideArray) ElementType added in v0.2.0

func (GetTemplateRequestOverrideArray) ToGetTemplateRequestOverrideArrayOutput added in v0.2.0

func (i GetTemplateRequestOverrideArray) ToGetTemplateRequestOverrideArrayOutput() GetTemplateRequestOverrideArrayOutput

func (GetTemplateRequestOverrideArray) ToGetTemplateRequestOverrideArrayOutputWithContext added in v0.2.0

func (i GetTemplateRequestOverrideArray) ToGetTemplateRequestOverrideArrayOutputWithContext(ctx context.Context) GetTemplateRequestOverrideArrayOutput

type GetTemplateRequestOverrideArrayInput added in v0.2.0

type GetTemplateRequestOverrideArrayInput interface {
	pulumi.Input

	ToGetTemplateRequestOverrideArrayOutput() GetTemplateRequestOverrideArrayOutput
	ToGetTemplateRequestOverrideArrayOutputWithContext(context.Context) GetTemplateRequestOverrideArrayOutput
}

GetTemplateRequestOverrideArrayInput is an input type that accepts GetTemplateRequestOverrideArray and GetTemplateRequestOverrideArrayOutput values. You can construct a concrete instance of `GetTemplateRequestOverrideArrayInput` via:

GetTemplateRequestOverrideArray{ GetTemplateRequestOverrideArgs{...} }

type GetTemplateRequestOverrideArrayOutput added in v0.2.0

type GetTemplateRequestOverrideArrayOutput struct{ *pulumi.OutputState }

func (GetTemplateRequestOverrideArrayOutput) ElementType added in v0.2.0

func (GetTemplateRequestOverrideArrayOutput) Index added in v0.2.0

func (GetTemplateRequestOverrideArrayOutput) ToGetTemplateRequestOverrideArrayOutput added in v0.2.0

func (o GetTemplateRequestOverrideArrayOutput) ToGetTemplateRequestOverrideArrayOutput() GetTemplateRequestOverrideArrayOutput

func (GetTemplateRequestOverrideArrayOutput) ToGetTemplateRequestOverrideArrayOutputWithContext added in v0.2.0

func (o GetTemplateRequestOverrideArrayOutput) ToGetTemplateRequestOverrideArrayOutputWithContext(ctx context.Context) GetTemplateRequestOverrideArrayOutput

type GetTemplateRequestOverrideInput added in v0.2.0

type GetTemplateRequestOverrideInput interface {
	pulumi.Input

	ToGetTemplateRequestOverrideOutput() GetTemplateRequestOverrideOutput
	ToGetTemplateRequestOverrideOutputWithContext(context.Context) GetTemplateRequestOverrideOutput
}

GetTemplateRequestOverrideInput is an input type that accepts GetTemplateRequestOverrideArgs and GetTemplateRequestOverrideOutput values. You can construct a concrete instance of `GetTemplateRequestOverrideInput` via:

GetTemplateRequestOverrideArgs{...}

type GetTemplateRequestOverrideOutput added in v0.2.0

type GetTemplateRequestOverrideOutput struct{ *pulumi.OutputState }

func (GetTemplateRequestOverrideOutput) Action added in v0.2.0

func (GetTemplateRequestOverrideOutput) ElementType added in v0.2.0

func (GetTemplateRequestOverrideOutput) ResourceTypes added in v0.2.0

func (GetTemplateRequestOverrideOutput) ToGetTemplateRequestOverrideOutput added in v0.2.0

func (o GetTemplateRequestOverrideOutput) ToGetTemplateRequestOverrideOutput() GetTemplateRequestOverrideOutput

func (GetTemplateRequestOverrideOutput) ToGetTemplateRequestOverrideOutputWithContext added in v0.2.0

func (o GetTemplateRequestOverrideOutput) ToGetTemplateRequestOverrideOutputWithContext(ctx context.Context) GetTemplateRequestOverrideOutput

func (GetTemplateRequestOverrideOutput) Url added in v0.2.0

type GetTemplateVersionsArgs

type GetTemplateVersionsArgs struct {
	Id    string `pulumi:"id"`
	Limit *int   `pulumi:"limit"`
}

A collection of arguments for invoking getTemplateVersions.

type GetTemplateVersionsOutputArgs

type GetTemplateVersionsOutputArgs struct {
	Id    pulumi.StringInput `pulumi:"id"`
	Limit pulumi.IntPtrInput `pulumi:"limit"`
}

A collection of arguments for invoking getTemplateVersions.

func (GetTemplateVersionsOutputArgs) ElementType

type GetTemplateVersionsResult

type GetTemplateVersionsResult struct {
	Id       string                       `pulumi:"id"`
	Limit    int                          `pulumi:"limit"`
	Versions []GetTemplateVersionsVersion `pulumi:"versions"`
}

A collection of values returned by getTemplateVersions.

func GetTemplateVersions

func GetTemplateVersions(ctx *pulumi.Context, args *GetTemplateVersionsArgs, opts ...pulumi.InvokeOption) (*GetTemplateVersionsResult, error)

List versions of an existing template, newest first, up to <span pulumi-lang-nodejs="`limit`" pulumi-lang-dotnet="`Limit`" pulumi-lang-go="`limit`" pulumi-lang-python="`limit`" pulumi-lang-yaml="`limit`" pulumi-lang-java="`limit`" pulumi-lang-hcl="`limit`">`limit`</span> (default <span pulumi-lang-nodejs="`1000`" pulumi-lang-dotnet="`1000`" pulumi-lang-go="`1000`" pulumi-lang-python="`1000`" pulumi-lang-yaml="`1000`" pulumi-lang-java="`1000`" pulumi-lang-hcl="`1000`">`1000`</span>). Requires `templates:read`. The provider follows API pagination automatically and preserves exact integer version identifiers.

## Example Usage

type GetTemplateVersionsResultOutput

type GetTemplateVersionsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getTemplateVersions.

func (GetTemplateVersionsResultOutput) ElementType

func (GetTemplateVersionsResultOutput) Id

func (GetTemplateVersionsResultOutput) Limit

func (GetTemplateVersionsResultOutput) ToGetTemplateVersionsResultOutput

func (o GetTemplateVersionsResultOutput) ToGetTemplateVersionsResultOutput() GetTemplateVersionsResultOutput

func (GetTemplateVersionsResultOutput) ToGetTemplateVersionsResultOutputWithContext

func (o GetTemplateVersionsResultOutput) ToGetTemplateVersionsResultOutputWithContext(ctx context.Context) GetTemplateVersionsResultOutput

func (GetTemplateVersionsResultOutput) Versions

type GetTemplateVersionsVersion

type GetTemplateVersionsVersion struct {
	// Creation timestamp returned by the API.
	CreatedAt string `pulumi:"createdAt"`
	// Template description for this version.
	Description string `pulumi:"description"`
	// Template display name for this version.
	Name string `pulumi:"name"`
	// Template type returned by the API.
	TemplateType string `pulumi:"templateType"`
	// Update timestamp returned by the API.
	UpdatedAt string `pulumi:"updatedAt"`
	// Exact template version identifier. Represented as a decimal string to preserve int64 precision.
	Version string `pulumi:"version"`
}

type GetTemplateVersionsVersionArgs

type GetTemplateVersionsVersionArgs struct {
	// Creation timestamp returned by the API.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// Template description for this version.
	Description pulumi.StringInput `pulumi:"description"`
	// Template display name for this version.
	Name pulumi.StringInput `pulumi:"name"`
	// Template type returned by the API.
	TemplateType pulumi.StringInput `pulumi:"templateType"`
	// Update timestamp returned by the API.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
	// Exact template version identifier. Represented as a decimal string to preserve int64 precision.
	Version pulumi.StringInput `pulumi:"version"`
}

func (GetTemplateVersionsVersionArgs) ElementType

func (GetTemplateVersionsVersionArgs) ToGetTemplateVersionsVersionOutput

func (i GetTemplateVersionsVersionArgs) ToGetTemplateVersionsVersionOutput() GetTemplateVersionsVersionOutput

func (GetTemplateVersionsVersionArgs) ToGetTemplateVersionsVersionOutputWithContext

func (i GetTemplateVersionsVersionArgs) ToGetTemplateVersionsVersionOutputWithContext(ctx context.Context) GetTemplateVersionsVersionOutput

type GetTemplateVersionsVersionArray

type GetTemplateVersionsVersionArray []GetTemplateVersionsVersionInput

func (GetTemplateVersionsVersionArray) ElementType

func (GetTemplateVersionsVersionArray) ToGetTemplateVersionsVersionArrayOutput

func (i GetTemplateVersionsVersionArray) ToGetTemplateVersionsVersionArrayOutput() GetTemplateVersionsVersionArrayOutput

func (GetTemplateVersionsVersionArray) ToGetTemplateVersionsVersionArrayOutputWithContext

func (i GetTemplateVersionsVersionArray) ToGetTemplateVersionsVersionArrayOutputWithContext(ctx context.Context) GetTemplateVersionsVersionArrayOutput

type GetTemplateVersionsVersionArrayInput

type GetTemplateVersionsVersionArrayInput interface {
	pulumi.Input

	ToGetTemplateVersionsVersionArrayOutput() GetTemplateVersionsVersionArrayOutput
	ToGetTemplateVersionsVersionArrayOutputWithContext(context.Context) GetTemplateVersionsVersionArrayOutput
}

GetTemplateVersionsVersionArrayInput is an input type that accepts GetTemplateVersionsVersionArray and GetTemplateVersionsVersionArrayOutput values. You can construct a concrete instance of `GetTemplateVersionsVersionArrayInput` via:

GetTemplateVersionsVersionArray{ GetTemplateVersionsVersionArgs{...} }

type GetTemplateVersionsVersionArrayOutput

type GetTemplateVersionsVersionArrayOutput struct{ *pulumi.OutputState }

func (GetTemplateVersionsVersionArrayOutput) ElementType

func (GetTemplateVersionsVersionArrayOutput) Index

func (GetTemplateVersionsVersionArrayOutput) ToGetTemplateVersionsVersionArrayOutput

func (o GetTemplateVersionsVersionArrayOutput) ToGetTemplateVersionsVersionArrayOutput() GetTemplateVersionsVersionArrayOutput

func (GetTemplateVersionsVersionArrayOutput) ToGetTemplateVersionsVersionArrayOutputWithContext

func (o GetTemplateVersionsVersionArrayOutput) ToGetTemplateVersionsVersionArrayOutputWithContext(ctx context.Context) GetTemplateVersionsVersionArrayOutput

type GetTemplateVersionsVersionInput

type GetTemplateVersionsVersionInput interface {
	pulumi.Input

	ToGetTemplateVersionsVersionOutput() GetTemplateVersionsVersionOutput
	ToGetTemplateVersionsVersionOutputWithContext(context.Context) GetTemplateVersionsVersionOutput
}

GetTemplateVersionsVersionInput is an input type that accepts GetTemplateVersionsVersionArgs and GetTemplateVersionsVersionOutput values. You can construct a concrete instance of `GetTemplateVersionsVersionInput` via:

GetTemplateVersionsVersionArgs{...}

type GetTemplateVersionsVersionOutput

type GetTemplateVersionsVersionOutput struct{ *pulumi.OutputState }

func (GetTemplateVersionsVersionOutput) CreatedAt

Creation timestamp returned by the API.

func (GetTemplateVersionsVersionOutput) Description

Template description for this version.

func (GetTemplateVersionsVersionOutput) ElementType

func (GetTemplateVersionsVersionOutput) Name

Template display name for this version.

func (GetTemplateVersionsVersionOutput) TemplateType

Template type returned by the API.

func (GetTemplateVersionsVersionOutput) ToGetTemplateVersionsVersionOutput

func (o GetTemplateVersionsVersionOutput) ToGetTemplateVersionsVersionOutput() GetTemplateVersionsVersionOutput

func (GetTemplateVersionsVersionOutput) ToGetTemplateVersionsVersionOutputWithContext

func (o GetTemplateVersionsVersionOutput) ToGetTemplateVersionsVersionOutputWithContext(ctx context.Context) GetTemplateVersionsVersionOutput

func (GetTemplateVersionsVersionOutput) UpdatedAt

Update timestamp returned by the API.

func (GetTemplateVersionsVersionOutput) Version

Exact template version identifier. Represented as a decimal string to preserve int64 precision.

type ImageHtmlCss

type ImageHtmlCss struct {
	pulumi.CustomResourceState

	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrOutput `pulumi:"colorScheme"`
	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// CSS used to style the rendered HTML.
	Css pulumi.StringPtrOutput `pulumi:"css"`
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrOutput `pulumi:"deviceScale"`
	// HTML/CSS images use Twemoji by default; set true to use supplied or native emoji fonts instead.
	DisableTwemoji pulumi.BoolPtrOutput `pulumi:"disableTwemoji"`
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrOutput `pulumi:"format"`
	// Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
	GoogleFonts pulumi.StringArrayOutput `pulumi:"googleFonts"`
	// HTML to render and take a screenshot of. HTML fragments are rendered in a wrapper document unless a complete HTML document is supplied. Required for HTML image requests.
	Html pulumi.StringOutput `pulumi:"html"`
	// Rendering operation URL. Creation does not render bytes.
	ImageUrl pulumi.StringOutput `pulumi:"imageUrl"`
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrOutput `pulumi:"jumboMaxHeight"`
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrOutput `pulumi:"jumboMaxWidth"`
	// Last HCTI stored-render timestamp, when available.
	LastRenderStoredAt pulumi.StringOutput `pulumi:"lastRenderStoredAt"`
	// Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
	MaxRenderOnce pulumi.BoolPtrOutput `pulumi:"maxRenderOnce"`
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrOutput `pulumi:"maxWaitMs"`
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrOutput `pulumi:"mediaType"`
	// Custom key-value metadata stored with the image.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrOutput `pulumi:"msDelay"`
	// Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
	OgConfigContentVersion pulumi.StringOutput `pulumi:"ogConfigContentVersion"`
	// Associated OG configuration ID, if any.
	OgConfigId pulumi.StringOutput `pulumi:"ogConfigId"`
	// Rendering option.
	PdfOptions ImageHtmlCssPdfOptionsPtrOutput `pulumi:"pdfOptions"`
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrOutput `pulumi:"proxyId"`
	// Public GET rendering URL, or null when HCTI storage is disabled.
	PublicUrl pulumi.StringOutput `pulumi:"publicUrl"`
	// HTTP method required to render: GET or PUT.
	RenderMethod pulumi.StringOutput `pulumi:"renderMethod"`
	// Whether rendering requires API authentication.
	RenderRequiresAuth pulumi.BoolOutput `pulumi:"renderRequiresAuth"`
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrOutput `pulumi:"renderWhenReady"`
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides ImageHtmlCssRequestOverrideArrayOutput `pulumi:"requestOverrides"`
	// Last base-image save to custom storage, when available.
	SavedToStorageDestinationAt pulumi.StringOutput `pulumi:"savedToStorageDestinationAt"`
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrOutput `pulumi:"selector"`
	// Whether rendered output is saved only to custom storage, recorded when the image was created.
	StorageDestinationHctiStorageDisabled pulumi.BoolOutput `pulumi:"storageDestinationHctiStorageDisabled"`
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrOutput `pulumi:"storageDestinationId"`
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrOutput `pulumi:"timezone"`
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrOutput `pulumi:"transparentBackground"`
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrOutput `pulumi:"viewportHeight"`
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrOutput `pulumi:"viewportLandscape"`
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrOutput `pulumi:"viewportMobile"`
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrOutput `pulumi:"viewportTouch"`
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrOutput `pulumi:"viewportWidth"`
}

func GetImageHtmlCss

func GetImageHtmlCss(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ImageHtmlCssState, opts ...pulumi.ResourceOption) (*ImageHtmlCss, error)

GetImageHtmlCss gets an existing ImageHtmlCss resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewImageHtmlCss

func NewImageHtmlCss(ctx *pulumi.Context,
	name string, args *ImageHtmlCssArgs, opts ...pulumi.ResourceOption) (*ImageHtmlCss, error)

NewImageHtmlCss registers a new resource with the given unique name, arguments, and options.

func (*ImageHtmlCss) ElementType

func (*ImageHtmlCss) ElementType() reflect.Type

func (*ImageHtmlCss) ToImageHtmlCssOutput

func (i *ImageHtmlCss) ToImageHtmlCssOutput() ImageHtmlCssOutput

func (*ImageHtmlCss) ToImageHtmlCssOutputWithContext

func (i *ImageHtmlCss) ToImageHtmlCssOutputWithContext(ctx context.Context) ImageHtmlCssOutput

type ImageHtmlCssArgs

type ImageHtmlCssArgs struct {
	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrInput
	// CSS used to style the rendered HTML.
	Css pulumi.StringPtrInput
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrInput
	// HTML/CSS images use Twemoji by default; set true to use supplied or native emoji fonts instead.
	DisableTwemoji pulumi.BoolPtrInput
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrInput
	// Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
	GoogleFonts pulumi.StringArrayInput
	// HTML to render and take a screenshot of. HTML fragments are rendered in a wrapper document unless a complete HTML document is supplied. Required for HTML image requests.
	Html pulumi.StringInput
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrInput
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrInput
	// Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
	MaxRenderOnce pulumi.BoolPtrInput
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrInput
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrInput
	// Custom key-value metadata stored with the image.
	Metadata pulumi.StringMapInput
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrInput
	// Rendering option.
	PdfOptions ImageHtmlCssPdfOptionsPtrInput
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrInput
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrInput
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides ImageHtmlCssRequestOverrideArrayInput
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrInput
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrInput
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrInput
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrInput
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrInput
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrInput
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrInput
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrInput
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrInput
}

The set of arguments for constructing a ImageHtmlCss resource.

func (ImageHtmlCssArgs) ElementType

func (ImageHtmlCssArgs) ElementType() reflect.Type

type ImageHtmlCssInput

type ImageHtmlCssInput interface {
	pulumi.Input

	ToImageHtmlCssOutput() ImageHtmlCssOutput
	ToImageHtmlCssOutputWithContext(ctx context.Context) ImageHtmlCssOutput
}

type ImageHtmlCssOutput

type ImageHtmlCssOutput struct{ *pulumi.OutputState }

func (ImageHtmlCssOutput) ColorScheme

func (o ImageHtmlCssOutput) ColorScheme() pulumi.StringPtrOutput

Sets the preferred color scheme: light or dark.

func (ImageHtmlCssOutput) CreatedAt

func (o ImageHtmlCssOutput) CreatedAt() pulumi.StringOutput

Creation timestamp.

func (ImageHtmlCssOutput) Css

CSS used to style the rendered HTML.

func (ImageHtmlCssOutput) DeviceScale

func (o ImageHtmlCssOutput) DeviceScale() pulumi.Float64PtrOutput

Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.

func (ImageHtmlCssOutput) DisableTwemoji

func (o ImageHtmlCssOutput) DisableTwemoji() pulumi.BoolPtrOutput

HTML/CSS images use Twemoji by default; set true to use supplied or native emoji fonts instead.

func (ImageHtmlCssOutput) ElementType

func (ImageHtmlCssOutput) ElementType() reflect.Type

func (ImageHtmlCssOutput) Format

Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.

func (ImageHtmlCssOutput) GoogleFonts

Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.

func (ImageHtmlCssOutput) Html

HTML to render and take a screenshot of. HTML fragments are rendered in a wrapper document unless a complete HTML document is supplied. Required for HTML image requests.

func (ImageHtmlCssOutput) ImageUrl

func (o ImageHtmlCssOutput) ImageUrl() pulumi.StringOutput

Rendering operation URL. Creation does not render bytes.

func (ImageHtmlCssOutput) JumboMaxHeight

func (o ImageHtmlCssOutput) JumboMaxHeight() pulumi.IntPtrOutput

Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.

func (ImageHtmlCssOutput) JumboMaxWidth

func (o ImageHtmlCssOutput) JumboMaxWidth() pulumi.IntPtrOutput

Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.

func (ImageHtmlCssOutput) LastRenderStoredAt

func (o ImageHtmlCssOutput) LastRenderStoredAt() pulumi.StringOutput

Last HCTI stored-render timestamp, when available.

func (ImageHtmlCssOutput) MaxRenderOnce

func (o ImageHtmlCssOutput) MaxRenderOnce() pulumi.BoolPtrOutput

Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.

func (ImageHtmlCssOutput) MaxWaitMs

func (o ImageHtmlCssOutput) MaxWaitMs() pulumi.IntPtrOutput

Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.

func (ImageHtmlCssOutput) MediaType

CSS media type to emulate: screen or print.

func (ImageHtmlCssOutput) Metadata

Custom key-value metadata stored with the image.

func (ImageHtmlCssOutput) MsDelay

Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.

func (ImageHtmlCssOutput) OgConfigContentVersion

func (o ImageHtmlCssOutput) OgConfigContentVersion() pulumi.StringOutput

Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.

func (ImageHtmlCssOutput) OgConfigId

func (o ImageHtmlCssOutput) OgConfigId() pulumi.StringOutput

Associated OG configuration ID, if any.

func (ImageHtmlCssOutput) PdfOptions

Rendering option.

func (ImageHtmlCssOutput) ProxyId

Specifies which configured organization proxy to use when rendering.

func (ImageHtmlCssOutput) PublicUrl

func (o ImageHtmlCssOutput) PublicUrl() pulumi.StringOutput

Public GET rendering URL, or null when HCTI storage is disabled.

func (ImageHtmlCssOutput) RenderMethod

func (o ImageHtmlCssOutput) RenderMethod() pulumi.StringOutput

HTTP method required to render: GET or PUT.

func (ImageHtmlCssOutput) RenderRequiresAuth

func (o ImageHtmlCssOutput) RenderRequiresAuth() pulumi.BoolOutput

Whether rendering requires API authentication.

func (ImageHtmlCssOutput) RenderWhenReady

func (o ImageHtmlCssOutput) RenderWhenReady() pulumi.BoolPtrOutput

Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.

func (ImageHtmlCssOutput) RequestOverrides added in v0.2.0

Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.

func (ImageHtmlCssOutput) SavedToStorageDestinationAt

func (o ImageHtmlCssOutput) SavedToStorageDestinationAt() pulumi.StringOutput

Last base-image save to custom storage, when available.

func (ImageHtmlCssOutput) Selector

A CSS selector for an element in the HTML. We’ll crop the image to this specific element.

func (ImageHtmlCssOutput) StorageDestinationHctiStorageDisabled

func (o ImageHtmlCssOutput) StorageDestinationHctiStorageDisabled() pulumi.BoolOutput

Whether rendered output is saved only to custom storage, recorded when the image was created.

func (ImageHtmlCssOutput) StorageDestinationId

func (o ImageHtmlCssOutput) StorageDestinationId() pulumi.StringPtrOutput

Specifies which configured organization storage destination receives the rendered image.

func (ImageHtmlCssOutput) Timezone

Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.

func (ImageHtmlCssOutput) ToImageHtmlCssOutput

func (o ImageHtmlCssOutput) ToImageHtmlCssOutput() ImageHtmlCssOutput

func (ImageHtmlCssOutput) ToImageHtmlCssOutputWithContext

func (o ImageHtmlCssOutput) ToImageHtmlCssOutputWithContext(ctx context.Context) ImageHtmlCssOutput

func (ImageHtmlCssOutput) TransparentBackground

func (o ImageHtmlCssOutput) TransparentBackground() pulumi.BoolPtrOutput

Specifies whether the image is rendered with a transparent background.

func (ImageHtmlCssOutput) ViewportHeight

func (o ImageHtmlCssOutput) ViewportHeight() pulumi.IntPtrOutput

Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

func (ImageHtmlCssOutput) ViewportLandscape

func (o ImageHtmlCssOutput) ViewportLandscape() pulumi.BoolPtrOutput

Specifies whether the emulated viewport is in landscape orientation.

func (ImageHtmlCssOutput) ViewportMobile

func (o ImageHtmlCssOutput) ViewportMobile() pulumi.BoolPtrOutput

Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.

func (ImageHtmlCssOutput) ViewportTouch

func (o ImageHtmlCssOutput) ViewportTouch() pulumi.BoolPtrOutput

Specifies whether the emulated viewport supports touch events.

func (ImageHtmlCssOutput) ViewportWidth

func (o ImageHtmlCssOutput) ViewportWidth() pulumi.IntPtrOutput

Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

type ImageHtmlCssPdfOptions

type ImageHtmlCssPdfOptions struct {
	// PDF margins. Supply all four sides with units.
	Margins *ImageHtmlCssPdfOptionsMargins `pulumi:"margins"`
	// Page height with px, in, cm, mm, or pt units.
	PageHeight *string `pulumi:"pageHeight"`
	// Page width with px, in, cm, mm, or pt units.
	PageWidth *string `pulumi:"pageWidth"`
	// Print page backgrounds. Omission lets the API choose.
	PrintBackground *bool `pulumi:"printBackground"`
	// PDF scale from 0.1 to 2.
	Scale *float64 `pulumi:"scale"`
}

type ImageHtmlCssPdfOptionsArgs

type ImageHtmlCssPdfOptionsArgs struct {
	// PDF margins. Supply all four sides with units.
	Margins ImageHtmlCssPdfOptionsMarginsPtrInput `pulumi:"margins"`
	// Page height with px, in, cm, mm, or pt units.
	PageHeight pulumi.StringPtrInput `pulumi:"pageHeight"`
	// Page width with px, in, cm, mm, or pt units.
	PageWidth pulumi.StringPtrInput `pulumi:"pageWidth"`
	// Print page backgrounds. Omission lets the API choose.
	PrintBackground pulumi.BoolPtrInput `pulumi:"printBackground"`
	// PDF scale from 0.1 to 2.
	Scale pulumi.Float64PtrInput `pulumi:"scale"`
}

func (ImageHtmlCssPdfOptionsArgs) ElementType

func (ImageHtmlCssPdfOptionsArgs) ElementType() reflect.Type

func (ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsOutput

func (i ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsOutput() ImageHtmlCssPdfOptionsOutput

func (ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsOutputWithContext

func (i ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsOutput

func (ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsPtrOutput

func (i ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsPtrOutput() ImageHtmlCssPdfOptionsPtrOutput

func (ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsPtrOutputWithContext

func (i ImageHtmlCssPdfOptionsArgs) ToImageHtmlCssPdfOptionsPtrOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsPtrOutput

type ImageHtmlCssPdfOptionsInput

type ImageHtmlCssPdfOptionsInput interface {
	pulumi.Input

	ToImageHtmlCssPdfOptionsOutput() ImageHtmlCssPdfOptionsOutput
	ToImageHtmlCssPdfOptionsOutputWithContext(context.Context) ImageHtmlCssPdfOptionsOutput
}

ImageHtmlCssPdfOptionsInput is an input type that accepts ImageHtmlCssPdfOptionsArgs and ImageHtmlCssPdfOptionsOutput values. You can construct a concrete instance of `ImageHtmlCssPdfOptionsInput` via:

ImageHtmlCssPdfOptionsArgs{...}

type ImageHtmlCssPdfOptionsMargins

type ImageHtmlCssPdfOptionsMargins struct {
	// Margin with px, in, cm, mm, or pt units.
	Bottom string `pulumi:"bottom"`
	// Margin with px, in, cm, mm, or pt units.
	Left string `pulumi:"left"`
	// Margin with px, in, cm, mm, or pt units.
	Right string `pulumi:"right"`
	// Margin with px, in, cm, mm, or pt units.
	Top string `pulumi:"top"`
}

type ImageHtmlCssPdfOptionsMarginsArgs

type ImageHtmlCssPdfOptionsMarginsArgs struct {
	// Margin with px, in, cm, mm, or pt units.
	Bottom pulumi.StringInput `pulumi:"bottom"`
	// Margin with px, in, cm, mm, or pt units.
	Left pulumi.StringInput `pulumi:"left"`
	// Margin with px, in, cm, mm, or pt units.
	Right pulumi.StringInput `pulumi:"right"`
	// Margin with px, in, cm, mm, or pt units.
	Top pulumi.StringInput `pulumi:"top"`
}

func (ImageHtmlCssPdfOptionsMarginsArgs) ElementType

func (ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsOutput

func (i ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsOutput() ImageHtmlCssPdfOptionsMarginsOutput

func (ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsOutputWithContext

func (i ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsMarginsOutput

func (ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsPtrOutput

func (i ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsPtrOutput() ImageHtmlCssPdfOptionsMarginsPtrOutput

func (ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsPtrOutputWithContext

func (i ImageHtmlCssPdfOptionsMarginsArgs) ToImageHtmlCssPdfOptionsMarginsPtrOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsMarginsPtrOutput

type ImageHtmlCssPdfOptionsMarginsInput

type ImageHtmlCssPdfOptionsMarginsInput interface {
	pulumi.Input

	ToImageHtmlCssPdfOptionsMarginsOutput() ImageHtmlCssPdfOptionsMarginsOutput
	ToImageHtmlCssPdfOptionsMarginsOutputWithContext(context.Context) ImageHtmlCssPdfOptionsMarginsOutput
}

ImageHtmlCssPdfOptionsMarginsInput is an input type that accepts ImageHtmlCssPdfOptionsMarginsArgs and ImageHtmlCssPdfOptionsMarginsOutput values. You can construct a concrete instance of `ImageHtmlCssPdfOptionsMarginsInput` via:

ImageHtmlCssPdfOptionsMarginsArgs{...}

type ImageHtmlCssPdfOptionsMarginsOutput

type ImageHtmlCssPdfOptionsMarginsOutput struct{ *pulumi.OutputState }

func (ImageHtmlCssPdfOptionsMarginsOutput) Bottom

Margin with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsMarginsOutput) ElementType

func (ImageHtmlCssPdfOptionsMarginsOutput) Left

Margin with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsMarginsOutput) Right

Margin with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsOutput

func (o ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsOutput() ImageHtmlCssPdfOptionsMarginsOutput

func (ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsOutputWithContext

func (o ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsMarginsOutput

func (ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutput

func (o ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutput() ImageHtmlCssPdfOptionsMarginsPtrOutput

func (ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutputWithContext

func (o ImageHtmlCssPdfOptionsMarginsOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsMarginsPtrOutput

func (ImageHtmlCssPdfOptionsMarginsOutput) Top

Margin with px, in, cm, mm, or pt units.

type ImageHtmlCssPdfOptionsMarginsPtrInput

type ImageHtmlCssPdfOptionsMarginsPtrInput interface {
	pulumi.Input

	ToImageHtmlCssPdfOptionsMarginsPtrOutput() ImageHtmlCssPdfOptionsMarginsPtrOutput
	ToImageHtmlCssPdfOptionsMarginsPtrOutputWithContext(context.Context) ImageHtmlCssPdfOptionsMarginsPtrOutput
}

ImageHtmlCssPdfOptionsMarginsPtrInput is an input type that accepts ImageHtmlCssPdfOptionsMarginsArgs, ImageHtmlCssPdfOptionsMarginsPtr and ImageHtmlCssPdfOptionsMarginsPtrOutput values. You can construct a concrete instance of `ImageHtmlCssPdfOptionsMarginsPtrInput` via:

        ImageHtmlCssPdfOptionsMarginsArgs{...}

or:

        nil

type ImageHtmlCssPdfOptionsMarginsPtrOutput

type ImageHtmlCssPdfOptionsMarginsPtrOutput struct{ *pulumi.OutputState }

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) Bottom

Margin with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) Elem

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) ElementType

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) Left

Margin with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) Right

Margin with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutput

func (o ImageHtmlCssPdfOptionsMarginsPtrOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutput() ImageHtmlCssPdfOptionsMarginsPtrOutput

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutputWithContext

func (o ImageHtmlCssPdfOptionsMarginsPtrOutput) ToImageHtmlCssPdfOptionsMarginsPtrOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsMarginsPtrOutput

func (ImageHtmlCssPdfOptionsMarginsPtrOutput) Top

Margin with px, in, cm, mm, or pt units.

type ImageHtmlCssPdfOptionsOutput

type ImageHtmlCssPdfOptionsOutput struct{ *pulumi.OutputState }

func (ImageHtmlCssPdfOptionsOutput) ElementType

func (ImageHtmlCssPdfOptionsOutput) Margins

PDF margins. Supply all four sides with units.

func (ImageHtmlCssPdfOptionsOutput) PageHeight

Page height with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsOutput) PageWidth

Page width with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsOutput) PrintBackground

Print page backgrounds. Omission lets the API choose.

func (ImageHtmlCssPdfOptionsOutput) Scale

PDF scale from 0.1 to 2.

func (ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsOutput

func (o ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsOutput() ImageHtmlCssPdfOptionsOutput

func (ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsOutputWithContext

func (o ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsOutput

func (ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsPtrOutput

func (o ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsPtrOutput() ImageHtmlCssPdfOptionsPtrOutput

func (ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsPtrOutputWithContext

func (o ImageHtmlCssPdfOptionsOutput) ToImageHtmlCssPdfOptionsPtrOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsPtrOutput

type ImageHtmlCssPdfOptionsPtrInput

type ImageHtmlCssPdfOptionsPtrInput interface {
	pulumi.Input

	ToImageHtmlCssPdfOptionsPtrOutput() ImageHtmlCssPdfOptionsPtrOutput
	ToImageHtmlCssPdfOptionsPtrOutputWithContext(context.Context) ImageHtmlCssPdfOptionsPtrOutput
}

ImageHtmlCssPdfOptionsPtrInput is an input type that accepts ImageHtmlCssPdfOptionsArgs, ImageHtmlCssPdfOptionsPtr and ImageHtmlCssPdfOptionsPtrOutput values. You can construct a concrete instance of `ImageHtmlCssPdfOptionsPtrInput` via:

        ImageHtmlCssPdfOptionsArgs{...}

or:

        nil

type ImageHtmlCssPdfOptionsPtrOutput

type ImageHtmlCssPdfOptionsPtrOutput struct{ *pulumi.OutputState }

func (ImageHtmlCssPdfOptionsPtrOutput) Elem

func (ImageHtmlCssPdfOptionsPtrOutput) ElementType

func (ImageHtmlCssPdfOptionsPtrOutput) Margins

PDF margins. Supply all four sides with units.

func (ImageHtmlCssPdfOptionsPtrOutput) PageHeight

Page height with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsPtrOutput) PageWidth

Page width with px, in, cm, mm, or pt units.

func (ImageHtmlCssPdfOptionsPtrOutput) PrintBackground

Print page backgrounds. Omission lets the API choose.

func (ImageHtmlCssPdfOptionsPtrOutput) Scale

PDF scale from 0.1 to 2.

func (ImageHtmlCssPdfOptionsPtrOutput) ToImageHtmlCssPdfOptionsPtrOutput

func (o ImageHtmlCssPdfOptionsPtrOutput) ToImageHtmlCssPdfOptionsPtrOutput() ImageHtmlCssPdfOptionsPtrOutput

func (ImageHtmlCssPdfOptionsPtrOutput) ToImageHtmlCssPdfOptionsPtrOutputWithContext

func (o ImageHtmlCssPdfOptionsPtrOutput) ToImageHtmlCssPdfOptionsPtrOutputWithContext(ctx context.Context) ImageHtmlCssPdfOptionsPtrOutput

type ImageHtmlCssRequestOverride added in v0.2.0

type ImageHtmlCssRequestOverride struct {
	// Currently only `block` is supported.
	Action string `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes []RequestOverrideResourceType `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url *string `pulumi:"url"`
}

type ImageHtmlCssRequestOverrideArgs added in v0.2.0

type ImageHtmlCssRequestOverrideArgs struct {
	// Currently only `block` is supported.
	Action pulumi.StringInput `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes RequestOverrideResourceTypeArrayInput `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url pulumi.StringPtrInput `pulumi:"url"`
}

func (ImageHtmlCssRequestOverrideArgs) ElementType added in v0.2.0

func (ImageHtmlCssRequestOverrideArgs) ToImageHtmlCssRequestOverrideOutput added in v0.2.0

func (i ImageHtmlCssRequestOverrideArgs) ToImageHtmlCssRequestOverrideOutput() ImageHtmlCssRequestOverrideOutput

func (ImageHtmlCssRequestOverrideArgs) ToImageHtmlCssRequestOverrideOutputWithContext added in v0.2.0

func (i ImageHtmlCssRequestOverrideArgs) ToImageHtmlCssRequestOverrideOutputWithContext(ctx context.Context) ImageHtmlCssRequestOverrideOutput

type ImageHtmlCssRequestOverrideArray added in v0.2.0

type ImageHtmlCssRequestOverrideArray []ImageHtmlCssRequestOverrideInput

func (ImageHtmlCssRequestOverrideArray) ElementType added in v0.2.0

func (ImageHtmlCssRequestOverrideArray) ToImageHtmlCssRequestOverrideArrayOutput added in v0.2.0

func (i ImageHtmlCssRequestOverrideArray) ToImageHtmlCssRequestOverrideArrayOutput() ImageHtmlCssRequestOverrideArrayOutput

func (ImageHtmlCssRequestOverrideArray) ToImageHtmlCssRequestOverrideArrayOutputWithContext added in v0.2.0

func (i ImageHtmlCssRequestOverrideArray) ToImageHtmlCssRequestOverrideArrayOutputWithContext(ctx context.Context) ImageHtmlCssRequestOverrideArrayOutput

type ImageHtmlCssRequestOverrideArrayInput added in v0.2.0

type ImageHtmlCssRequestOverrideArrayInput interface {
	pulumi.Input

	ToImageHtmlCssRequestOverrideArrayOutput() ImageHtmlCssRequestOverrideArrayOutput
	ToImageHtmlCssRequestOverrideArrayOutputWithContext(context.Context) ImageHtmlCssRequestOverrideArrayOutput
}

ImageHtmlCssRequestOverrideArrayInput is an input type that accepts ImageHtmlCssRequestOverrideArray and ImageHtmlCssRequestOverrideArrayOutput values. You can construct a concrete instance of `ImageHtmlCssRequestOverrideArrayInput` via:

ImageHtmlCssRequestOverrideArray{ ImageHtmlCssRequestOverrideArgs{...} }

type ImageHtmlCssRequestOverrideArrayOutput added in v0.2.0

type ImageHtmlCssRequestOverrideArrayOutput struct{ *pulumi.OutputState }

func (ImageHtmlCssRequestOverrideArrayOutput) ElementType added in v0.2.0

func (ImageHtmlCssRequestOverrideArrayOutput) Index added in v0.2.0

func (ImageHtmlCssRequestOverrideArrayOutput) ToImageHtmlCssRequestOverrideArrayOutput added in v0.2.0

func (o ImageHtmlCssRequestOverrideArrayOutput) ToImageHtmlCssRequestOverrideArrayOutput() ImageHtmlCssRequestOverrideArrayOutput

func (ImageHtmlCssRequestOverrideArrayOutput) ToImageHtmlCssRequestOverrideArrayOutputWithContext added in v0.2.0

func (o ImageHtmlCssRequestOverrideArrayOutput) ToImageHtmlCssRequestOverrideArrayOutputWithContext(ctx context.Context) ImageHtmlCssRequestOverrideArrayOutput

type ImageHtmlCssRequestOverrideInput added in v0.2.0

type ImageHtmlCssRequestOverrideInput interface {
	pulumi.Input

	ToImageHtmlCssRequestOverrideOutput() ImageHtmlCssRequestOverrideOutput
	ToImageHtmlCssRequestOverrideOutputWithContext(context.Context) ImageHtmlCssRequestOverrideOutput
}

ImageHtmlCssRequestOverrideInput is an input type that accepts ImageHtmlCssRequestOverrideArgs and ImageHtmlCssRequestOverrideOutput values. You can construct a concrete instance of `ImageHtmlCssRequestOverrideInput` via:

ImageHtmlCssRequestOverrideArgs{...}

type ImageHtmlCssRequestOverrideOutput added in v0.2.0

type ImageHtmlCssRequestOverrideOutput struct{ *pulumi.OutputState }

func (ImageHtmlCssRequestOverrideOutput) Action added in v0.2.0

Currently only `block` is supported.

func (ImageHtmlCssRequestOverrideOutput) ElementType added in v0.2.0

func (ImageHtmlCssRequestOverrideOutput) ResourceTypes added in v0.2.0

Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.

func (ImageHtmlCssRequestOverrideOutput) ToImageHtmlCssRequestOverrideOutput added in v0.2.0

func (o ImageHtmlCssRequestOverrideOutput) ToImageHtmlCssRequestOverrideOutput() ImageHtmlCssRequestOverrideOutput

func (ImageHtmlCssRequestOverrideOutput) ToImageHtmlCssRequestOverrideOutputWithContext added in v0.2.0

func (o ImageHtmlCssRequestOverrideOutput) ToImageHtmlCssRequestOverrideOutputWithContext(ctx context.Context) ImageHtmlCssRequestOverrideOutput

func (ImageHtmlCssRequestOverrideOutput) Url added in v0.2.0

Case-sensitive URL wildcard pattern using `*`; at most 512 characters.

type ImageHtmlCssState

type ImageHtmlCssState struct {
	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrInput
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// CSS used to style the rendered HTML.
	Css pulumi.StringPtrInput
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrInput
	// HTML/CSS images use Twemoji by default; set true to use supplied or native emoji fonts instead.
	DisableTwemoji pulumi.BoolPtrInput
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrInput
	// Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
	GoogleFonts pulumi.StringArrayInput
	// HTML to render and take a screenshot of. HTML fragments are rendered in a wrapper document unless a complete HTML document is supplied. Required for HTML image requests.
	Html pulumi.StringPtrInput
	// Rendering operation URL. Creation does not render bytes.
	ImageUrl pulumi.StringPtrInput
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrInput
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrInput
	// Last HCTI stored-render timestamp, when available.
	LastRenderStoredAt pulumi.StringPtrInput
	// Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
	MaxRenderOnce pulumi.BoolPtrInput
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrInput
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrInput
	// Custom key-value metadata stored with the image.
	Metadata pulumi.StringMapInput
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrInput
	// Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
	OgConfigContentVersion pulumi.StringPtrInput
	// Associated OG configuration ID, if any.
	OgConfigId pulumi.StringPtrInput
	// Rendering option.
	PdfOptions ImageHtmlCssPdfOptionsPtrInput
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrInput
	// Public GET rendering URL, or null when HCTI storage is disabled.
	PublicUrl pulumi.StringPtrInput
	// HTTP method required to render: GET or PUT.
	RenderMethod pulumi.StringPtrInput
	// Whether rendering requires API authentication.
	RenderRequiresAuth pulumi.BoolPtrInput
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrInput
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides ImageHtmlCssRequestOverrideArrayInput
	// Last base-image save to custom storage, when available.
	SavedToStorageDestinationAt pulumi.StringPtrInput
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrInput
	// Whether rendered output is saved only to custom storage, recorded when the image was created.
	StorageDestinationHctiStorageDisabled pulumi.BoolPtrInput
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrInput
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrInput
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrInput
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrInput
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrInput
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrInput
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrInput
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrInput
}

func (ImageHtmlCssState) ElementType

func (ImageHtmlCssState) ElementType() reflect.Type

type ImageTemplated

type ImageTemplated struct {
	pulumi.CustomResourceState

	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrOutput `pulumi:"format"`
	// Rendering operation URL. Creation does not render bytes.
	ImageUrl pulumi.StringOutput `pulumi:"imageUrl"`
	// Last HCTI stored-render timestamp, when available.
	LastRenderStoredAt pulumi.StringOutput `pulumi:"lastRenderStoredAt"`
	// Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
	OgConfigContentVersion pulumi.StringOutput `pulumi:"ogConfigContentVersion"`
	// Associated OG configuration ID, if any.
	OgConfigId pulumi.StringOutput `pulumi:"ogConfigId"`
	// Public GET rendering URL, or null when HCTI storage is disabled.
	PublicUrl pulumi.StringOutput `pulumi:"publicUrl"`
	// HTTP method required to render: GET or PUT.
	RenderMethod pulumi.StringOutput `pulumi:"renderMethod"`
	// Whether rendering requires API authentication.
	RenderRequiresAuth pulumi.BoolOutput `pulumi:"renderRequiresAuth"`
	// Actual template version used at creation; does not pin an omitted template_version. Represented as a decimal string in Pulumi to preserve int64 precision.
	ResolvedTemplateVersion pulumi.StringOutput `pulumi:"resolvedTemplateVersion"`
	// Last base-image save to custom storage, when available.
	SavedToStorageDestinationAt pulumi.StringOutput `pulumi:"savedToStorageDestinationAt"`
	// Whether rendered output is saved only to custom storage, recorded when the image was created.
	StorageDestinationHctiStorageDisabled pulumi.BoolOutput `pulumi:"storageDestinationHctiStorageDisabled"`
	// Template ID including the t- prefix.
	TemplateId pulumi.StringOutput `pulumi:"templateId"`
	// Values substituted into the template for this render. Must be a non-empty JSON object. Include the values needed by the template.
	TemplateValues pulumi.StringOutput `pulumi:"templateValues"`
	// Optional version to pin. Omission selects the latest version when creating the image. Represented as a decimal string in Pulumi to preserve int64 precision.
	TemplateVersion pulumi.StringPtrOutput `pulumi:"templateVersion"`
}

func GetImageTemplated

func GetImageTemplated(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ImageTemplatedState, opts ...pulumi.ResourceOption) (*ImageTemplated, error)

GetImageTemplated gets an existing ImageTemplated resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewImageTemplated

func NewImageTemplated(ctx *pulumi.Context,
	name string, args *ImageTemplatedArgs, opts ...pulumi.ResourceOption) (*ImageTemplated, error)

NewImageTemplated registers a new resource with the given unique name, arguments, and options.

func (*ImageTemplated) ElementType

func (*ImageTemplated) ElementType() reflect.Type

func (*ImageTemplated) ToImageTemplatedOutput

func (i *ImageTemplated) ToImageTemplatedOutput() ImageTemplatedOutput

func (*ImageTemplated) ToImageTemplatedOutputWithContext

func (i *ImageTemplated) ToImageTemplatedOutputWithContext(ctx context.Context) ImageTemplatedOutput

type ImageTemplatedArgs

type ImageTemplatedArgs struct {
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrInput
	// Template ID including the t- prefix.
	TemplateId pulumi.StringInput
	// Values substituted into the template for this render. Must be a non-empty JSON object. Include the values needed by the template.
	TemplateValues pulumi.StringInput
	// Optional version to pin. Omission selects the latest version when creating the image. Represented as a decimal string in Pulumi to preserve int64 precision.
	TemplateVersion pulumi.StringPtrInput
}

The set of arguments for constructing a ImageTemplated resource.

func (ImageTemplatedArgs) ElementType

func (ImageTemplatedArgs) ElementType() reflect.Type

type ImageTemplatedInput

type ImageTemplatedInput interface {
	pulumi.Input

	ToImageTemplatedOutput() ImageTemplatedOutput
	ToImageTemplatedOutputWithContext(ctx context.Context) ImageTemplatedOutput
}

type ImageTemplatedOutput

type ImageTemplatedOutput struct{ *pulumi.OutputState }

func (ImageTemplatedOutput) CreatedAt

Creation timestamp.

func (ImageTemplatedOutput) ElementType

func (ImageTemplatedOutput) ElementType() reflect.Type

func (ImageTemplatedOutput) Format

Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.

func (ImageTemplatedOutput) ImageUrl

Rendering operation URL. Creation does not render bytes.

func (ImageTemplatedOutput) LastRenderStoredAt

func (o ImageTemplatedOutput) LastRenderStoredAt() pulumi.StringOutput

Last HCTI stored-render timestamp, when available.

func (ImageTemplatedOutput) OgConfigContentVersion

func (o ImageTemplatedOutput) OgConfigContentVersion() pulumi.StringOutput

Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.

func (ImageTemplatedOutput) OgConfigId

func (o ImageTemplatedOutput) OgConfigId() pulumi.StringOutput

Associated OG configuration ID, if any.

func (ImageTemplatedOutput) PublicUrl

Public GET rendering URL, or null when HCTI storage is disabled.

func (ImageTemplatedOutput) RenderMethod

func (o ImageTemplatedOutput) RenderMethod() pulumi.StringOutput

HTTP method required to render: GET or PUT.

func (ImageTemplatedOutput) RenderRequiresAuth

func (o ImageTemplatedOutput) RenderRequiresAuth() pulumi.BoolOutput

Whether rendering requires API authentication.

func (ImageTemplatedOutput) ResolvedTemplateVersion

func (o ImageTemplatedOutput) ResolvedTemplateVersion() pulumi.StringOutput

Actual template version used at creation; does not pin an omitted template_version. Represented as a decimal string in Pulumi to preserve int64 precision.

func (ImageTemplatedOutput) SavedToStorageDestinationAt

func (o ImageTemplatedOutput) SavedToStorageDestinationAt() pulumi.StringOutput

Last base-image save to custom storage, when available.

func (ImageTemplatedOutput) StorageDestinationHctiStorageDisabled

func (o ImageTemplatedOutput) StorageDestinationHctiStorageDisabled() pulumi.BoolOutput

Whether rendered output is saved only to custom storage, recorded when the image was created.

func (ImageTemplatedOutput) TemplateId

func (o ImageTemplatedOutput) TemplateId() pulumi.StringOutput

Template ID including the t- prefix.

func (ImageTemplatedOutput) TemplateValues

func (o ImageTemplatedOutput) TemplateValues() pulumi.StringOutput

Values substituted into the template for this render. Must be a non-empty JSON object. Include the values needed by the template.

func (ImageTemplatedOutput) TemplateVersion

func (o ImageTemplatedOutput) TemplateVersion() pulumi.StringPtrOutput

Optional version to pin. Omission selects the latest version when creating the image. Represented as a decimal string in Pulumi to preserve int64 precision.

func (ImageTemplatedOutput) ToImageTemplatedOutput

func (o ImageTemplatedOutput) ToImageTemplatedOutput() ImageTemplatedOutput

func (ImageTemplatedOutput) ToImageTemplatedOutputWithContext

func (o ImageTemplatedOutput) ToImageTemplatedOutputWithContext(ctx context.Context) ImageTemplatedOutput

type ImageTemplatedState

type ImageTemplatedState struct {
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrInput
	// Rendering operation URL. Creation does not render bytes.
	ImageUrl pulumi.StringPtrInput
	// Last HCTI stored-render timestamp, when available.
	LastRenderStoredAt pulumi.StringPtrInput
	// Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
	OgConfigContentVersion pulumi.StringPtrInput
	// Associated OG configuration ID, if any.
	OgConfigId pulumi.StringPtrInput
	// Public GET rendering URL, or null when HCTI storage is disabled.
	PublicUrl pulumi.StringPtrInput
	// HTTP method required to render: GET or PUT.
	RenderMethod pulumi.StringPtrInput
	// Whether rendering requires API authentication.
	RenderRequiresAuth pulumi.BoolPtrInput
	// Actual template version used at creation; does not pin an omitted template_version. Represented as a decimal string in Pulumi to preserve int64 precision.
	ResolvedTemplateVersion pulumi.StringPtrInput
	// Last base-image save to custom storage, when available.
	SavedToStorageDestinationAt pulumi.StringPtrInput
	// Whether rendered output is saved only to custom storage, recorded when the image was created.
	StorageDestinationHctiStorageDisabled pulumi.BoolPtrInput
	// Template ID including the t- prefix.
	TemplateId pulumi.StringPtrInput
	// Values substituted into the template for this render. Must be a non-empty JSON object. Include the values needed by the template.
	TemplateValues pulumi.StringPtrInput
	// Optional version to pin. Omission selects the latest version when creating the image. Represented as a decimal string in Pulumi to preserve int64 precision.
	TemplateVersion pulumi.StringPtrInput
}

func (ImageTemplatedState) ElementType

func (ImageTemplatedState) ElementType() reflect.Type

type ImageUrl

type ImageUrl struct {
	pulumi.CustomResourceState

	// Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored. For GET and form-encoded requests, repeat this parameter for each origin.
	AdditionalHeaderOrigins pulumi.StringArrayOutput `pulumi:"additionalHeaderOrigins"`
	// Attempt to block cookie/consent banners from displaying.
	BlockConsentBanners pulumi.BoolPtrOutput `pulumi:"blockConsentBanners"`
	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrOutput `pulumi:"colorScheme"`
	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// CSS injected into the loaded URL to override styles on the page.
	Css pulumi.StringPtrOutput `pulumi:"css"`
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrOutput `pulumi:"deviceScale"`
	// Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
	DisableTwemoji pulumi.BoolPtrOutput `pulumi:"disableTwemoji"`
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrOutput `pulumi:"format"`
	// Take a screenshot of the entire screen after scrolling down and back to the top.
	FullScreen pulumi.BoolPtrOutput `pulumi:"fullScreen"`
	// HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes. For GET and form-encoded requests, repeat this parameter using the format `headers=name:value`.
	Headers pulumi.StringMapOutput `pulumi:"headers"`
	// Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
	IdentifyAsHcti pulumi.BoolPtrOutput `pulumi:"identifyAsHcti"`
	// Rendering operation URL. Creation does not render bytes.
	ImageUrl pulumi.StringOutput `pulumi:"imageUrl"`
	// Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
	IncludeHeadersOnSubrequests pulumi.BoolPtrOutput `pulumi:"includeHeadersOnSubrequests"`
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrOutput `pulumi:"jumboMaxHeight"`
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrOutput `pulumi:"jumboMaxWidth"`
	// Last HCTI stored-render timestamp, when available.
	LastRenderStoredAt pulumi.StringOutput `pulumi:"lastRenderStoredAt"`
	// Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
	MaxRenderOnce pulumi.BoolPtrOutput `pulumi:"maxRenderOnce"`
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrOutput `pulumi:"maxWaitMs"`
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrOutput `pulumi:"mediaType"`
	// Custom key-value metadata stored with the image.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrOutput `pulumi:"msDelay"`
	// Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
	OgConfigContentVersion pulumi.StringOutput `pulumi:"ogConfigContentVersion"`
	// Associated OG configuration ID, if any.
	OgConfigId pulumi.StringOutput `pulumi:"ogConfigId"`
	// Rendering option.
	PdfOptions ImageUrlPdfOptionsPtrOutput `pulumi:"pdfOptions"`
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrOutput `pulumi:"proxyId"`
	// Public GET rendering URL, or null when HCTI storage is disabled.
	PublicUrl pulumi.StringOutput `pulumi:"publicUrl"`
	// HTTP method required to render: GET or PUT.
	RenderMethod pulumi.StringOutput `pulumi:"renderMethod"`
	// Whether rendering requires API authentication.
	RenderRequiresAuth pulumi.BoolOutput `pulumi:"renderRequiresAuth"`
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrOutput `pulumi:"renderWhenReady"`
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides ImageUrlRequestOverrideArrayOutput `pulumi:"requestOverrides"`
	// Last base-image save to custom storage, when available.
	SavedToStorageDestinationAt pulumi.StringOutput `pulumi:"savedToStorageDestinationAt"`
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrOutput `pulumi:"selector"`
	// Whether rendered output is saved only to custom storage, recorded when the image was created.
	StorageDestinationHctiStorageDisabled pulumi.BoolOutput `pulumi:"storageDestinationHctiStorageDisabled"`
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrOutput `pulumi:"storageDestinationId"`
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrOutput `pulumi:"timezone"`
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrOutput `pulumi:"transparentBackground"`
	// Public HTTP or HTTPS URL to capture. Required for URL image requests.
	Url pulumi.StringOutput `pulumi:"url"`
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrOutput `pulumi:"viewportHeight"`
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrOutput `pulumi:"viewportLandscape"`
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrOutput `pulumi:"viewportMobile"`
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrOutput `pulumi:"viewportTouch"`
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrOutput `pulumi:"viewportWidth"`
}

func GetImageUrl

func GetImageUrl(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ImageUrlState, opts ...pulumi.ResourceOption) (*ImageUrl, error)

GetImageUrl gets an existing ImageUrl resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewImageUrl

func NewImageUrl(ctx *pulumi.Context,
	name string, args *ImageUrlArgs, opts ...pulumi.ResourceOption) (*ImageUrl, error)

NewImageUrl registers a new resource with the given unique name, arguments, and options.

func (*ImageUrl) ElementType

func (*ImageUrl) ElementType() reflect.Type

func (*ImageUrl) ToImageUrlOutput

func (i *ImageUrl) ToImageUrlOutput() ImageUrlOutput

func (*ImageUrl) ToImageUrlOutputWithContext

func (i *ImageUrl) ToImageUrlOutputWithContext(ctx context.Context) ImageUrlOutput

type ImageUrlArgs

type ImageUrlArgs struct {
	// Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored. For GET and form-encoded requests, repeat this parameter for each origin.
	AdditionalHeaderOrigins pulumi.StringArrayInput
	// Attempt to block cookie/consent banners from displaying.
	BlockConsentBanners pulumi.BoolPtrInput
	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrInput
	// CSS injected into the loaded URL to override styles on the page.
	Css pulumi.StringPtrInput
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrInput
	// Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
	DisableTwemoji pulumi.BoolPtrInput
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrInput
	// Take a screenshot of the entire screen after scrolling down and back to the top.
	FullScreen pulumi.BoolPtrInput
	// HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes. For GET and form-encoded requests, repeat this parameter using the format `headers=name:value`.
	Headers pulumi.StringMapInput
	// Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
	IdentifyAsHcti pulumi.BoolPtrInput
	// Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
	IncludeHeadersOnSubrequests pulumi.BoolPtrInput
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrInput
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrInput
	// Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
	MaxRenderOnce pulumi.BoolPtrInput
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrInput
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrInput
	// Custom key-value metadata stored with the image.
	Metadata pulumi.StringMapInput
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrInput
	// Rendering option.
	PdfOptions ImageUrlPdfOptionsPtrInput
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrInput
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrInput
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides ImageUrlRequestOverrideArrayInput
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrInput
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrInput
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrInput
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrInput
	// Public HTTP or HTTPS URL to capture. Required for URL image requests.
	Url pulumi.StringInput
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrInput
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrInput
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrInput
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrInput
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrInput
}

The set of arguments for constructing a ImageUrl resource.

func (ImageUrlArgs) ElementType

func (ImageUrlArgs) ElementType() reflect.Type

type ImageUrlInput

type ImageUrlInput interface {
	pulumi.Input

	ToImageUrlOutput() ImageUrlOutput
	ToImageUrlOutputWithContext(ctx context.Context) ImageUrlOutput
}

type ImageUrlOutput

type ImageUrlOutput struct{ *pulumi.OutputState }

func (ImageUrlOutput) AdditionalHeaderOrigins

func (o ImageUrlOutput) AdditionalHeaderOrigins() pulumi.StringArrayOutput

Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored. For GET and form-encoded requests, repeat this parameter for each origin.

func (ImageUrlOutput) BlockConsentBanners

func (o ImageUrlOutput) BlockConsentBanners() pulumi.BoolPtrOutput

Attempt to block cookie/consent banners from displaying.

func (ImageUrlOutput) ColorScheme

func (o ImageUrlOutput) ColorScheme() pulumi.StringPtrOutput

Sets the preferred color scheme: light or dark.

func (ImageUrlOutput) CreatedAt

func (o ImageUrlOutput) CreatedAt() pulumi.StringOutput

Creation timestamp.

func (ImageUrlOutput) Css

CSS injected into the loaded URL to override styles on the page.

func (ImageUrlOutput) DeviceScale

func (o ImageUrlOutput) DeviceScale() pulumi.Float64PtrOutput

Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.

func (ImageUrlOutput) DisableTwemoji

func (o ImageUrlOutput) DisableTwemoji() pulumi.BoolPtrOutput

Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.

func (ImageUrlOutput) ElementType

func (ImageUrlOutput) ElementType() reflect.Type

func (ImageUrlOutput) Format

Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.

func (ImageUrlOutput) FullScreen

func (o ImageUrlOutput) FullScreen() pulumi.BoolPtrOutput

Take a screenshot of the entire screen after scrolling down and back to the top.

func (ImageUrlOutput) Headers

HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes. For GET and form-encoded requests, repeat this parameter using the format `headers=name:value`.

func (ImageUrlOutput) IdentifyAsHcti

func (o ImageUrlOutput) IdentifyAsHcti() pulumi.BoolPtrOutput

Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.

func (ImageUrlOutput) ImageUrl

func (o ImageUrlOutput) ImageUrl() pulumi.StringOutput

Rendering operation URL. Creation does not render bytes.

func (ImageUrlOutput) IncludeHeadersOnSubrequests

func (o ImageUrlOutput) IncludeHeadersOnSubrequests() pulumi.BoolPtrOutput

Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.

func (ImageUrlOutput) JumboMaxHeight

func (o ImageUrlOutput) JumboMaxHeight() pulumi.IntPtrOutput

Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.

func (ImageUrlOutput) JumboMaxWidth

func (o ImageUrlOutput) JumboMaxWidth() pulumi.IntPtrOutput

Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.

func (ImageUrlOutput) LastRenderStoredAt

func (o ImageUrlOutput) LastRenderStoredAt() pulumi.StringOutput

Last HCTI stored-render timestamp, when available.

func (ImageUrlOutput) MaxRenderOnce

func (o ImageUrlOutput) MaxRenderOnce() pulumi.BoolPtrOutput

Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.

func (ImageUrlOutput) MaxWaitMs

func (o ImageUrlOutput) MaxWaitMs() pulumi.IntPtrOutput

Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.

func (ImageUrlOutput) MediaType

func (o ImageUrlOutput) MediaType() pulumi.StringPtrOutput

CSS media type to emulate: screen or print.

func (ImageUrlOutput) Metadata

func (o ImageUrlOutput) Metadata() pulumi.StringMapOutput

Custom key-value metadata stored with the image.

func (ImageUrlOutput) MsDelay

func (o ImageUrlOutput) MsDelay() pulumi.IntPtrOutput

Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.

func (ImageUrlOutput) OgConfigContentVersion

func (o ImageUrlOutput) OgConfigContentVersion() pulumi.StringOutput

Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.

func (ImageUrlOutput) OgConfigId

func (o ImageUrlOutput) OgConfigId() pulumi.StringOutput

Associated OG configuration ID, if any.

func (ImageUrlOutput) PdfOptions

Rendering option.

func (ImageUrlOutput) ProxyId

Specifies which configured organization proxy to use when rendering.

func (ImageUrlOutput) PublicUrl

func (o ImageUrlOutput) PublicUrl() pulumi.StringOutput

Public GET rendering URL, or null when HCTI storage is disabled.

func (ImageUrlOutput) RenderMethod

func (o ImageUrlOutput) RenderMethod() pulumi.StringOutput

HTTP method required to render: GET or PUT.

func (ImageUrlOutput) RenderRequiresAuth

func (o ImageUrlOutput) RenderRequiresAuth() pulumi.BoolOutput

Whether rendering requires API authentication.

func (ImageUrlOutput) RenderWhenReady

func (o ImageUrlOutput) RenderWhenReady() pulumi.BoolPtrOutput

Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.

func (ImageUrlOutput) RequestOverrides added in v0.2.0

Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.

func (ImageUrlOutput) SavedToStorageDestinationAt

func (o ImageUrlOutput) SavedToStorageDestinationAt() pulumi.StringOutput

Last base-image save to custom storage, when available.

func (ImageUrlOutput) Selector

func (o ImageUrlOutput) Selector() pulumi.StringPtrOutput

A CSS selector for an element in the HTML. We’ll crop the image to this specific element.

func (ImageUrlOutput) StorageDestinationHctiStorageDisabled

func (o ImageUrlOutput) StorageDestinationHctiStorageDisabled() pulumi.BoolOutput

Whether rendered output is saved only to custom storage, recorded when the image was created.

func (ImageUrlOutput) StorageDestinationId

func (o ImageUrlOutput) StorageDestinationId() pulumi.StringPtrOutput

Specifies which configured organization storage destination receives the rendered image.

func (ImageUrlOutput) Timezone

func (o ImageUrlOutput) Timezone() pulumi.StringPtrOutput

Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.

func (ImageUrlOutput) ToImageUrlOutput

func (o ImageUrlOutput) ToImageUrlOutput() ImageUrlOutput

func (ImageUrlOutput) ToImageUrlOutputWithContext

func (o ImageUrlOutput) ToImageUrlOutputWithContext(ctx context.Context) ImageUrlOutput

func (ImageUrlOutput) TransparentBackground

func (o ImageUrlOutput) TransparentBackground() pulumi.BoolPtrOutput

Specifies whether the image is rendered with a transparent background.

func (ImageUrlOutput) Url

Public HTTP or HTTPS URL to capture. Required for URL image requests.

func (ImageUrlOutput) ViewportHeight

func (o ImageUrlOutput) ViewportHeight() pulumi.IntPtrOutput

Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

func (ImageUrlOutput) ViewportLandscape

func (o ImageUrlOutput) ViewportLandscape() pulumi.BoolPtrOutput

Specifies whether the emulated viewport is in landscape orientation.

func (ImageUrlOutput) ViewportMobile

func (o ImageUrlOutput) ViewportMobile() pulumi.BoolPtrOutput

Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.

func (ImageUrlOutput) ViewportTouch

func (o ImageUrlOutput) ViewportTouch() pulumi.BoolPtrOutput

Specifies whether the emulated viewport supports touch events.

func (ImageUrlOutput) ViewportWidth

func (o ImageUrlOutput) ViewportWidth() pulumi.IntPtrOutput

Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

type ImageUrlPdfOptions

type ImageUrlPdfOptions struct {
	// PDF margins. Supply all four sides with units.
	Margins *ImageUrlPdfOptionsMargins `pulumi:"margins"`
	// Page height with px, in, cm, mm, or pt units.
	PageHeight *string `pulumi:"pageHeight"`
	// Page width with px, in, cm, mm, or pt units.
	PageWidth *string `pulumi:"pageWidth"`
	// Print page backgrounds. Omission lets the API choose.
	PrintBackground *bool `pulumi:"printBackground"`
	// PDF scale from 0.1 to 2.
	Scale *float64 `pulumi:"scale"`
}

type ImageUrlPdfOptionsArgs

type ImageUrlPdfOptionsArgs struct {
	// PDF margins. Supply all four sides with units.
	Margins ImageUrlPdfOptionsMarginsPtrInput `pulumi:"margins"`
	// Page height with px, in, cm, mm, or pt units.
	PageHeight pulumi.StringPtrInput `pulumi:"pageHeight"`
	// Page width with px, in, cm, mm, or pt units.
	PageWidth pulumi.StringPtrInput `pulumi:"pageWidth"`
	// Print page backgrounds. Omission lets the API choose.
	PrintBackground pulumi.BoolPtrInput `pulumi:"printBackground"`
	// PDF scale from 0.1 to 2.
	Scale pulumi.Float64PtrInput `pulumi:"scale"`
}

func (ImageUrlPdfOptionsArgs) ElementType

func (ImageUrlPdfOptionsArgs) ElementType() reflect.Type

func (ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsOutput

func (i ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsOutput() ImageUrlPdfOptionsOutput

func (ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsOutputWithContext

func (i ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsOutputWithContext(ctx context.Context) ImageUrlPdfOptionsOutput

func (ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsPtrOutput

func (i ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsPtrOutput() ImageUrlPdfOptionsPtrOutput

func (ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsPtrOutputWithContext

func (i ImageUrlPdfOptionsArgs) ToImageUrlPdfOptionsPtrOutputWithContext(ctx context.Context) ImageUrlPdfOptionsPtrOutput

type ImageUrlPdfOptionsInput

type ImageUrlPdfOptionsInput interface {
	pulumi.Input

	ToImageUrlPdfOptionsOutput() ImageUrlPdfOptionsOutput
	ToImageUrlPdfOptionsOutputWithContext(context.Context) ImageUrlPdfOptionsOutput
}

ImageUrlPdfOptionsInput is an input type that accepts ImageUrlPdfOptionsArgs and ImageUrlPdfOptionsOutput values. You can construct a concrete instance of `ImageUrlPdfOptionsInput` via:

ImageUrlPdfOptionsArgs{...}

type ImageUrlPdfOptionsMargins

type ImageUrlPdfOptionsMargins struct {
	// Margin with px, in, cm, mm, or pt units.
	Bottom string `pulumi:"bottom"`
	// Margin with px, in, cm, mm, or pt units.
	Left string `pulumi:"left"`
	// Margin with px, in, cm, mm, or pt units.
	Right string `pulumi:"right"`
	// Margin with px, in, cm, mm, or pt units.
	Top string `pulumi:"top"`
}

type ImageUrlPdfOptionsMarginsArgs

type ImageUrlPdfOptionsMarginsArgs struct {
	// Margin with px, in, cm, mm, or pt units.
	Bottom pulumi.StringInput `pulumi:"bottom"`
	// Margin with px, in, cm, mm, or pt units.
	Left pulumi.StringInput `pulumi:"left"`
	// Margin with px, in, cm, mm, or pt units.
	Right pulumi.StringInput `pulumi:"right"`
	// Margin with px, in, cm, mm, or pt units.
	Top pulumi.StringInput `pulumi:"top"`
}

func (ImageUrlPdfOptionsMarginsArgs) ElementType

func (ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsOutput

func (i ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsOutput() ImageUrlPdfOptionsMarginsOutput

func (ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsOutputWithContext

func (i ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsOutputWithContext(ctx context.Context) ImageUrlPdfOptionsMarginsOutput

func (ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsPtrOutput

func (i ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsPtrOutput() ImageUrlPdfOptionsMarginsPtrOutput

func (ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsPtrOutputWithContext

func (i ImageUrlPdfOptionsMarginsArgs) ToImageUrlPdfOptionsMarginsPtrOutputWithContext(ctx context.Context) ImageUrlPdfOptionsMarginsPtrOutput

type ImageUrlPdfOptionsMarginsInput

type ImageUrlPdfOptionsMarginsInput interface {
	pulumi.Input

	ToImageUrlPdfOptionsMarginsOutput() ImageUrlPdfOptionsMarginsOutput
	ToImageUrlPdfOptionsMarginsOutputWithContext(context.Context) ImageUrlPdfOptionsMarginsOutput
}

ImageUrlPdfOptionsMarginsInput is an input type that accepts ImageUrlPdfOptionsMarginsArgs and ImageUrlPdfOptionsMarginsOutput values. You can construct a concrete instance of `ImageUrlPdfOptionsMarginsInput` via:

ImageUrlPdfOptionsMarginsArgs{...}

type ImageUrlPdfOptionsMarginsOutput

type ImageUrlPdfOptionsMarginsOutput struct{ *pulumi.OutputState }

func (ImageUrlPdfOptionsMarginsOutput) Bottom

Margin with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsMarginsOutput) ElementType

func (ImageUrlPdfOptionsMarginsOutput) Left

Margin with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsMarginsOutput) Right

Margin with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsOutput

func (o ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsOutput() ImageUrlPdfOptionsMarginsOutput

func (ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsOutputWithContext

func (o ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsOutputWithContext(ctx context.Context) ImageUrlPdfOptionsMarginsOutput

func (ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsPtrOutput

func (o ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsPtrOutput() ImageUrlPdfOptionsMarginsPtrOutput

func (ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsPtrOutputWithContext

func (o ImageUrlPdfOptionsMarginsOutput) ToImageUrlPdfOptionsMarginsPtrOutputWithContext(ctx context.Context) ImageUrlPdfOptionsMarginsPtrOutput

func (ImageUrlPdfOptionsMarginsOutput) Top

Margin with px, in, cm, mm, or pt units.

type ImageUrlPdfOptionsMarginsPtrInput

type ImageUrlPdfOptionsMarginsPtrInput interface {
	pulumi.Input

	ToImageUrlPdfOptionsMarginsPtrOutput() ImageUrlPdfOptionsMarginsPtrOutput
	ToImageUrlPdfOptionsMarginsPtrOutputWithContext(context.Context) ImageUrlPdfOptionsMarginsPtrOutput
}

ImageUrlPdfOptionsMarginsPtrInput is an input type that accepts ImageUrlPdfOptionsMarginsArgs, ImageUrlPdfOptionsMarginsPtr and ImageUrlPdfOptionsMarginsPtrOutput values. You can construct a concrete instance of `ImageUrlPdfOptionsMarginsPtrInput` via:

        ImageUrlPdfOptionsMarginsArgs{...}

or:

        nil

type ImageUrlPdfOptionsMarginsPtrOutput

type ImageUrlPdfOptionsMarginsPtrOutput struct{ *pulumi.OutputState }

func (ImageUrlPdfOptionsMarginsPtrOutput) Bottom

Margin with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsMarginsPtrOutput) Elem

func (ImageUrlPdfOptionsMarginsPtrOutput) ElementType

func (ImageUrlPdfOptionsMarginsPtrOutput) Left

Margin with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsMarginsPtrOutput) Right

Margin with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsMarginsPtrOutput) ToImageUrlPdfOptionsMarginsPtrOutput

func (o ImageUrlPdfOptionsMarginsPtrOutput) ToImageUrlPdfOptionsMarginsPtrOutput() ImageUrlPdfOptionsMarginsPtrOutput

func (ImageUrlPdfOptionsMarginsPtrOutput) ToImageUrlPdfOptionsMarginsPtrOutputWithContext

func (o ImageUrlPdfOptionsMarginsPtrOutput) ToImageUrlPdfOptionsMarginsPtrOutputWithContext(ctx context.Context) ImageUrlPdfOptionsMarginsPtrOutput

func (ImageUrlPdfOptionsMarginsPtrOutput) Top

Margin with px, in, cm, mm, or pt units.

type ImageUrlPdfOptionsOutput

type ImageUrlPdfOptionsOutput struct{ *pulumi.OutputState }

func (ImageUrlPdfOptionsOutput) ElementType

func (ImageUrlPdfOptionsOutput) ElementType() reflect.Type

func (ImageUrlPdfOptionsOutput) Margins

PDF margins. Supply all four sides with units.

func (ImageUrlPdfOptionsOutput) PageHeight

Page height with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsOutput) PageWidth

Page width with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsOutput) PrintBackground

func (o ImageUrlPdfOptionsOutput) PrintBackground() pulumi.BoolPtrOutput

Print page backgrounds. Omission lets the API choose.

func (ImageUrlPdfOptionsOutput) Scale

PDF scale from 0.1 to 2.

func (ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsOutput

func (o ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsOutput() ImageUrlPdfOptionsOutput

func (ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsOutputWithContext

func (o ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsOutputWithContext(ctx context.Context) ImageUrlPdfOptionsOutput

func (ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsPtrOutput

func (o ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsPtrOutput() ImageUrlPdfOptionsPtrOutput

func (ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsPtrOutputWithContext

func (o ImageUrlPdfOptionsOutput) ToImageUrlPdfOptionsPtrOutputWithContext(ctx context.Context) ImageUrlPdfOptionsPtrOutput

type ImageUrlPdfOptionsPtrInput

type ImageUrlPdfOptionsPtrInput interface {
	pulumi.Input

	ToImageUrlPdfOptionsPtrOutput() ImageUrlPdfOptionsPtrOutput
	ToImageUrlPdfOptionsPtrOutputWithContext(context.Context) ImageUrlPdfOptionsPtrOutput
}

ImageUrlPdfOptionsPtrInput is an input type that accepts ImageUrlPdfOptionsArgs, ImageUrlPdfOptionsPtr and ImageUrlPdfOptionsPtrOutput values. You can construct a concrete instance of `ImageUrlPdfOptionsPtrInput` via:

        ImageUrlPdfOptionsArgs{...}

or:

        nil

type ImageUrlPdfOptionsPtrOutput

type ImageUrlPdfOptionsPtrOutput struct{ *pulumi.OutputState }

func (ImageUrlPdfOptionsPtrOutput) Elem

func (ImageUrlPdfOptionsPtrOutput) ElementType

func (ImageUrlPdfOptionsPtrOutput) Margins

PDF margins. Supply all four sides with units.

func (ImageUrlPdfOptionsPtrOutput) PageHeight

Page height with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsPtrOutput) PageWidth

Page width with px, in, cm, mm, or pt units.

func (ImageUrlPdfOptionsPtrOutput) PrintBackground

func (o ImageUrlPdfOptionsPtrOutput) PrintBackground() pulumi.BoolPtrOutput

Print page backgrounds. Omission lets the API choose.

func (ImageUrlPdfOptionsPtrOutput) Scale

PDF scale from 0.1 to 2.

func (ImageUrlPdfOptionsPtrOutput) ToImageUrlPdfOptionsPtrOutput

func (o ImageUrlPdfOptionsPtrOutput) ToImageUrlPdfOptionsPtrOutput() ImageUrlPdfOptionsPtrOutput

func (ImageUrlPdfOptionsPtrOutput) ToImageUrlPdfOptionsPtrOutputWithContext

func (o ImageUrlPdfOptionsPtrOutput) ToImageUrlPdfOptionsPtrOutputWithContext(ctx context.Context) ImageUrlPdfOptionsPtrOutput

type ImageUrlRequestOverride added in v0.2.0

type ImageUrlRequestOverride struct {
	// Currently only `block` is supported.
	Action string `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes []RequestOverrideResourceType `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url *string `pulumi:"url"`
}

type ImageUrlRequestOverrideArgs added in v0.2.0

type ImageUrlRequestOverrideArgs struct {
	// Currently only `block` is supported.
	Action pulumi.StringInput `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes RequestOverrideResourceTypeArrayInput `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url pulumi.StringPtrInput `pulumi:"url"`
}

func (ImageUrlRequestOverrideArgs) ElementType added in v0.2.0

func (ImageUrlRequestOverrideArgs) ToImageUrlRequestOverrideOutput added in v0.2.0

func (i ImageUrlRequestOverrideArgs) ToImageUrlRequestOverrideOutput() ImageUrlRequestOverrideOutput

func (ImageUrlRequestOverrideArgs) ToImageUrlRequestOverrideOutputWithContext added in v0.2.0

func (i ImageUrlRequestOverrideArgs) ToImageUrlRequestOverrideOutputWithContext(ctx context.Context) ImageUrlRequestOverrideOutput

type ImageUrlRequestOverrideArray added in v0.2.0

type ImageUrlRequestOverrideArray []ImageUrlRequestOverrideInput

func (ImageUrlRequestOverrideArray) ElementType added in v0.2.0

func (ImageUrlRequestOverrideArray) ToImageUrlRequestOverrideArrayOutput added in v0.2.0

func (i ImageUrlRequestOverrideArray) ToImageUrlRequestOverrideArrayOutput() ImageUrlRequestOverrideArrayOutput

func (ImageUrlRequestOverrideArray) ToImageUrlRequestOverrideArrayOutputWithContext added in v0.2.0

func (i ImageUrlRequestOverrideArray) ToImageUrlRequestOverrideArrayOutputWithContext(ctx context.Context) ImageUrlRequestOverrideArrayOutput

type ImageUrlRequestOverrideArrayInput added in v0.2.0

type ImageUrlRequestOverrideArrayInput interface {
	pulumi.Input

	ToImageUrlRequestOverrideArrayOutput() ImageUrlRequestOverrideArrayOutput
	ToImageUrlRequestOverrideArrayOutputWithContext(context.Context) ImageUrlRequestOverrideArrayOutput
}

ImageUrlRequestOverrideArrayInput is an input type that accepts ImageUrlRequestOverrideArray and ImageUrlRequestOverrideArrayOutput values. You can construct a concrete instance of `ImageUrlRequestOverrideArrayInput` via:

ImageUrlRequestOverrideArray{ ImageUrlRequestOverrideArgs{...} }

type ImageUrlRequestOverrideArrayOutput added in v0.2.0

type ImageUrlRequestOverrideArrayOutput struct{ *pulumi.OutputState }

func (ImageUrlRequestOverrideArrayOutput) ElementType added in v0.2.0

func (ImageUrlRequestOverrideArrayOutput) Index added in v0.2.0

func (ImageUrlRequestOverrideArrayOutput) ToImageUrlRequestOverrideArrayOutput added in v0.2.0

func (o ImageUrlRequestOverrideArrayOutput) ToImageUrlRequestOverrideArrayOutput() ImageUrlRequestOverrideArrayOutput

func (ImageUrlRequestOverrideArrayOutput) ToImageUrlRequestOverrideArrayOutputWithContext added in v0.2.0

func (o ImageUrlRequestOverrideArrayOutput) ToImageUrlRequestOverrideArrayOutputWithContext(ctx context.Context) ImageUrlRequestOverrideArrayOutput

type ImageUrlRequestOverrideInput added in v0.2.0

type ImageUrlRequestOverrideInput interface {
	pulumi.Input

	ToImageUrlRequestOverrideOutput() ImageUrlRequestOverrideOutput
	ToImageUrlRequestOverrideOutputWithContext(context.Context) ImageUrlRequestOverrideOutput
}

ImageUrlRequestOverrideInput is an input type that accepts ImageUrlRequestOverrideArgs and ImageUrlRequestOverrideOutput values. You can construct a concrete instance of `ImageUrlRequestOverrideInput` via:

ImageUrlRequestOverrideArgs{...}

type ImageUrlRequestOverrideOutput added in v0.2.0

type ImageUrlRequestOverrideOutput struct{ *pulumi.OutputState }

func (ImageUrlRequestOverrideOutput) Action added in v0.2.0

Currently only `block` is supported.

func (ImageUrlRequestOverrideOutput) ElementType added in v0.2.0

func (ImageUrlRequestOverrideOutput) ResourceTypes added in v0.2.0

Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.

func (ImageUrlRequestOverrideOutput) ToImageUrlRequestOverrideOutput added in v0.2.0

func (o ImageUrlRequestOverrideOutput) ToImageUrlRequestOverrideOutput() ImageUrlRequestOverrideOutput

func (ImageUrlRequestOverrideOutput) ToImageUrlRequestOverrideOutputWithContext added in v0.2.0

func (o ImageUrlRequestOverrideOutput) ToImageUrlRequestOverrideOutputWithContext(ctx context.Context) ImageUrlRequestOverrideOutput

func (ImageUrlRequestOverrideOutput) Url added in v0.2.0

Case-sensitive URL wildcard pattern using `*`; at most 512 characters.

type ImageUrlState

type ImageUrlState struct {
	// Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored. For GET and form-encoded requests, repeat this parameter for each origin.
	AdditionalHeaderOrigins pulumi.StringArrayInput
	// Attempt to block cookie/consent banners from displaying.
	BlockConsentBanners pulumi.BoolPtrInput
	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrInput
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// CSS injected into the loaded URL to override styles on the page.
	Css pulumi.StringPtrInput
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrInput
	// Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
	DisableTwemoji pulumi.BoolPtrInput
	// Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
	Format pulumi.StringPtrInput
	// Take a screenshot of the entire screen after scrolling down and back to the top.
	FullScreen pulumi.BoolPtrInput
	// HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes. For GET and form-encoded requests, repeat this parameter using the format `headers=name:value`.
	Headers pulumi.StringMapInput
	// Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
	IdentifyAsHcti pulumi.BoolPtrInput
	// Rendering operation URL. Creation does not render bytes.
	ImageUrl pulumi.StringPtrInput
	// Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
	IncludeHeadersOnSubrequests pulumi.BoolPtrInput
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrInput
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrInput
	// Last HCTI stored-render timestamp, when available.
	LastRenderStoredAt pulumi.StringPtrInput
	// Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
	MaxRenderOnce pulumi.BoolPtrInput
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrInput
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrInput
	// Custom key-value metadata stored with the image.
	Metadata pulumi.StringMapInput
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrInput
	// Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
	OgConfigContentVersion pulumi.StringPtrInput
	// Associated OG configuration ID, if any.
	OgConfigId pulumi.StringPtrInput
	// Rendering option.
	PdfOptions ImageUrlPdfOptionsPtrInput
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrInput
	// Public GET rendering URL, or null when HCTI storage is disabled.
	PublicUrl pulumi.StringPtrInput
	// HTTP method required to render: GET or PUT.
	RenderMethod pulumi.StringPtrInput
	// Whether rendering requires API authentication.
	RenderRequiresAuth pulumi.BoolPtrInput
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrInput
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides ImageUrlRequestOverrideArrayInput
	// Last base-image save to custom storage, when available.
	SavedToStorageDestinationAt pulumi.StringPtrInput
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrInput
	// Whether rendered output is saved only to custom storage, recorded when the image was created.
	StorageDestinationHctiStorageDisabled pulumi.BoolPtrInput
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrInput
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrInput
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrInput
	// Public HTTP or HTTPS URL to capture. Required for URL image requests.
	Url pulumi.StringPtrInput
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrInput
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrInput
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrInput
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrInput
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrInput
}

func (ImageUrlState) ElementType

func (ImageUrlState) ElementType() reflect.Type

type LookupTemplateArgs

type LookupTemplateArgs struct {
	Id      string  `pulumi:"id"`
	Version *string `pulumi:"version"`
}

A collection of arguments for invoking getTemplate.

type LookupTemplateOutputArgs

type LookupTemplateOutputArgs struct {
	Id      pulumi.StringInput    `pulumi:"id"`
	Version pulumi.StringPtrInput `pulumi:"version"`
}

A collection of arguments for invoking getTemplate.

func (LookupTemplateOutputArgs) ElementType

func (LookupTemplateOutputArgs) ElementType() reflect.Type

type LookupTemplateResult

type LookupTemplateResult struct {
	ColorScheme           string                       `pulumi:"colorScheme"`
	CreatedAt             string                       `pulumi:"createdAt"`
	Css                   string                       `pulumi:"css"`
	Description           string                       `pulumi:"description"`
	DeviceScale           float64                      `pulumi:"deviceScale"`
	DisableTwemoji        bool                         `pulumi:"disableTwemoji"`
	GoogleFonts           []string                     `pulumi:"googleFonts"`
	Html                  string                       `pulumi:"html"`
	Id                    string                       `pulumi:"id"`
	JumboMaxHeight        int                          `pulumi:"jumboMaxHeight"`
	JumboMaxWidth         int                          `pulumi:"jumboMaxWidth"`
	MaxWaitMs             int                          `pulumi:"maxWaitMs"`
	MediaType             string                       `pulumi:"mediaType"`
	MsDelay               int                          `pulumi:"msDelay"`
	Name                  string                       `pulumi:"name"`
	ProxyId               string                       `pulumi:"proxyId"`
	RenderWhenReady       bool                         `pulumi:"renderWhenReady"`
	RequestOverrides      []GetTemplateRequestOverride `pulumi:"requestOverrides"`
	Selector              string                       `pulumi:"selector"`
	StorageDestinationId  string                       `pulumi:"storageDestinationId"`
	TemplateType          string                       `pulumi:"templateType"`
	Timezone              string                       `pulumi:"timezone"`
	TransparentBackground bool                         `pulumi:"transparentBackground"`
	UpdatedAt             string                       `pulumi:"updatedAt"`
	Version               string                       `pulumi:"version"`
	ViewportHeight        int                          `pulumi:"viewportHeight"`
	ViewportLandscape     bool                         `pulumi:"viewportLandscape"`
	ViewportMobile        bool                         `pulumi:"viewportMobile"`
	ViewportTouch         bool                         `pulumi:"viewportTouch"`
	ViewportWidth         int                          `pulumi:"viewportWidth"`
}

A collection of values returned by getTemplate.

func LookupTemplate

func LookupTemplate(ctx *pulumi.Context, args *LookupTemplateArgs, opts ...pulumi.InvokeOption) (*LookupTemplateResult, error)

Read an existing HTML/CSS template without managing its lifecycle. Requires `templates:read`.

## Example Usage

Omitting <span pulumi-lang-nodejs="`version`" pulumi-lang-dotnet="`Version`" pulumi-lang-go="`version`" pulumi-lang-python="`version`" pulumi-lang-yaml="`version`" pulumi-lang-java="`version`" pulumi-lang-hcl="`version`">`version`</span> resolves the latest version on every refresh. In this example a new template version changes the image's <span pulumi-lang-nodejs="`templateVersion`" pulumi-lang-dotnet="`TemplateVersion`" pulumi-lang-go="`templateVersion`" pulumi-lang-python="`template_version`" pulumi-lang-yaml="`templateVersion`" pulumi-lang-java="`templateVersion`" pulumi-lang-hcl="`template_version`">`templateVersion`</span>, so Terraform replaces the image. To pin the lookup, set <span pulumi-lang-nodejs="`version`" pulumi-lang-dotnet="`Version`" pulumi-lang-go="`version`" pulumi-lang-python="`version`" pulumi-lang-yaml="`version`" pulumi-lang-java="`version`" pulumi-lang-hcl="`version`">`version`</span> to a specific version identifier.

type LookupTemplateResultOutput

type LookupTemplateResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getTemplate.

func (LookupTemplateResultOutput) ColorScheme

func (LookupTemplateResultOutput) CreatedAt

func (LookupTemplateResultOutput) Css

func (LookupTemplateResultOutput) Description

func (LookupTemplateResultOutput) DeviceScale

func (LookupTemplateResultOutput) DisableTwemoji

func (o LookupTemplateResultOutput) DisableTwemoji() pulumi.BoolOutput

func (LookupTemplateResultOutput) ElementType

func (LookupTemplateResultOutput) ElementType() reflect.Type

func (LookupTemplateResultOutput) GoogleFonts

func (LookupTemplateResultOutput) Html

func (LookupTemplateResultOutput) Id

func (LookupTemplateResultOutput) JumboMaxHeight

func (o LookupTemplateResultOutput) JumboMaxHeight() pulumi.IntOutput

func (LookupTemplateResultOutput) JumboMaxWidth

func (o LookupTemplateResultOutput) JumboMaxWidth() pulumi.IntOutput

func (LookupTemplateResultOutput) MaxWaitMs

func (LookupTemplateResultOutput) MediaType

func (LookupTemplateResultOutput) MsDelay

func (LookupTemplateResultOutput) Name

func (LookupTemplateResultOutput) ProxyId

func (LookupTemplateResultOutput) RenderWhenReady

func (o LookupTemplateResultOutput) RenderWhenReady() pulumi.BoolOutput

func (LookupTemplateResultOutput) RequestOverrides added in v0.2.0

func (LookupTemplateResultOutput) Selector

func (LookupTemplateResultOutput) StorageDestinationId

func (o LookupTemplateResultOutput) StorageDestinationId() pulumi.StringOutput

func (LookupTemplateResultOutput) TemplateType

func (LookupTemplateResultOutput) Timezone

func (LookupTemplateResultOutput) ToLookupTemplateResultOutput

func (o LookupTemplateResultOutput) ToLookupTemplateResultOutput() LookupTemplateResultOutput

func (LookupTemplateResultOutput) ToLookupTemplateResultOutputWithContext

func (o LookupTemplateResultOutput) ToLookupTemplateResultOutputWithContext(ctx context.Context) LookupTemplateResultOutput

func (LookupTemplateResultOutput) TransparentBackground

func (o LookupTemplateResultOutput) TransparentBackground() pulumi.BoolOutput

func (LookupTemplateResultOutput) UpdatedAt

func (LookupTemplateResultOutput) Version

func (LookupTemplateResultOutput) ViewportHeight

func (o LookupTemplateResultOutput) ViewportHeight() pulumi.IntOutput

func (LookupTemplateResultOutput) ViewportLandscape

func (o LookupTemplateResultOutput) ViewportLandscape() pulumi.BoolOutput

func (LookupTemplateResultOutput) ViewportMobile

func (o LookupTemplateResultOutput) ViewportMobile() pulumi.BoolOutput

func (LookupTemplateResultOutput) ViewportTouch

func (o LookupTemplateResultOutput) ViewportTouch() pulumi.BoolOutput

func (LookupTemplateResultOutput) ViewportWidth

func (o LookupTemplateResultOutput) ViewportWidth() pulumi.IntOutput

type OgConfig

type OgConfig struct {
	pulumi.CustomResourceState

	// Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
	AdditionalHeaderOrigins pulumi.StringArrayOutput `pulumi:"additionalHeaderOrigins"`
	// HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
	BaseUrl pulumi.StringOutput `pulumi:"baseUrl"`
	// Rendering source: html_css or templated. Changing type updates this configuration in place.
	ConfigType pulumi.StringOutput `pulumi:"configType"`
	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
	DefaultOptions OgConfigDefaultOptionsPtrOutput `pulumi:"defaultOptions"`
	// Optional description, up to 1023 characters. Omission clears it.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Disable serving images. Defaults to false.
	Disabled pulumi.BoolOutput `pulumi:"disabled"`
	// Serving identifier used in OG image URLs. Distinct from the management ID.
	DomainId pulumi.StringOutput `pulumi:"domainId"`
	// Optimization mode returned by the API.
	EffectiveOptimizationMode pulumi.StringOutput `pulumi:"effectiveOptimizationMode"`
	// Refresh interval returned by the API, in seconds.
	EffectiveRefreshIntervalS pulumi.IntOutput `pulumi:"effectiveRefreshIntervalS"`
	// HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
	ExtractValues pulumi.BoolPtrOutput `pulumi:"extractValues"`
	// Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
	Headers pulumi.StringMapOutput `pulumi:"headers"`
	// Display name, 1–255 characters after trimming.
	Name pulumi.StringOutput `pulumi:"name"`
	// no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
	OptimizationMode pulumi.StringPtrOutput `pulumi:"optimizationMode"`
	// Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
	RefreshIntervalS pulumi.IntPtrOutput `pulumi:"refreshIntervalS"`
	// Required for templated configurations. Template ID including its t- prefix.
	TemplateId pulumi.StringPtrOutput `pulumi:"templateId"`
	// Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
	TemplateValuesMappings OgConfigTemplateValuesMappingArrayOutput `pulumi:"templateValuesMappings"`
	// Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
	TemplateVersion pulumi.StringPtrOutput `pulumi:"templateVersion"`
	// Last update timestamp.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

func GetOgConfig

func GetOgConfig(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *OgConfigState, opts ...pulumi.ResourceOption) (*OgConfig, error)

GetOgConfig gets an existing OgConfig resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewOgConfig

func NewOgConfig(ctx *pulumi.Context,
	name string, args *OgConfigArgs, opts ...pulumi.ResourceOption) (*OgConfig, error)

NewOgConfig registers a new resource with the given unique name, arguments, and options.

func (*OgConfig) ElementType

func (*OgConfig) ElementType() reflect.Type

func (*OgConfig) ToOgConfigOutput

func (i *OgConfig) ToOgConfigOutput() OgConfigOutput

func (*OgConfig) ToOgConfigOutputWithContext

func (i *OgConfig) ToOgConfigOutputWithContext(ctx context.Context) OgConfigOutput

type OgConfigArgs

type OgConfigArgs struct {
	// Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
	AdditionalHeaderOrigins pulumi.StringArrayInput
	// HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
	BaseUrl pulumi.StringInput
	// Rendering source: html_css or templated. Changing type updates this configuration in place.
	ConfigType pulumi.StringInput
	// HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
	DefaultOptions OgConfigDefaultOptionsPtrInput
	// Optional description, up to 1023 characters. Omission clears it.
	Description pulumi.StringPtrInput
	// Disable serving images. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
	ExtractValues pulumi.BoolPtrInput
	// Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
	Headers pulumi.StringMapInput
	// Display name, 1–255 characters after trimming.
	Name pulumi.StringInput
	// no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
	OptimizationMode pulumi.StringPtrInput
	// Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
	RefreshIntervalS pulumi.IntPtrInput
	// Required for templated configurations. Template ID including its t- prefix.
	TemplateId pulumi.StringPtrInput
	// Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
	TemplateValuesMappings OgConfigTemplateValuesMappingArrayInput
	// Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
	TemplateVersion pulumi.StringPtrInput
}

The set of arguments for constructing a OgConfig resource.

func (OgConfigArgs) ElementType

func (OgConfigArgs) ElementType() reflect.Type

type OgConfigDefaultOptions

type OgConfigDefaultOptions struct {
	// Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored.
	AdditionalHeaderOrigins []string `pulumi:"additionalHeaderOrigins"`
	// Attempt to block cookie/consent banners from displaying.
	BlockConsentBanners *bool `pulumi:"blockConsentBanners"`
	// Sets Chrome's preferred color scheme. Valid values: light or dark.
	ColorScheme *string `pulumi:"colorScheme"`
	// CSS injected into the loaded page to override its styles.
	Css *string `pulumi:"css"`
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale *float64 `pulumi:"deviceScale"`
	// Set false to inject Twemoji into the captured URL page. Omitted or true leaves the page's emoji handling unchanged.
	DisableTwemoji *bool `pulumi:"disableTwemoji"`
	// HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes.
	Headers map[string]string `pulumi:"headers"`
	// Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
	IdentifyAsHcti *bool `pulumi:"identifyAsHcti"`
	// Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
	IncludeHeadersOnSubrequests *bool `pulumi:"includeHeadersOnSubrequests"`
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs *int `pulumi:"maxWaitMs"`
	// Sets the CSS media type used while rendering the page. Valid values: print or screen.
	MediaType *string `pulumi:"mediaType"`
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay *int `pulumi:"msDelay"`
	// Configured proxy ID. Must refer to an enabled proxy.
	ProxyId *string `pulumi:"proxyId"`
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady *bool `pulumi:"renderWhenReady"`
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides []OgConfigDefaultOptionsRequestOverride `pulumi:"requestOverrides"`
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector *string `pulumi:"selector"`
	// Configured storage destination ID. Must be enabled and allow HCTI storage.
	StorageDestinationId *string `pulumi:"storageDestinationId"`
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone *string `pulumi:"timezone"`
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground *bool `pulumi:"transparentBackground"`
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight *int `pulumi:"viewportHeight"`
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape *bool `pulumi:"viewportLandscape"`
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile *bool `pulumi:"viewportMobile"`
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch *bool `pulumi:"viewportTouch"`
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth *int `pulumi:"viewportWidth"`
}

type OgConfigDefaultOptionsArgs

type OgConfigDefaultOptionsArgs struct {
	// Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored.
	AdditionalHeaderOrigins pulumi.StringArrayInput `pulumi:"additionalHeaderOrigins"`
	// Attempt to block cookie/consent banners from displaying.
	BlockConsentBanners pulumi.BoolPtrInput `pulumi:"blockConsentBanners"`
	// Sets Chrome's preferred color scheme. Valid values: light or dark.
	ColorScheme pulumi.StringPtrInput `pulumi:"colorScheme"`
	// CSS injected into the loaded page to override its styles.
	Css pulumi.StringPtrInput `pulumi:"css"`
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrInput `pulumi:"deviceScale"`
	// Set false to inject Twemoji into the captured URL page. Omitted or true leaves the page's emoji handling unchanged.
	DisableTwemoji pulumi.BoolPtrInput `pulumi:"disableTwemoji"`
	// HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes.
	Headers pulumi.StringMapInput `pulumi:"headers"`
	// Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
	IdentifyAsHcti pulumi.BoolPtrInput `pulumi:"identifyAsHcti"`
	// Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
	IncludeHeadersOnSubrequests pulumi.BoolPtrInput `pulumi:"includeHeadersOnSubrequests"`
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrInput `pulumi:"maxWaitMs"`
	// Sets the CSS media type used while rendering the page. Valid values: print or screen.
	MediaType pulumi.StringPtrInput `pulumi:"mediaType"`
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrInput `pulumi:"msDelay"`
	// Configured proxy ID. Must refer to an enabled proxy.
	ProxyId pulumi.StringPtrInput `pulumi:"proxyId"`
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrInput `pulumi:"renderWhenReady"`
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides OgConfigDefaultOptionsRequestOverrideArrayInput `pulumi:"requestOverrides"`
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrInput `pulumi:"selector"`
	// Configured storage destination ID. Must be enabled and allow HCTI storage.
	StorageDestinationId pulumi.StringPtrInput `pulumi:"storageDestinationId"`
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrInput `pulumi:"timezone"`
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrInput `pulumi:"transparentBackground"`
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrInput `pulumi:"viewportHeight"`
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrInput `pulumi:"viewportLandscape"`
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrInput `pulumi:"viewportMobile"`
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrInput `pulumi:"viewportTouch"`
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrInput `pulumi:"viewportWidth"`
}

func (OgConfigDefaultOptionsArgs) ElementType

func (OgConfigDefaultOptionsArgs) ElementType() reflect.Type

func (OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsOutput

func (i OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsOutput() OgConfigDefaultOptionsOutput

func (OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsOutputWithContext

func (i OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsOutputWithContext(ctx context.Context) OgConfigDefaultOptionsOutput

func (OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsPtrOutput

func (i OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsPtrOutput() OgConfigDefaultOptionsPtrOutput

func (OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsPtrOutputWithContext

func (i OgConfigDefaultOptionsArgs) ToOgConfigDefaultOptionsPtrOutputWithContext(ctx context.Context) OgConfigDefaultOptionsPtrOutput

type OgConfigDefaultOptionsInput

type OgConfigDefaultOptionsInput interface {
	pulumi.Input

	ToOgConfigDefaultOptionsOutput() OgConfigDefaultOptionsOutput
	ToOgConfigDefaultOptionsOutputWithContext(context.Context) OgConfigDefaultOptionsOutput
}

OgConfigDefaultOptionsInput is an input type that accepts OgConfigDefaultOptionsArgs and OgConfigDefaultOptionsOutput values. You can construct a concrete instance of `OgConfigDefaultOptionsInput` via:

OgConfigDefaultOptionsArgs{...}

type OgConfigDefaultOptionsOutput

type OgConfigDefaultOptionsOutput struct{ *pulumi.OutputState }

func (OgConfigDefaultOptionsOutput) AdditionalHeaderOrigins

func (o OgConfigDefaultOptionsOutput) AdditionalHeaderOrigins() pulumi.StringArrayOutput

Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored.

func (OgConfigDefaultOptionsOutput) BlockConsentBanners

func (o OgConfigDefaultOptionsOutput) BlockConsentBanners() pulumi.BoolPtrOutput

Attempt to block cookie/consent banners from displaying.

func (OgConfigDefaultOptionsOutput) ColorScheme

Sets Chrome's preferred color scheme. Valid values: light or dark.

func (OgConfigDefaultOptionsOutput) Css

CSS injected into the loaded page to override its styles.

func (OgConfigDefaultOptionsOutput) DeviceScale

Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.

func (OgConfigDefaultOptionsOutput) DisableTwemoji

Set false to inject Twemoji into the captured URL page. Omitted or true leaves the page's emoji handling unchanged.

func (OgConfigDefaultOptionsOutput) ElementType

func (OgConfigDefaultOptionsOutput) Headers

HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes.

func (OgConfigDefaultOptionsOutput) IdentifyAsHcti

Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.

func (OgConfigDefaultOptionsOutput) IncludeHeadersOnSubrequests

func (o OgConfigDefaultOptionsOutput) IncludeHeadersOnSubrequests() pulumi.BoolPtrOutput

Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.

func (OgConfigDefaultOptionsOutput) MaxWaitMs

Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.

func (OgConfigDefaultOptionsOutput) MediaType

Sets the CSS media type used while rendering the page. Valid values: print or screen.

func (OgConfigDefaultOptionsOutput) MsDelay

Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.

func (OgConfigDefaultOptionsOutput) ProxyId

Configured proxy ID. Must refer to an enabled proxy.

func (OgConfigDefaultOptionsOutput) RenderWhenReady

Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.

func (OgConfigDefaultOptionsOutput) RequestOverrides added in v0.2.0

Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.

func (OgConfigDefaultOptionsOutput) Selector

A CSS selector for an element in the HTML. We’ll crop the image to this specific element.

func (OgConfigDefaultOptionsOutput) StorageDestinationId

func (o OgConfigDefaultOptionsOutput) StorageDestinationId() pulumi.StringPtrOutput

Configured storage destination ID. Must be enabled and allow HCTI storage.

func (OgConfigDefaultOptionsOutput) Timezone

Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.

func (OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsOutput

func (o OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsOutput() OgConfigDefaultOptionsOutput

func (OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsOutputWithContext

func (o OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsOutputWithContext(ctx context.Context) OgConfigDefaultOptionsOutput

func (OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsPtrOutput

func (o OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsPtrOutput() OgConfigDefaultOptionsPtrOutput

func (OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsPtrOutputWithContext

func (o OgConfigDefaultOptionsOutput) ToOgConfigDefaultOptionsPtrOutputWithContext(ctx context.Context) OgConfigDefaultOptionsPtrOutput

func (OgConfigDefaultOptionsOutput) TransparentBackground

func (o OgConfigDefaultOptionsOutput) TransparentBackground() pulumi.BoolPtrOutput

Specifies whether the image is rendered with a transparent background.

func (OgConfigDefaultOptionsOutput) ViewportHeight

Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

func (OgConfigDefaultOptionsOutput) ViewportLandscape

func (o OgConfigDefaultOptionsOutput) ViewportLandscape() pulumi.BoolPtrOutput

Specifies whether the emulated viewport is in landscape orientation.

func (OgConfigDefaultOptionsOutput) ViewportMobile

Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.

func (OgConfigDefaultOptionsOutput) ViewportTouch

Specifies whether the emulated viewport supports touch events.

func (OgConfigDefaultOptionsOutput) ViewportWidth

Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

type OgConfigDefaultOptionsPtrInput

type OgConfigDefaultOptionsPtrInput interface {
	pulumi.Input

	ToOgConfigDefaultOptionsPtrOutput() OgConfigDefaultOptionsPtrOutput
	ToOgConfigDefaultOptionsPtrOutputWithContext(context.Context) OgConfigDefaultOptionsPtrOutput
}

OgConfigDefaultOptionsPtrInput is an input type that accepts OgConfigDefaultOptionsArgs, OgConfigDefaultOptionsPtr and OgConfigDefaultOptionsPtrOutput values. You can construct a concrete instance of `OgConfigDefaultOptionsPtrInput` via:

        OgConfigDefaultOptionsArgs{...}

or:

        nil

type OgConfigDefaultOptionsPtrOutput

type OgConfigDefaultOptionsPtrOutput struct{ *pulumi.OutputState }

func (OgConfigDefaultOptionsPtrOutput) AdditionalHeaderOrigins

func (o OgConfigDefaultOptionsPtrOutput) AdditionalHeaderOrigins() pulumi.StringArrayOutput

Additional exact HTTP or HTTPS origins allowed to receive custom headers. Supports up to 20 unique origins of up to 512 UTF-8 bytes each. Origins must use the format scheme://host[:port] without a path; duplicates are ignored.

func (OgConfigDefaultOptionsPtrOutput) BlockConsentBanners

func (o OgConfigDefaultOptionsPtrOutput) BlockConsentBanners() pulumi.BoolPtrOutput

Attempt to block cookie/consent banners from displaying.

func (OgConfigDefaultOptionsPtrOutput) ColorScheme

Sets Chrome's preferred color scheme. Valid values: light or dark.

func (OgConfigDefaultOptionsPtrOutput) Css

CSS injected into the loaded page to override its styles.

func (OgConfigDefaultOptionsPtrOutput) DeviceScale

Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.

func (OgConfigDefaultOptionsPtrOutput) DisableTwemoji

Set false to inject Twemoji into the captured URL page. Omitted or true leaves the page's emoji handling unchanged.

func (OgConfigDefaultOptionsPtrOutput) Elem

func (OgConfigDefaultOptionsPtrOutput) ElementType

func (OgConfigDefaultOptionsPtrOutput) Headers

HTTP headers to include on top-level page navigations to the requested URL's origin and any additional_header_origins. Supports up to 20 headers with names up to 512 ASCII characters and values up to 8192 UTF-8 bytes.

func (OgConfigDefaultOptionsPtrOutput) IdentifyAsHcti

Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.

func (OgConfigDefaultOptionsPtrOutput) IncludeHeadersOnSubrequests

func (o OgConfigDefaultOptionsPtrOutput) IncludeHeadersOnSubrequests() pulumi.BoolPtrOutput

Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.

func (OgConfigDefaultOptionsPtrOutput) MaxWaitMs

Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.

func (OgConfigDefaultOptionsPtrOutput) MediaType

Sets the CSS media type used while rendering the page. Valid values: print or screen.

func (OgConfigDefaultOptionsPtrOutput) MsDelay

Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.

func (OgConfigDefaultOptionsPtrOutput) ProxyId

Configured proxy ID. Must refer to an enabled proxy.

func (OgConfigDefaultOptionsPtrOutput) RenderWhenReady

Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.

func (OgConfigDefaultOptionsPtrOutput) RequestOverrides added in v0.2.0

Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.

func (OgConfigDefaultOptionsPtrOutput) Selector

A CSS selector for an element in the HTML. We’ll crop the image to this specific element.

func (OgConfigDefaultOptionsPtrOutput) StorageDestinationId

func (o OgConfigDefaultOptionsPtrOutput) StorageDestinationId() pulumi.StringPtrOutput

Configured storage destination ID. Must be enabled and allow HCTI storage.

func (OgConfigDefaultOptionsPtrOutput) Timezone

Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.

func (OgConfigDefaultOptionsPtrOutput) ToOgConfigDefaultOptionsPtrOutput

func (o OgConfigDefaultOptionsPtrOutput) ToOgConfigDefaultOptionsPtrOutput() OgConfigDefaultOptionsPtrOutput

func (OgConfigDefaultOptionsPtrOutput) ToOgConfigDefaultOptionsPtrOutputWithContext

func (o OgConfigDefaultOptionsPtrOutput) ToOgConfigDefaultOptionsPtrOutputWithContext(ctx context.Context) OgConfigDefaultOptionsPtrOutput

func (OgConfigDefaultOptionsPtrOutput) TransparentBackground

func (o OgConfigDefaultOptionsPtrOutput) TransparentBackground() pulumi.BoolPtrOutput

Specifies whether the image is rendered with a transparent background.

func (OgConfigDefaultOptionsPtrOutput) ViewportHeight

Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

func (OgConfigDefaultOptionsPtrOutput) ViewportLandscape

Specifies whether the emulated viewport is in landscape orientation.

func (OgConfigDefaultOptionsPtrOutput) ViewportMobile

Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.

func (OgConfigDefaultOptionsPtrOutput) ViewportTouch

Specifies whether the emulated viewport supports touch events.

func (OgConfigDefaultOptionsPtrOutput) ViewportWidth

Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

type OgConfigDefaultOptionsRequestOverride added in v0.2.0

type OgConfigDefaultOptionsRequestOverride struct {
	// Currently only `block` is supported.
	Action string `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes []RequestOverrideResourceType `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url *string `pulumi:"url"`
}

type OgConfigDefaultOptionsRequestOverrideArgs added in v0.2.0

type OgConfigDefaultOptionsRequestOverrideArgs struct {
	// Currently only `block` is supported.
	Action pulumi.StringInput `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes RequestOverrideResourceTypeArrayInput `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url pulumi.StringPtrInput `pulumi:"url"`
}

func (OgConfigDefaultOptionsRequestOverrideArgs) ElementType added in v0.2.0

func (OgConfigDefaultOptionsRequestOverrideArgs) ToOgConfigDefaultOptionsRequestOverrideOutput added in v0.2.0

func (i OgConfigDefaultOptionsRequestOverrideArgs) ToOgConfigDefaultOptionsRequestOverrideOutput() OgConfigDefaultOptionsRequestOverrideOutput

func (OgConfigDefaultOptionsRequestOverrideArgs) ToOgConfigDefaultOptionsRequestOverrideOutputWithContext added in v0.2.0

func (i OgConfigDefaultOptionsRequestOverrideArgs) ToOgConfigDefaultOptionsRequestOverrideOutputWithContext(ctx context.Context) OgConfigDefaultOptionsRequestOverrideOutput

type OgConfigDefaultOptionsRequestOverrideArray added in v0.2.0

type OgConfigDefaultOptionsRequestOverrideArray []OgConfigDefaultOptionsRequestOverrideInput

func (OgConfigDefaultOptionsRequestOverrideArray) ElementType added in v0.2.0

func (OgConfigDefaultOptionsRequestOverrideArray) ToOgConfigDefaultOptionsRequestOverrideArrayOutput added in v0.2.0

func (i OgConfigDefaultOptionsRequestOverrideArray) ToOgConfigDefaultOptionsRequestOverrideArrayOutput() OgConfigDefaultOptionsRequestOverrideArrayOutput

func (OgConfigDefaultOptionsRequestOverrideArray) ToOgConfigDefaultOptionsRequestOverrideArrayOutputWithContext added in v0.2.0

func (i OgConfigDefaultOptionsRequestOverrideArray) ToOgConfigDefaultOptionsRequestOverrideArrayOutputWithContext(ctx context.Context) OgConfigDefaultOptionsRequestOverrideArrayOutput

type OgConfigDefaultOptionsRequestOverrideArrayInput added in v0.2.0

type OgConfigDefaultOptionsRequestOverrideArrayInput interface {
	pulumi.Input

	ToOgConfigDefaultOptionsRequestOverrideArrayOutput() OgConfigDefaultOptionsRequestOverrideArrayOutput
	ToOgConfigDefaultOptionsRequestOverrideArrayOutputWithContext(context.Context) OgConfigDefaultOptionsRequestOverrideArrayOutput
}

OgConfigDefaultOptionsRequestOverrideArrayInput is an input type that accepts OgConfigDefaultOptionsRequestOverrideArray and OgConfigDefaultOptionsRequestOverrideArrayOutput values. You can construct a concrete instance of `OgConfigDefaultOptionsRequestOverrideArrayInput` via:

OgConfigDefaultOptionsRequestOverrideArray{ OgConfigDefaultOptionsRequestOverrideArgs{...} }

type OgConfigDefaultOptionsRequestOverrideArrayOutput added in v0.2.0

type OgConfigDefaultOptionsRequestOverrideArrayOutput struct{ *pulumi.OutputState }

func (OgConfigDefaultOptionsRequestOverrideArrayOutput) ElementType added in v0.2.0

func (OgConfigDefaultOptionsRequestOverrideArrayOutput) Index added in v0.2.0

func (OgConfigDefaultOptionsRequestOverrideArrayOutput) ToOgConfigDefaultOptionsRequestOverrideArrayOutput added in v0.2.0

func (o OgConfigDefaultOptionsRequestOverrideArrayOutput) ToOgConfigDefaultOptionsRequestOverrideArrayOutput() OgConfigDefaultOptionsRequestOverrideArrayOutput

func (OgConfigDefaultOptionsRequestOverrideArrayOutput) ToOgConfigDefaultOptionsRequestOverrideArrayOutputWithContext added in v0.2.0

func (o OgConfigDefaultOptionsRequestOverrideArrayOutput) ToOgConfigDefaultOptionsRequestOverrideArrayOutputWithContext(ctx context.Context) OgConfigDefaultOptionsRequestOverrideArrayOutput

type OgConfigDefaultOptionsRequestOverrideInput added in v0.2.0

type OgConfigDefaultOptionsRequestOverrideInput interface {
	pulumi.Input

	ToOgConfigDefaultOptionsRequestOverrideOutput() OgConfigDefaultOptionsRequestOverrideOutput
	ToOgConfigDefaultOptionsRequestOverrideOutputWithContext(context.Context) OgConfigDefaultOptionsRequestOverrideOutput
}

OgConfigDefaultOptionsRequestOverrideInput is an input type that accepts OgConfigDefaultOptionsRequestOverrideArgs and OgConfigDefaultOptionsRequestOverrideOutput values. You can construct a concrete instance of `OgConfigDefaultOptionsRequestOverrideInput` via:

OgConfigDefaultOptionsRequestOverrideArgs{...}

type OgConfigDefaultOptionsRequestOverrideOutput added in v0.2.0

type OgConfigDefaultOptionsRequestOverrideOutput struct{ *pulumi.OutputState }

func (OgConfigDefaultOptionsRequestOverrideOutput) Action added in v0.2.0

Currently only `block` is supported.

func (OgConfigDefaultOptionsRequestOverrideOutput) ElementType added in v0.2.0

func (OgConfigDefaultOptionsRequestOverrideOutput) ResourceTypes added in v0.2.0

Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.

func (OgConfigDefaultOptionsRequestOverrideOutput) ToOgConfigDefaultOptionsRequestOverrideOutput added in v0.2.0

func (o OgConfigDefaultOptionsRequestOverrideOutput) ToOgConfigDefaultOptionsRequestOverrideOutput() OgConfigDefaultOptionsRequestOverrideOutput

func (OgConfigDefaultOptionsRequestOverrideOutput) ToOgConfigDefaultOptionsRequestOverrideOutputWithContext added in v0.2.0

func (o OgConfigDefaultOptionsRequestOverrideOutput) ToOgConfigDefaultOptionsRequestOverrideOutputWithContext(ctx context.Context) OgConfigDefaultOptionsRequestOverrideOutput

func (OgConfigDefaultOptionsRequestOverrideOutput) Url added in v0.2.0

Case-sensitive URL wildcard pattern using `*`; at most 512 characters.

type OgConfigInput

type OgConfigInput interface {
	pulumi.Input

	ToOgConfigOutput() OgConfigOutput
	ToOgConfigOutputWithContext(ctx context.Context) OgConfigOutput
}

type OgConfigOutput

type OgConfigOutput struct{ *pulumi.OutputState }

func (OgConfigOutput) AdditionalHeaderOrigins

func (o OgConfigOutput) AdditionalHeaderOrigins() pulumi.StringArrayOutput

Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.

func (OgConfigOutput) BaseUrl

func (o OgConfigOutput) BaseUrl() pulumi.StringOutput

HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.

func (OgConfigOutput) ConfigType

func (o OgConfigOutput) ConfigType() pulumi.StringOutput

Rendering source: html_css or templated. Changing type updates this configuration in place.

func (OgConfigOutput) CreatedAt

func (o OgConfigOutput) CreatedAt() pulumi.StringOutput

Creation timestamp.

func (OgConfigOutput) DefaultOptions

HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.

func (OgConfigOutput) Description

func (o OgConfigOutput) Description() pulumi.StringPtrOutput

Optional description, up to 1023 characters. Omission clears it.

func (OgConfigOutput) Disabled

func (o OgConfigOutput) Disabled() pulumi.BoolOutput

Disable serving images. Defaults to false.

func (OgConfigOutput) DomainId

func (o OgConfigOutput) DomainId() pulumi.StringOutput

Serving identifier used in OG image URLs. Distinct from the management ID.

func (OgConfigOutput) EffectiveOptimizationMode

func (o OgConfigOutput) EffectiveOptimizationMode() pulumi.StringOutput

Optimization mode returned by the API.

func (OgConfigOutput) EffectiveRefreshIntervalS

func (o OgConfigOutput) EffectiveRefreshIntervalS() pulumi.IntOutput

Refresh interval returned by the API, in seconds.

func (OgConfigOutput) ElementType

func (OgConfigOutput) ElementType() reflect.Type

func (OgConfigOutput) ExtractValues

func (o OgConfigOutput) ExtractValues() pulumi.BoolPtrOutput

HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.

func (OgConfigOutput) Headers

Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.

func (OgConfigOutput) Name

Display name, 1–255 characters after trimming.

func (OgConfigOutput) OptimizationMode

func (o OgConfigOutput) OptimizationMode() pulumi.StringPtrOutput

no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).

func (OgConfigOutput) RefreshIntervalS

func (o OgConfigOutput) RefreshIntervalS() pulumi.IntPtrOutput

Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).

func (OgConfigOutput) TemplateId

func (o OgConfigOutput) TemplateId() pulumi.StringPtrOutput

Required for templated configurations. Template ID including its t- prefix.

func (OgConfigOutput) TemplateValuesMappings

func (o OgConfigOutput) TemplateValuesMappings() OgConfigTemplateValuesMappingArrayOutput

Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.

func (OgConfigOutput) TemplateVersion

func (o OgConfigOutput) TemplateVersion() pulumi.StringPtrOutput

Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.

func (OgConfigOutput) ToOgConfigOutput

func (o OgConfigOutput) ToOgConfigOutput() OgConfigOutput

func (OgConfigOutput) ToOgConfigOutputWithContext

func (o OgConfigOutput) ToOgConfigOutputWithContext(ctx context.Context) OgConfigOutput

func (OgConfigOutput) UpdatedAt

func (o OgConfigOutput) UpdatedAt() pulumi.StringOutput

Last update timestamp.

type OgConfigState

type OgConfigState struct {
	// Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
	AdditionalHeaderOrigins pulumi.StringArrayInput
	// HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
	BaseUrl pulumi.StringPtrInput
	// Rendering source: html_css or templated. Changing type updates this configuration in place.
	ConfigType pulumi.StringPtrInput
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
	DefaultOptions OgConfigDefaultOptionsPtrInput
	// Optional description, up to 1023 characters. Omission clears it.
	Description pulumi.StringPtrInput
	// Disable serving images. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// Serving identifier used in OG image URLs. Distinct from the management ID.
	DomainId pulumi.StringPtrInput
	// Optimization mode returned by the API.
	EffectiveOptimizationMode pulumi.StringPtrInput
	// Refresh interval returned by the API, in seconds.
	EffectiveRefreshIntervalS pulumi.IntPtrInput
	// HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
	ExtractValues pulumi.BoolPtrInput
	// Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
	Headers pulumi.StringMapInput
	// Display name, 1–255 characters after trimming.
	Name pulumi.StringPtrInput
	// no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
	OptimizationMode pulumi.StringPtrInput
	// Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
	RefreshIntervalS pulumi.IntPtrInput
	// Required for templated configurations. Template ID including its t- prefix.
	TemplateId pulumi.StringPtrInput
	// Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
	TemplateValuesMappings OgConfigTemplateValuesMappingArrayInput
	// Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
	TemplateVersion pulumi.StringPtrInput
	// Last update timestamp.
	UpdatedAt pulumi.StringPtrInput
}

func (OgConfigState) ElementType

func (OgConfigState) ElementType() reflect.Type

type OgConfigTemplateValuesMapping

type OgConfigTemplateValuesMapping struct {
	// Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
	Fallback *string `pulumi:"fallback"`
	// Source meta tag name, up to 136 characters. Supply exactly one of<span pulumi-lang-nodejs=" metaKey " pulumi-lang-dotnet=" MetaKey " pulumi-lang-go=" metaKey " pulumi-lang-python=" meta_key " pulumi-lang-yaml=" metaKey " pulumi-lang-java=" metaKey " pulumi-lang-hcl=" meta_key "> metaKey </span>or fallback.
	MetaKey *string `pulumi:"metaKey"`
	// Destination template field path, up to 128 characters. Paths must not overlap.
	TemplateKey string `pulumi:"templateKey"`
}

type OgConfigTemplateValuesMappingArgs

type OgConfigTemplateValuesMappingArgs struct {
	// Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
	Fallback pulumi.StringPtrInput `pulumi:"fallback"`
	// Source meta tag name, up to 136 characters. Supply exactly one of<span pulumi-lang-nodejs=" metaKey " pulumi-lang-dotnet=" MetaKey " pulumi-lang-go=" metaKey " pulumi-lang-python=" meta_key " pulumi-lang-yaml=" metaKey " pulumi-lang-java=" metaKey " pulumi-lang-hcl=" meta_key "> metaKey </span>or fallback.
	MetaKey pulumi.StringPtrInput `pulumi:"metaKey"`
	// Destination template field path, up to 128 characters. Paths must not overlap.
	TemplateKey pulumi.StringInput `pulumi:"templateKey"`
}

func (OgConfigTemplateValuesMappingArgs) ElementType

func (OgConfigTemplateValuesMappingArgs) ToOgConfigTemplateValuesMappingOutput

func (i OgConfigTemplateValuesMappingArgs) ToOgConfigTemplateValuesMappingOutput() OgConfigTemplateValuesMappingOutput

func (OgConfigTemplateValuesMappingArgs) ToOgConfigTemplateValuesMappingOutputWithContext

func (i OgConfigTemplateValuesMappingArgs) ToOgConfigTemplateValuesMappingOutputWithContext(ctx context.Context) OgConfigTemplateValuesMappingOutput

type OgConfigTemplateValuesMappingArray

type OgConfigTemplateValuesMappingArray []OgConfigTemplateValuesMappingInput

func (OgConfigTemplateValuesMappingArray) ElementType

func (OgConfigTemplateValuesMappingArray) ToOgConfigTemplateValuesMappingArrayOutput

func (i OgConfigTemplateValuesMappingArray) ToOgConfigTemplateValuesMappingArrayOutput() OgConfigTemplateValuesMappingArrayOutput

func (OgConfigTemplateValuesMappingArray) ToOgConfigTemplateValuesMappingArrayOutputWithContext

func (i OgConfigTemplateValuesMappingArray) ToOgConfigTemplateValuesMappingArrayOutputWithContext(ctx context.Context) OgConfigTemplateValuesMappingArrayOutput

type OgConfigTemplateValuesMappingArrayInput

type OgConfigTemplateValuesMappingArrayInput interface {
	pulumi.Input

	ToOgConfigTemplateValuesMappingArrayOutput() OgConfigTemplateValuesMappingArrayOutput
	ToOgConfigTemplateValuesMappingArrayOutputWithContext(context.Context) OgConfigTemplateValuesMappingArrayOutput
}

OgConfigTemplateValuesMappingArrayInput is an input type that accepts OgConfigTemplateValuesMappingArray and OgConfigTemplateValuesMappingArrayOutput values. You can construct a concrete instance of `OgConfigTemplateValuesMappingArrayInput` via:

OgConfigTemplateValuesMappingArray{ OgConfigTemplateValuesMappingArgs{...} }

type OgConfigTemplateValuesMappingArrayOutput

type OgConfigTemplateValuesMappingArrayOutput struct{ *pulumi.OutputState }

func (OgConfigTemplateValuesMappingArrayOutput) ElementType

func (OgConfigTemplateValuesMappingArrayOutput) Index

func (OgConfigTemplateValuesMappingArrayOutput) ToOgConfigTemplateValuesMappingArrayOutput

func (o OgConfigTemplateValuesMappingArrayOutput) ToOgConfigTemplateValuesMappingArrayOutput() OgConfigTemplateValuesMappingArrayOutput

func (OgConfigTemplateValuesMappingArrayOutput) ToOgConfigTemplateValuesMappingArrayOutputWithContext

func (o OgConfigTemplateValuesMappingArrayOutput) ToOgConfigTemplateValuesMappingArrayOutputWithContext(ctx context.Context) OgConfigTemplateValuesMappingArrayOutput

type OgConfigTemplateValuesMappingInput

type OgConfigTemplateValuesMappingInput interface {
	pulumi.Input

	ToOgConfigTemplateValuesMappingOutput() OgConfigTemplateValuesMappingOutput
	ToOgConfigTemplateValuesMappingOutputWithContext(context.Context) OgConfigTemplateValuesMappingOutput
}

OgConfigTemplateValuesMappingInput is an input type that accepts OgConfigTemplateValuesMappingArgs and OgConfigTemplateValuesMappingOutput values. You can construct a concrete instance of `OgConfigTemplateValuesMappingInput` via:

OgConfigTemplateValuesMappingArgs{...}

type OgConfigTemplateValuesMappingOutput

type OgConfigTemplateValuesMappingOutput struct{ *pulumi.OutputState }

func (OgConfigTemplateValuesMappingOutput) ElementType

func (OgConfigTemplateValuesMappingOutput) Fallback

Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.

func (OgConfigTemplateValuesMappingOutput) MetaKey

Source meta tag name, up to 136 characters. Supply exactly one of<span pulumi-lang-nodejs=" metaKey " pulumi-lang-dotnet=" MetaKey " pulumi-lang-go=" metaKey " pulumi-lang-python=" meta_key " pulumi-lang-yaml=" metaKey " pulumi-lang-java=" metaKey " pulumi-lang-hcl=" meta_key "> metaKey </span>or fallback.

func (OgConfigTemplateValuesMappingOutput) TemplateKey

Destination template field path, up to 128 characters. Paths must not overlap.

func (OgConfigTemplateValuesMappingOutput) ToOgConfigTemplateValuesMappingOutput

func (o OgConfigTemplateValuesMappingOutput) ToOgConfigTemplateValuesMappingOutput() OgConfigTemplateValuesMappingOutput

func (OgConfigTemplateValuesMappingOutput) ToOgConfigTemplateValuesMappingOutputWithContext

func (o OgConfigTemplateValuesMappingOutput) ToOgConfigTemplateValuesMappingOutputWithContext(ctx context.Context) OgConfigTemplateValuesMappingOutput

type Provider

type Provider struct {
	pulumi.ProviderResourceState

	// API ID. Falls back to HCTI_API_ID.
	ApiId pulumi.StringPtrOutput `pulumi:"apiId"`
	// API key. Falls back to HCTI_API_KEY.
	ApiKey pulumi.StringPtrOutput `pulumi:"apiKey"`
	// API origin. Defaults to https://hcti.io.
	BaseUrl pulumi.StringPtrOutput `pulumi:"baseUrl"`
}

The provider type for the html-css-to-image 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](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) TerraformConfig

func (r *Provider) TerraformConfig(ctx *pulumi.Context) (ProviderTerraformConfigResultOutput, error)

This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// API ID. Falls back to HCTI_API_ID.
	ApiId pulumi.StringPtrInput
	// API key. Falls back to HCTI_API_KEY.
	ApiKey pulumi.StringPtrInput
	// API origin. Defaults to https://hcti.io.
	BaseUrl pulumi.StringPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ApiId

API ID. Falls back to HCTI_API_ID.

func (ProviderOutput) ApiKey

API key. Falls back to HCTI_API_KEY.

func (ProviderOutput) BaseUrl

API origin. Defaults to https://hcti.io.

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderTerraformConfigResult

type ProviderTerraformConfigResult struct {
	Result map[string]interface{} `pulumi:"result"`
}

type ProviderTerraformConfigResultOutput

type ProviderTerraformConfigResultOutput struct{ *pulumi.OutputState }

func (ProviderTerraformConfigResultOutput) ElementType

func (ProviderTerraformConfigResultOutput) Result

type Proxy

type Proxy struct {
	pulumi.CustomResourceState

	// Proxy credentials. Omit the whole object to remove authentication.
	Authentication ProxyAuthenticationPtrOutput `pulumi:"authentication"`
	// Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
	BypassHosts pulumi.StringArrayOutput `pulumi:"bypassHosts"`
	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Disable the proxy. Defaults to false.
	Disabled pulumi.BoolOutput `pulumi:"disabled"`
	// Port returned by the API.
	EffectivePort pulumi.IntOutput `pulumi:"effectivePort"`
	// Display name, 3–500 characters after trimming.
	Name pulumi.StringOutput `pulumi:"name"`
	// Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
	Port pulumi.IntPtrOutput `pulumi:"port"`
	// Last update timestamp.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
	// HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
	Url pulumi.StringOutput `pulumi:"url"`
}

func GetProxy

func GetProxy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProxyState, opts ...pulumi.ResourceOption) (*Proxy, error)

GetProxy gets an existing Proxy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewProxy

func NewProxy(ctx *pulumi.Context,
	name string, args *ProxyArgs, opts ...pulumi.ResourceOption) (*Proxy, error)

NewProxy registers a new resource with the given unique name, arguments, and options.

func (*Proxy) ElementType

func (*Proxy) ElementType() reflect.Type

func (*Proxy) ToProxyOutput

func (i *Proxy) ToProxyOutput() ProxyOutput

func (*Proxy) ToProxyOutputWithContext

func (i *Proxy) ToProxyOutputWithContext(ctx context.Context) ProxyOutput

type ProxyArgs

type ProxyArgs struct {
	// Proxy credentials. Omit the whole object to remove authentication.
	Authentication ProxyAuthenticationPtrInput
	// Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
	BypassHosts pulumi.StringArrayInput
	// Disable the proxy. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// Display name, 3–500 characters after trimming.
	Name pulumi.StringInput
	// Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
	Port pulumi.IntPtrInput
	// HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
	Url pulumi.StringInput
}

The set of arguments for constructing a Proxy resource.

func (ProxyArgs) ElementType

func (ProxyArgs) ElementType() reflect.Type

type ProxyAuthentication

type ProxyAuthentication struct {
	// Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
	Password *string `pulumi:"password"`
	// Username, up to 512 characters. Empty is valid; whitespace is preserved.
	Username string `pulumi:"username"`
}

type ProxyAuthenticationArgs

type ProxyAuthenticationArgs struct {
	// Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
	Password pulumi.StringPtrInput `pulumi:"password"`
	// Username, up to 512 characters. Empty is valid; whitespace is preserved.
	Username pulumi.StringInput `pulumi:"username"`
}

func (ProxyAuthenticationArgs) ElementType

func (ProxyAuthenticationArgs) ElementType() reflect.Type

func (ProxyAuthenticationArgs) ToProxyAuthenticationOutput

func (i ProxyAuthenticationArgs) ToProxyAuthenticationOutput() ProxyAuthenticationOutput

func (ProxyAuthenticationArgs) ToProxyAuthenticationOutputWithContext

func (i ProxyAuthenticationArgs) ToProxyAuthenticationOutputWithContext(ctx context.Context) ProxyAuthenticationOutput

func (ProxyAuthenticationArgs) ToProxyAuthenticationPtrOutput

func (i ProxyAuthenticationArgs) ToProxyAuthenticationPtrOutput() ProxyAuthenticationPtrOutput

func (ProxyAuthenticationArgs) ToProxyAuthenticationPtrOutputWithContext

func (i ProxyAuthenticationArgs) ToProxyAuthenticationPtrOutputWithContext(ctx context.Context) ProxyAuthenticationPtrOutput

type ProxyAuthenticationInput

type ProxyAuthenticationInput interface {
	pulumi.Input

	ToProxyAuthenticationOutput() ProxyAuthenticationOutput
	ToProxyAuthenticationOutputWithContext(context.Context) ProxyAuthenticationOutput
}

ProxyAuthenticationInput is an input type that accepts ProxyAuthenticationArgs and ProxyAuthenticationOutput values. You can construct a concrete instance of `ProxyAuthenticationInput` via:

ProxyAuthenticationArgs{...}

type ProxyAuthenticationOutput

type ProxyAuthenticationOutput struct{ *pulumi.OutputState }

func (ProxyAuthenticationOutput) ElementType

func (ProxyAuthenticationOutput) ElementType() reflect.Type

func (ProxyAuthenticationOutput) Password

Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.

func (ProxyAuthenticationOutput) ToProxyAuthenticationOutput

func (o ProxyAuthenticationOutput) ToProxyAuthenticationOutput() ProxyAuthenticationOutput

func (ProxyAuthenticationOutput) ToProxyAuthenticationOutputWithContext

func (o ProxyAuthenticationOutput) ToProxyAuthenticationOutputWithContext(ctx context.Context) ProxyAuthenticationOutput

func (ProxyAuthenticationOutput) ToProxyAuthenticationPtrOutput

func (o ProxyAuthenticationOutput) ToProxyAuthenticationPtrOutput() ProxyAuthenticationPtrOutput

func (ProxyAuthenticationOutput) ToProxyAuthenticationPtrOutputWithContext

func (o ProxyAuthenticationOutput) ToProxyAuthenticationPtrOutputWithContext(ctx context.Context) ProxyAuthenticationPtrOutput

func (ProxyAuthenticationOutput) Username

Username, up to 512 characters. Empty is valid; whitespace is preserved.

type ProxyAuthenticationPtrInput

type ProxyAuthenticationPtrInput interface {
	pulumi.Input

	ToProxyAuthenticationPtrOutput() ProxyAuthenticationPtrOutput
	ToProxyAuthenticationPtrOutputWithContext(context.Context) ProxyAuthenticationPtrOutput
}

ProxyAuthenticationPtrInput is an input type that accepts ProxyAuthenticationArgs, ProxyAuthenticationPtr and ProxyAuthenticationPtrOutput values. You can construct a concrete instance of `ProxyAuthenticationPtrInput` via:

        ProxyAuthenticationArgs{...}

or:

        nil

type ProxyAuthenticationPtrOutput

type ProxyAuthenticationPtrOutput struct{ *pulumi.OutputState }

func (ProxyAuthenticationPtrOutput) Elem

func (ProxyAuthenticationPtrOutput) ElementType

func (ProxyAuthenticationPtrOutput) Password

Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.

func (ProxyAuthenticationPtrOutput) ToProxyAuthenticationPtrOutput

func (o ProxyAuthenticationPtrOutput) ToProxyAuthenticationPtrOutput() ProxyAuthenticationPtrOutput

func (ProxyAuthenticationPtrOutput) ToProxyAuthenticationPtrOutputWithContext

func (o ProxyAuthenticationPtrOutput) ToProxyAuthenticationPtrOutputWithContext(ctx context.Context) ProxyAuthenticationPtrOutput

func (ProxyAuthenticationPtrOutput) Username

Username, up to 512 characters. Empty is valid; whitespace is preserved.

type ProxyInput

type ProxyInput interface {
	pulumi.Input

	ToProxyOutput() ProxyOutput
	ToProxyOutputWithContext(ctx context.Context) ProxyOutput
}

type ProxyOutput

type ProxyOutput struct{ *pulumi.OutputState }

func (ProxyOutput) Authentication

func (o ProxyOutput) Authentication() ProxyAuthenticationPtrOutput

Proxy credentials. Omit the whole object to remove authentication.

func (ProxyOutput) BypassHosts

func (o ProxyOutput) BypassHosts() pulumi.StringArrayOutput

Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.

func (ProxyOutput) CreatedAt

func (o ProxyOutput) CreatedAt() pulumi.StringOutput

Creation timestamp.

func (ProxyOutput) Disabled

func (o ProxyOutput) Disabled() pulumi.BoolOutput

Disable the proxy. Defaults to false.

func (ProxyOutput) EffectivePort

func (o ProxyOutput) EffectivePort() pulumi.IntOutput

Port returned by the API.

func (ProxyOutput) ElementType

func (ProxyOutput) ElementType() reflect.Type

func (ProxyOutput) Name

func (o ProxyOutput) Name() pulumi.StringOutput

Display name, 3–500 characters after trimming.

func (ProxyOutput) Port

func (o ProxyOutput) Port() pulumi.IntPtrOutput

Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.

func (ProxyOutput) ToProxyOutput

func (o ProxyOutput) ToProxyOutput() ProxyOutput

func (ProxyOutput) ToProxyOutputWithContext

func (o ProxyOutput) ToProxyOutputWithContext(ctx context.Context) ProxyOutput

func (ProxyOutput) UpdatedAt

func (o ProxyOutput) UpdatedAt() pulumi.StringOutput

Last update timestamp.

func (ProxyOutput) Url

HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.

type ProxyState

type ProxyState struct {
	// Proxy credentials. Omit the whole object to remove authentication.
	Authentication ProxyAuthenticationPtrInput
	// Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
	BypassHosts pulumi.StringArrayInput
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// Disable the proxy. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// Port returned by the API.
	EffectivePort pulumi.IntPtrInput
	// Display name, 3–500 characters after trimming.
	Name pulumi.StringPtrInput
	// Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
	Port pulumi.IntPtrInput
	// Last update timestamp.
	UpdatedAt pulumi.StringPtrInput
	// HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
	Url pulumi.StringPtrInput
}

func (ProxyState) ElementType

func (ProxyState) ElementType() reflect.Type

type RequestOverrideResourceType added in v0.2.0

type RequestOverrideResourceType string

Browser resource type matched by a request override rule.

func (RequestOverrideResourceType) ElementType added in v0.2.0

func (RequestOverrideResourceType) ToRequestOverrideResourceTypeOutput added in v0.2.0

func (e RequestOverrideResourceType) ToRequestOverrideResourceTypeOutput() RequestOverrideResourceTypeOutput

func (RequestOverrideResourceType) ToRequestOverrideResourceTypeOutputWithContext added in v0.2.0

func (e RequestOverrideResourceType) ToRequestOverrideResourceTypeOutputWithContext(ctx context.Context) RequestOverrideResourceTypeOutput

func (RequestOverrideResourceType) ToRequestOverrideResourceTypePtrOutput added in v0.2.0

func (e RequestOverrideResourceType) ToRequestOverrideResourceTypePtrOutput() RequestOverrideResourceTypePtrOutput

func (RequestOverrideResourceType) ToRequestOverrideResourceTypePtrOutputWithContext added in v0.2.0

func (e RequestOverrideResourceType) ToRequestOverrideResourceTypePtrOutputWithContext(ctx context.Context) RequestOverrideResourceTypePtrOutput

func (RequestOverrideResourceType) ToStringOutput added in v0.2.0

func (e RequestOverrideResourceType) ToStringOutput() pulumi.StringOutput

func (RequestOverrideResourceType) ToStringOutputWithContext added in v0.2.0

func (e RequestOverrideResourceType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RequestOverrideResourceType) ToStringPtrOutput added in v0.2.0

func (e RequestOverrideResourceType) ToStringPtrOutput() pulumi.StringPtrOutput

func (RequestOverrideResourceType) ToStringPtrOutputWithContext added in v0.2.0

func (e RequestOverrideResourceType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RequestOverrideResourceTypeArray added in v0.2.0

type RequestOverrideResourceTypeArray []RequestOverrideResourceType

func (RequestOverrideResourceTypeArray) ElementType added in v0.2.0

func (RequestOverrideResourceTypeArray) ToRequestOverrideResourceTypeArrayOutput added in v0.2.0

func (i RequestOverrideResourceTypeArray) ToRequestOverrideResourceTypeArrayOutput() RequestOverrideResourceTypeArrayOutput

func (RequestOverrideResourceTypeArray) ToRequestOverrideResourceTypeArrayOutputWithContext added in v0.2.0

func (i RequestOverrideResourceTypeArray) ToRequestOverrideResourceTypeArrayOutputWithContext(ctx context.Context) RequestOverrideResourceTypeArrayOutput

type RequestOverrideResourceTypeArrayInput added in v0.2.0

type RequestOverrideResourceTypeArrayInput interface {
	pulumi.Input

	ToRequestOverrideResourceTypeArrayOutput() RequestOverrideResourceTypeArrayOutput
	ToRequestOverrideResourceTypeArrayOutputWithContext(context.Context) RequestOverrideResourceTypeArrayOutput
}

RequestOverrideResourceTypeArrayInput is an input type that accepts RequestOverrideResourceTypeArray and RequestOverrideResourceTypeArrayOutput values. You can construct a concrete instance of `RequestOverrideResourceTypeArrayInput` via:

RequestOverrideResourceTypeArray{ RequestOverrideResourceTypeArgs{...} }

type RequestOverrideResourceTypeArrayOutput added in v0.2.0

type RequestOverrideResourceTypeArrayOutput struct{ *pulumi.OutputState }

func (RequestOverrideResourceTypeArrayOutput) ElementType added in v0.2.0

func (RequestOverrideResourceTypeArrayOutput) Index added in v0.2.0

func (RequestOverrideResourceTypeArrayOutput) ToRequestOverrideResourceTypeArrayOutput added in v0.2.0

func (o RequestOverrideResourceTypeArrayOutput) ToRequestOverrideResourceTypeArrayOutput() RequestOverrideResourceTypeArrayOutput

func (RequestOverrideResourceTypeArrayOutput) ToRequestOverrideResourceTypeArrayOutputWithContext added in v0.2.0

func (o RequestOverrideResourceTypeArrayOutput) ToRequestOverrideResourceTypeArrayOutputWithContext(ctx context.Context) RequestOverrideResourceTypeArrayOutput

type RequestOverrideResourceTypeInput added in v0.2.0

type RequestOverrideResourceTypeInput interface {
	pulumi.Input

	ToRequestOverrideResourceTypeOutput() RequestOverrideResourceTypeOutput
	ToRequestOverrideResourceTypeOutputWithContext(context.Context) RequestOverrideResourceTypeOutput
}

RequestOverrideResourceTypeInput is an input type that accepts values of the RequestOverrideResourceType enum A concrete instance of `RequestOverrideResourceTypeInput` can be one of the following:

RequestOverrideResourceTypeBeacon
RequestOverrideResourceTypeDocument
RequestOverrideResourceTypeStylesheet
RequestOverrideResourceTypeImage
RequestOverrideResourceTypeImageSet
RequestOverrideResourceTypeMedia
RequestOverrideResourceTypeFont
RequestOverrideResourceTypeScript
RequestOverrideResourceTypeTextTrack
RequestOverrideResourceTypeXhr
RequestOverrideResourceTypeFetch
RequestOverrideResourceTypeEventSource
RequestOverrideResourceTypeManifest
RequestOverrideResourceTypePing
RequestOverrideResourceTypeImg
RequestOverrideResourceTypeOther

type RequestOverrideResourceTypeOutput added in v0.2.0

type RequestOverrideResourceTypeOutput struct{ *pulumi.OutputState }

func (RequestOverrideResourceTypeOutput) ElementType added in v0.2.0

func (RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypeOutput added in v0.2.0

func (o RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypeOutput() RequestOverrideResourceTypeOutput

func (RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypeOutputWithContext added in v0.2.0

func (o RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypeOutputWithContext(ctx context.Context) RequestOverrideResourceTypeOutput

func (RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypePtrOutput added in v0.2.0

func (o RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypePtrOutput() RequestOverrideResourceTypePtrOutput

func (RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypePtrOutputWithContext added in v0.2.0

func (o RequestOverrideResourceTypeOutput) ToRequestOverrideResourceTypePtrOutputWithContext(ctx context.Context) RequestOverrideResourceTypePtrOutput

func (RequestOverrideResourceTypeOutput) ToStringOutput added in v0.2.0

func (RequestOverrideResourceTypeOutput) ToStringOutputWithContext added in v0.2.0

func (o RequestOverrideResourceTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RequestOverrideResourceTypeOutput) ToStringPtrOutput added in v0.2.0

func (RequestOverrideResourceTypeOutput) ToStringPtrOutputWithContext added in v0.2.0

func (o RequestOverrideResourceTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RequestOverrideResourceTypePtrInput added in v0.2.0

type RequestOverrideResourceTypePtrInput interface {
	pulumi.Input

	ToRequestOverrideResourceTypePtrOutput() RequestOverrideResourceTypePtrOutput
	ToRequestOverrideResourceTypePtrOutputWithContext(context.Context) RequestOverrideResourceTypePtrOutput
}

func RequestOverrideResourceTypePtr added in v0.2.0

func RequestOverrideResourceTypePtr(v string) RequestOverrideResourceTypePtrInput

type RequestOverrideResourceTypePtrOutput added in v0.2.0

type RequestOverrideResourceTypePtrOutput struct{ *pulumi.OutputState }

func (RequestOverrideResourceTypePtrOutput) Elem added in v0.2.0

func (RequestOverrideResourceTypePtrOutput) ElementType added in v0.2.0

func (RequestOverrideResourceTypePtrOutput) ToRequestOverrideResourceTypePtrOutput added in v0.2.0

func (o RequestOverrideResourceTypePtrOutput) ToRequestOverrideResourceTypePtrOutput() RequestOverrideResourceTypePtrOutput

func (RequestOverrideResourceTypePtrOutput) ToRequestOverrideResourceTypePtrOutputWithContext added in v0.2.0

func (o RequestOverrideResourceTypePtrOutput) ToRequestOverrideResourceTypePtrOutputWithContext(ctx context.Context) RequestOverrideResourceTypePtrOutput

func (RequestOverrideResourceTypePtrOutput) ToStringPtrOutput added in v0.2.0

func (RequestOverrideResourceTypePtrOutput) ToStringPtrOutputWithContext added in v0.2.0

func (o RequestOverrideResourceTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type StorageDestination

type StorageDestination struct {
	pulumi.CustomResourceState

	// Set exactly one provider object: aws_s3, cloudflare_r2, backblaze_b2, digitalocean_spaces, wasabi, google_cloud_storage, or other_s3_compatible. Switching objects updates in place.
	ConnectionInfo StorageDestinationConnectionInfoOutput `pulumi:"connectionInfo"`
	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Disable this destination for new renders. Defaults to false.
	Disabled pulumi.BoolOutput `pulumi:"disabled"`
	// Store output only at this destination. Defaults to false. True requires authenticated /store rendering and supplies no public HCTI CDN URL.
	HctiStorageDisabled pulumi.BoolOutput `pulumi:"hctiStorageDisabled"`
	// Latest API connection test error, or null. Marked sensitive because it is external service diagnostic text.
	LastTestError pulumi.StringOutput `pulumi:"lastTestError"`
	// Latest API connection test result, or null.
	LastTestSucceeded pulumi.BoolOutput `pulumi:"lastTestSucceeded"`
	// Timestamp of the latest API connection test, or null. Refresh does not run tests.
	LastTestedAt pulumi.StringOutput `pulumi:"lastTestedAt"`
	// Display name, 3–255 characters after trimming.
	Name pulumi.StringOutput `pulumi:"name"`
	// Last update timestamp.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

func GetStorageDestination

func GetStorageDestination(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *StorageDestinationState, opts ...pulumi.ResourceOption) (*StorageDestination, error)

GetStorageDestination gets an existing StorageDestination resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewStorageDestination

func NewStorageDestination(ctx *pulumi.Context,
	name string, args *StorageDestinationArgs, opts ...pulumi.ResourceOption) (*StorageDestination, error)

NewStorageDestination registers a new resource with the given unique name, arguments, and options.

func (*StorageDestination) ElementType

func (*StorageDestination) ElementType() reflect.Type

func (*StorageDestination) ToStorageDestinationOutput

func (i *StorageDestination) ToStorageDestinationOutput() StorageDestinationOutput

func (*StorageDestination) ToStorageDestinationOutputWithContext

func (i *StorageDestination) ToStorageDestinationOutputWithContext(ctx context.Context) StorageDestinationOutput

type StorageDestinationArgs

type StorageDestinationArgs struct {
	// Set exactly one provider object: aws_s3, cloudflare_r2, backblaze_b2, digitalocean_spaces, wasabi, google_cloud_storage, or other_s3_compatible. Switching objects updates in place.
	ConnectionInfo StorageDestinationConnectionInfoInput
	// Disable this destination for new renders. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// Store output only at this destination. Defaults to false. True requires authenticated /store rendering and supplies no public HCTI CDN URL.
	HctiStorageDisabled pulumi.BoolPtrInput
	// Display name, 3–255 characters after trimming.
	Name pulumi.StringInput
}

The set of arguments for constructing a StorageDestination resource.

func (StorageDestinationArgs) ElementType

func (StorageDestinationArgs) ElementType() reflect.Type

type StorageDestinationConnectionInfo

type StorageDestinationConnectionInfo struct {
	// Connection settings for aws_s3. Set exactly one provider object inside connection_info.
	AwsS3 *StorageDestinationConnectionInfoAwsS3 `pulumi:"awsS3"`
	// Connection settings for backblaze_b2. Set exactly one provider object inside connection_info.
	BackblazeB2 *StorageDestinationConnectionInfoBackblazeB2 `pulumi:"backblazeB2"`
	// Connection settings for cloudflare_r2. Set exactly one provider object inside connection_info.
	CloudflareR2 *StorageDestinationConnectionInfoCloudflareR2 `pulumi:"cloudflareR2"`
	// Connection settings for digitalocean_spaces. Set exactly one provider object inside connection_info.
	DigitaloceanSpaces *StorageDestinationConnectionInfoDigitaloceanSpaces `pulumi:"digitaloceanSpaces"`
	// Connection settings for google_cloud_storage. Set exactly one provider object inside connection_info.
	GoogleCloudStorage *StorageDestinationConnectionInfoGoogleCloudStorage `pulumi:"googleCloudStorage"`
	// Connection settings for other_s3_compatible. Set exactly one provider object inside connection_info.
	OtherS3Compatible *StorageDestinationConnectionInfoOtherS3Compatible `pulumi:"otherS3Compatible"`
	// Connection settings for wasabi. Set exactly one provider object inside connection_info.
	Wasabi *StorageDestinationConnectionInfoWasabi `pulumi:"wasabi"`
}

type StorageDestinationConnectionInfoArgs

type StorageDestinationConnectionInfoArgs struct {
	// Connection settings for aws_s3. Set exactly one provider object inside connection_info.
	AwsS3 StorageDestinationConnectionInfoAwsS3PtrInput `pulumi:"awsS3"`
	// Connection settings for backblaze_b2. Set exactly one provider object inside connection_info.
	BackblazeB2 StorageDestinationConnectionInfoBackblazeB2PtrInput `pulumi:"backblazeB2"`
	// Connection settings for cloudflare_r2. Set exactly one provider object inside connection_info.
	CloudflareR2 StorageDestinationConnectionInfoCloudflareR2PtrInput `pulumi:"cloudflareR2"`
	// Connection settings for digitalocean_spaces. Set exactly one provider object inside connection_info.
	DigitaloceanSpaces StorageDestinationConnectionInfoDigitaloceanSpacesPtrInput `pulumi:"digitaloceanSpaces"`
	// Connection settings for google_cloud_storage. Set exactly one provider object inside connection_info.
	GoogleCloudStorage StorageDestinationConnectionInfoGoogleCloudStoragePtrInput `pulumi:"googleCloudStorage"`
	// Connection settings for other_s3_compatible. Set exactly one provider object inside connection_info.
	OtherS3Compatible StorageDestinationConnectionInfoOtherS3CompatiblePtrInput `pulumi:"otherS3Compatible"`
	// Connection settings for wasabi. Set exactly one provider object inside connection_info.
	Wasabi StorageDestinationConnectionInfoWasabiPtrInput `pulumi:"wasabi"`
}

func (StorageDestinationConnectionInfoArgs) ElementType

func (StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoOutput

func (i StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoOutput() StorageDestinationConnectionInfoOutput

func (StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoOutputWithContext

func (i StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoOutput

func (StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoPtrOutput

func (i StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoPtrOutput() StorageDestinationConnectionInfoPtrOutput

func (StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoPtrOutputWithContext

func (i StorageDestinationConnectionInfoArgs) ToStorageDestinationConnectionInfoPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoPtrOutput

type StorageDestinationConnectionInfoAwsS3

type StorageDestinationConnectionInfoAwsS3 struct {
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket string `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix *string `pulumi:"keyPrefix"`
	// Bucket region supported by aws_s3.
	Region string `pulumi:"region"`
	// AWS only. IAM role ARN, up to 2048 characters. Configure the organization external ID in its trust policy before saving.
	RoleArn string `pulumi:"roleArn"`
}

type StorageDestinationConnectionInfoAwsS3Args

type StorageDestinationConnectionInfoAwsS3Args struct {
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket pulumi.StringInput `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix pulumi.StringPtrInput `pulumi:"keyPrefix"`
	// Bucket region supported by aws_s3.
	Region pulumi.StringInput `pulumi:"region"`
	// AWS only. IAM role ARN, up to 2048 characters. Configure the organization external ID in its trust policy before saving.
	RoleArn pulumi.StringInput `pulumi:"roleArn"`
}

func (StorageDestinationConnectionInfoAwsS3Args) ElementType

func (StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3Output

func (i StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3Output() StorageDestinationConnectionInfoAwsS3Output

func (StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3OutputWithContext

func (i StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3OutputWithContext(ctx context.Context) StorageDestinationConnectionInfoAwsS3Output

func (StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3PtrOutput

func (i StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3PtrOutput() StorageDestinationConnectionInfoAwsS3PtrOutput

func (StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3PtrOutputWithContext

func (i StorageDestinationConnectionInfoAwsS3Args) ToStorageDestinationConnectionInfoAwsS3PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoAwsS3PtrOutput

type StorageDestinationConnectionInfoAwsS3Input

type StorageDestinationConnectionInfoAwsS3Input interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoAwsS3Output() StorageDestinationConnectionInfoAwsS3Output
	ToStorageDestinationConnectionInfoAwsS3OutputWithContext(context.Context) StorageDestinationConnectionInfoAwsS3Output
}

StorageDestinationConnectionInfoAwsS3Input is an input type that accepts StorageDestinationConnectionInfoAwsS3Args and StorageDestinationConnectionInfoAwsS3Output values. You can construct a concrete instance of `StorageDestinationConnectionInfoAwsS3Input` via:

StorageDestinationConnectionInfoAwsS3Args{...}

type StorageDestinationConnectionInfoAwsS3Output

type StorageDestinationConnectionInfoAwsS3Output struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoAwsS3Output) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoAwsS3Output) ElementType

func (StorageDestinationConnectionInfoAwsS3Output) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoAwsS3Output) Region

Bucket region supported by aws_s3.

func (StorageDestinationConnectionInfoAwsS3Output) RoleArn

AWS only. IAM role ARN, up to 2048 characters. Configure the organization external ID in its trust policy before saving.

func (StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3Output

func (o StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3Output() StorageDestinationConnectionInfoAwsS3Output

func (StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3OutputWithContext

func (o StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3OutputWithContext(ctx context.Context) StorageDestinationConnectionInfoAwsS3Output

func (StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3PtrOutput

func (o StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3PtrOutput() StorageDestinationConnectionInfoAwsS3PtrOutput

func (StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3PtrOutputWithContext

func (o StorageDestinationConnectionInfoAwsS3Output) ToStorageDestinationConnectionInfoAwsS3PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoAwsS3PtrOutput

type StorageDestinationConnectionInfoAwsS3PtrInput

type StorageDestinationConnectionInfoAwsS3PtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoAwsS3PtrOutput() StorageDestinationConnectionInfoAwsS3PtrOutput
	ToStorageDestinationConnectionInfoAwsS3PtrOutputWithContext(context.Context) StorageDestinationConnectionInfoAwsS3PtrOutput
}

StorageDestinationConnectionInfoAwsS3PtrInput is an input type that accepts StorageDestinationConnectionInfoAwsS3Args, StorageDestinationConnectionInfoAwsS3Ptr and StorageDestinationConnectionInfoAwsS3PtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoAwsS3PtrInput` via:

        StorageDestinationConnectionInfoAwsS3Args{...}

or:

        nil

type StorageDestinationConnectionInfoAwsS3PtrOutput

type StorageDestinationConnectionInfoAwsS3PtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoAwsS3PtrOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoAwsS3PtrOutput) Elem

func (StorageDestinationConnectionInfoAwsS3PtrOutput) ElementType

func (StorageDestinationConnectionInfoAwsS3PtrOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoAwsS3PtrOutput) Region

Bucket region supported by aws_s3.

func (StorageDestinationConnectionInfoAwsS3PtrOutput) RoleArn

AWS only. IAM role ARN, up to 2048 characters. Configure the organization external ID in its trust policy before saving.

func (StorageDestinationConnectionInfoAwsS3PtrOutput) ToStorageDestinationConnectionInfoAwsS3PtrOutput

func (o StorageDestinationConnectionInfoAwsS3PtrOutput) ToStorageDestinationConnectionInfoAwsS3PtrOutput() StorageDestinationConnectionInfoAwsS3PtrOutput

func (StorageDestinationConnectionInfoAwsS3PtrOutput) ToStorageDestinationConnectionInfoAwsS3PtrOutputWithContext

func (o StorageDestinationConnectionInfoAwsS3PtrOutput) ToStorageDestinationConnectionInfoAwsS3PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoAwsS3PtrOutput

type StorageDestinationConnectionInfoBackblazeB2

type StorageDestinationConnectionInfoBackblazeB2 struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId string `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket string `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix *string `pulumi:"keyPrefix"`
	// Bucket region supported by backblaze_b2.
	Region string `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey *string `pulumi:"secretAccessKey"`
}

type StorageDestinationConnectionInfoBackblazeB2Args

type StorageDestinationConnectionInfoBackblazeB2Args struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId pulumi.StringInput `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket pulumi.StringInput `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix pulumi.StringPtrInput `pulumi:"keyPrefix"`
	// Bucket region supported by backblaze_b2.
	Region pulumi.StringInput `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey pulumi.StringPtrInput `pulumi:"secretAccessKey"`
}

func (StorageDestinationConnectionInfoBackblazeB2Args) ElementType

func (StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2Output

func (i StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2Output() StorageDestinationConnectionInfoBackblazeB2Output

func (StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2OutputWithContext

func (i StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2OutputWithContext(ctx context.Context) StorageDestinationConnectionInfoBackblazeB2Output

func (StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2PtrOutput

func (i StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2PtrOutput() StorageDestinationConnectionInfoBackblazeB2PtrOutput

func (StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2PtrOutputWithContext

func (i StorageDestinationConnectionInfoBackblazeB2Args) ToStorageDestinationConnectionInfoBackblazeB2PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoBackblazeB2PtrOutput

type StorageDestinationConnectionInfoBackblazeB2Input

type StorageDestinationConnectionInfoBackblazeB2Input interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoBackblazeB2Output() StorageDestinationConnectionInfoBackblazeB2Output
	ToStorageDestinationConnectionInfoBackblazeB2OutputWithContext(context.Context) StorageDestinationConnectionInfoBackblazeB2Output
}

StorageDestinationConnectionInfoBackblazeB2Input is an input type that accepts StorageDestinationConnectionInfoBackblazeB2Args and StorageDestinationConnectionInfoBackblazeB2Output values. You can construct a concrete instance of `StorageDestinationConnectionInfoBackblazeB2Input` via:

StorageDestinationConnectionInfoBackblazeB2Args{...}

type StorageDestinationConnectionInfoBackblazeB2Output

type StorageDestinationConnectionInfoBackblazeB2Output struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoBackblazeB2Output) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoBackblazeB2Output) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoBackblazeB2Output) ElementType

func (StorageDestinationConnectionInfoBackblazeB2Output) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoBackblazeB2Output) Region

Bucket region supported by backblaze_b2.

func (StorageDestinationConnectionInfoBackblazeB2Output) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2Output

func (o StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2Output() StorageDestinationConnectionInfoBackblazeB2Output

func (StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2OutputWithContext

func (o StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2OutputWithContext(ctx context.Context) StorageDestinationConnectionInfoBackblazeB2Output

func (StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2PtrOutput

func (o StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2PtrOutput() StorageDestinationConnectionInfoBackblazeB2PtrOutput

func (StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2PtrOutputWithContext

func (o StorageDestinationConnectionInfoBackblazeB2Output) ToStorageDestinationConnectionInfoBackblazeB2PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoBackblazeB2PtrOutput

type StorageDestinationConnectionInfoBackblazeB2PtrInput

type StorageDestinationConnectionInfoBackblazeB2PtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoBackblazeB2PtrOutput() StorageDestinationConnectionInfoBackblazeB2PtrOutput
	ToStorageDestinationConnectionInfoBackblazeB2PtrOutputWithContext(context.Context) StorageDestinationConnectionInfoBackblazeB2PtrOutput
}

StorageDestinationConnectionInfoBackblazeB2PtrInput is an input type that accepts StorageDestinationConnectionInfoBackblazeB2Args, StorageDestinationConnectionInfoBackblazeB2Ptr and StorageDestinationConnectionInfoBackblazeB2PtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoBackblazeB2PtrInput` via:

        StorageDestinationConnectionInfoBackblazeB2Args{...}

or:

        nil

type StorageDestinationConnectionInfoBackblazeB2PtrOutput

type StorageDestinationConnectionInfoBackblazeB2PtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) Elem

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) ElementType

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) Region

Bucket region supported by backblaze_b2.

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) ToStorageDestinationConnectionInfoBackblazeB2PtrOutput

func (StorageDestinationConnectionInfoBackblazeB2PtrOutput) ToStorageDestinationConnectionInfoBackblazeB2PtrOutputWithContext

func (o StorageDestinationConnectionInfoBackblazeB2PtrOutput) ToStorageDestinationConnectionInfoBackblazeB2PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoBackblazeB2PtrOutput

type StorageDestinationConnectionInfoCloudflareR2

type StorageDestinationConnectionInfoCloudflareR2 struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId string `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket string `pulumi:"bucket"`
	// R2 only. Required 32-character hexadecimal account ID.
	CloudflareAccountId string `pulumi:"cloudflareAccountId"`
	// R2 only. eu or fedramp; omit for default jurisdiction.
	CloudflareJurisdiction *string `pulumi:"cloudflareJurisdiction"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix *string `pulumi:"keyPrefix"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey *string `pulumi:"secretAccessKey"`
}

type StorageDestinationConnectionInfoCloudflareR2Args

type StorageDestinationConnectionInfoCloudflareR2Args struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId pulumi.StringInput `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket pulumi.StringInput `pulumi:"bucket"`
	// R2 only. Required 32-character hexadecimal account ID.
	CloudflareAccountId pulumi.StringInput `pulumi:"cloudflareAccountId"`
	// R2 only. eu or fedramp; omit for default jurisdiction.
	CloudflareJurisdiction pulumi.StringPtrInput `pulumi:"cloudflareJurisdiction"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix pulumi.StringPtrInput `pulumi:"keyPrefix"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey pulumi.StringPtrInput `pulumi:"secretAccessKey"`
}

func (StorageDestinationConnectionInfoCloudflareR2Args) ElementType

func (StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2Output

func (i StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2Output() StorageDestinationConnectionInfoCloudflareR2Output

func (StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2OutputWithContext

func (i StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2OutputWithContext(ctx context.Context) StorageDestinationConnectionInfoCloudflareR2Output

func (StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2PtrOutput

func (i StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2PtrOutput() StorageDestinationConnectionInfoCloudflareR2PtrOutput

func (StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2PtrOutputWithContext

func (i StorageDestinationConnectionInfoCloudflareR2Args) ToStorageDestinationConnectionInfoCloudflareR2PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoCloudflareR2PtrOutput

type StorageDestinationConnectionInfoCloudflareR2Input

type StorageDestinationConnectionInfoCloudflareR2Input interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoCloudflareR2Output() StorageDestinationConnectionInfoCloudflareR2Output
	ToStorageDestinationConnectionInfoCloudflareR2OutputWithContext(context.Context) StorageDestinationConnectionInfoCloudflareR2Output
}

StorageDestinationConnectionInfoCloudflareR2Input is an input type that accepts StorageDestinationConnectionInfoCloudflareR2Args and StorageDestinationConnectionInfoCloudflareR2Output values. You can construct a concrete instance of `StorageDestinationConnectionInfoCloudflareR2Input` via:

StorageDestinationConnectionInfoCloudflareR2Args{...}

type StorageDestinationConnectionInfoCloudflareR2Output

type StorageDestinationConnectionInfoCloudflareR2Output struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoCloudflareR2Output) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoCloudflareR2Output) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoCloudflareR2Output) CloudflareAccountId

R2 only. Required 32-character hexadecimal account ID.

func (StorageDestinationConnectionInfoCloudflareR2Output) CloudflareJurisdiction

R2 only. eu or fedramp; omit for default jurisdiction.

func (StorageDestinationConnectionInfoCloudflareR2Output) ElementType

func (StorageDestinationConnectionInfoCloudflareR2Output) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoCloudflareR2Output) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2Output

func (o StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2Output() StorageDestinationConnectionInfoCloudflareR2Output

func (StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2OutputWithContext

func (o StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2OutputWithContext(ctx context.Context) StorageDestinationConnectionInfoCloudflareR2Output

func (StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2PtrOutput

func (o StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2PtrOutput() StorageDestinationConnectionInfoCloudflareR2PtrOutput

func (StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2PtrOutputWithContext

func (o StorageDestinationConnectionInfoCloudflareR2Output) ToStorageDestinationConnectionInfoCloudflareR2PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoCloudflareR2PtrOutput

type StorageDestinationConnectionInfoCloudflareR2PtrInput

type StorageDestinationConnectionInfoCloudflareR2PtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoCloudflareR2PtrOutput() StorageDestinationConnectionInfoCloudflareR2PtrOutput
	ToStorageDestinationConnectionInfoCloudflareR2PtrOutputWithContext(context.Context) StorageDestinationConnectionInfoCloudflareR2PtrOutput
}

StorageDestinationConnectionInfoCloudflareR2PtrInput is an input type that accepts StorageDestinationConnectionInfoCloudflareR2Args, StorageDestinationConnectionInfoCloudflareR2Ptr and StorageDestinationConnectionInfoCloudflareR2PtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoCloudflareR2PtrInput` via:

        StorageDestinationConnectionInfoCloudflareR2Args{...}

or:

        nil

type StorageDestinationConnectionInfoCloudflareR2PtrOutput

type StorageDestinationConnectionInfoCloudflareR2PtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) CloudflareAccountId

R2 only. Required 32-character hexadecimal account ID.

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) CloudflareJurisdiction

R2 only. eu or fedramp; omit for default jurisdiction.

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) Elem

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) ElementType

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) ToStorageDestinationConnectionInfoCloudflareR2PtrOutput

func (StorageDestinationConnectionInfoCloudflareR2PtrOutput) ToStorageDestinationConnectionInfoCloudflareR2PtrOutputWithContext

func (o StorageDestinationConnectionInfoCloudflareR2PtrOutput) ToStorageDestinationConnectionInfoCloudflareR2PtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoCloudflareR2PtrOutput

type StorageDestinationConnectionInfoDigitaloceanSpaces

type StorageDestinationConnectionInfoDigitaloceanSpaces struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId string `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket string `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix *string `pulumi:"keyPrefix"`
	// Bucket region supported by digitalocean_spaces.
	Region string `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey *string `pulumi:"secretAccessKey"`
}

type StorageDestinationConnectionInfoDigitaloceanSpacesArgs

type StorageDestinationConnectionInfoDigitaloceanSpacesArgs struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId pulumi.StringInput `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket pulumi.StringInput `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix pulumi.StringPtrInput `pulumi:"keyPrefix"`
	// Bucket region supported by digitalocean_spaces.
	Region pulumi.StringInput `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey pulumi.StringPtrInput `pulumi:"secretAccessKey"`
}

func (StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ElementType

func (StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ToStorageDestinationConnectionInfoDigitaloceanSpacesOutput

func (StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ToStorageDestinationConnectionInfoDigitaloceanSpacesOutputWithContext

func (i StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ToStorageDestinationConnectionInfoDigitaloceanSpacesOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoDigitaloceanSpacesOutput

func (StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

func (i StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput() StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

func (StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutputWithContext

func (i StorageDestinationConnectionInfoDigitaloceanSpacesArgs) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

type StorageDestinationConnectionInfoDigitaloceanSpacesInput

type StorageDestinationConnectionInfoDigitaloceanSpacesInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoDigitaloceanSpacesOutput() StorageDestinationConnectionInfoDigitaloceanSpacesOutput
	ToStorageDestinationConnectionInfoDigitaloceanSpacesOutputWithContext(context.Context) StorageDestinationConnectionInfoDigitaloceanSpacesOutput
}

StorageDestinationConnectionInfoDigitaloceanSpacesInput is an input type that accepts StorageDestinationConnectionInfoDigitaloceanSpacesArgs and StorageDestinationConnectionInfoDigitaloceanSpacesOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoDigitaloceanSpacesInput` via:

StorageDestinationConnectionInfoDigitaloceanSpacesArgs{...}

type StorageDestinationConnectionInfoDigitaloceanSpacesOutput

type StorageDestinationConnectionInfoDigitaloceanSpacesOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) ElementType

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) Region

Bucket region supported by digitalocean_spaces.

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesOutput

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesOutputWithContext

func (o StorageDestinationConnectionInfoDigitaloceanSpacesOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoDigitaloceanSpacesOutput

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

func (StorageDestinationConnectionInfoDigitaloceanSpacesOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutputWithContext

func (o StorageDestinationConnectionInfoDigitaloceanSpacesOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

type StorageDestinationConnectionInfoDigitaloceanSpacesPtrInput

type StorageDestinationConnectionInfoDigitaloceanSpacesPtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput() StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput
	ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutputWithContext(context.Context) StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput
}

StorageDestinationConnectionInfoDigitaloceanSpacesPtrInput is an input type that accepts StorageDestinationConnectionInfoDigitaloceanSpacesArgs, StorageDestinationConnectionInfoDigitaloceanSpacesPtr and StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoDigitaloceanSpacesPtrInput` via:

        StorageDestinationConnectionInfoDigitaloceanSpacesArgs{...}

or:

        nil

type StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

type StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) Elem

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) ElementType

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) Region

Bucket region supported by digitalocean_spaces.

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

func (StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutputWithContext

func (o StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput) ToStorageDestinationConnectionInfoDigitaloceanSpacesPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoDigitaloceanSpacesPtrOutput

type StorageDestinationConnectionInfoGoogleCloudStorage

type StorageDestinationConnectionInfoGoogleCloudStorage struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId string `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket string `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix *string `pulumi:"keyPrefix"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey *string `pulumi:"secretAccessKey"`
}

type StorageDestinationConnectionInfoGoogleCloudStorageArgs

type StorageDestinationConnectionInfoGoogleCloudStorageArgs struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId pulumi.StringInput `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket pulumi.StringInput `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix pulumi.StringPtrInput `pulumi:"keyPrefix"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey pulumi.StringPtrInput `pulumi:"secretAccessKey"`
}

func (StorageDestinationConnectionInfoGoogleCloudStorageArgs) ElementType

func (StorageDestinationConnectionInfoGoogleCloudStorageArgs) ToStorageDestinationConnectionInfoGoogleCloudStorageOutput

func (StorageDestinationConnectionInfoGoogleCloudStorageArgs) ToStorageDestinationConnectionInfoGoogleCloudStorageOutputWithContext

func (i StorageDestinationConnectionInfoGoogleCloudStorageArgs) ToStorageDestinationConnectionInfoGoogleCloudStorageOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoGoogleCloudStorageOutput

func (StorageDestinationConnectionInfoGoogleCloudStorageArgs) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

func (i StorageDestinationConnectionInfoGoogleCloudStorageArgs) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutput() StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

func (StorageDestinationConnectionInfoGoogleCloudStorageArgs) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutputWithContext

func (i StorageDestinationConnectionInfoGoogleCloudStorageArgs) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

type StorageDestinationConnectionInfoGoogleCloudStorageInput

type StorageDestinationConnectionInfoGoogleCloudStorageInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoGoogleCloudStorageOutput() StorageDestinationConnectionInfoGoogleCloudStorageOutput
	ToStorageDestinationConnectionInfoGoogleCloudStorageOutputWithContext(context.Context) StorageDestinationConnectionInfoGoogleCloudStorageOutput
}

StorageDestinationConnectionInfoGoogleCloudStorageInput is an input type that accepts StorageDestinationConnectionInfoGoogleCloudStorageArgs and StorageDestinationConnectionInfoGoogleCloudStorageOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoGoogleCloudStorageInput` via:

StorageDestinationConnectionInfoGoogleCloudStorageArgs{...}

type StorageDestinationConnectionInfoGoogleCloudStorageOutput

type StorageDestinationConnectionInfoGoogleCloudStorageOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) ElementType

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) ToStorageDestinationConnectionInfoGoogleCloudStorageOutput

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) ToStorageDestinationConnectionInfoGoogleCloudStorageOutputWithContext

func (o StorageDestinationConnectionInfoGoogleCloudStorageOutput) ToStorageDestinationConnectionInfoGoogleCloudStorageOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoGoogleCloudStorageOutput

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

func (StorageDestinationConnectionInfoGoogleCloudStorageOutput) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutputWithContext

func (o StorageDestinationConnectionInfoGoogleCloudStorageOutput) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

type StorageDestinationConnectionInfoGoogleCloudStoragePtrInput

type StorageDestinationConnectionInfoGoogleCloudStoragePtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutput() StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput
	ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutputWithContext(context.Context) StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput
}

StorageDestinationConnectionInfoGoogleCloudStoragePtrInput is an input type that accepts StorageDestinationConnectionInfoGoogleCloudStorageArgs, StorageDestinationConnectionInfoGoogleCloudStoragePtr and StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoGoogleCloudStoragePtrInput` via:

        StorageDestinationConnectionInfoGoogleCloudStorageArgs{...}

or:

        nil

type StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

type StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) Elem

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) ElementType

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

func (StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutputWithContext

func (o StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput) ToStorageDestinationConnectionInfoGoogleCloudStoragePtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoGoogleCloudStoragePtrOutput

type StorageDestinationConnectionInfoInput

type StorageDestinationConnectionInfoInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoOutput() StorageDestinationConnectionInfoOutput
	ToStorageDestinationConnectionInfoOutputWithContext(context.Context) StorageDestinationConnectionInfoOutput
}

StorageDestinationConnectionInfoInput is an input type that accepts StorageDestinationConnectionInfoArgs and StorageDestinationConnectionInfoOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoInput` via:

StorageDestinationConnectionInfoArgs{...}

type StorageDestinationConnectionInfoOtherS3Compatible

type StorageDestinationConnectionInfoOtherS3Compatible struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId string `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket string `pulumi:"bucket"`
	// Required for other_s3_compatible. Public HTTPS origin, up to 512 characters, without credentials, path, query, or fragment.
	Endpoint string `pulumi:"endpoint"`
	// Other S3-compatible only. Omitted or null uses true. No value is injected into the request.
	ForcePathStyle *bool `pulumi:"forcePathStyle"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix *string `pulumi:"keyPrefix"`
	// Optional signing region, up to 64 characters. Omitted or null uses the API default us-east-1.
	Region *string `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey *string `pulumi:"secretAccessKey"`
}

type StorageDestinationConnectionInfoOtherS3CompatibleArgs

type StorageDestinationConnectionInfoOtherS3CompatibleArgs struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId pulumi.StringInput `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket pulumi.StringInput `pulumi:"bucket"`
	// Required for other_s3_compatible. Public HTTPS origin, up to 512 characters, without credentials, path, query, or fragment.
	Endpoint pulumi.StringInput `pulumi:"endpoint"`
	// Other S3-compatible only. Omitted or null uses true. No value is injected into the request.
	ForcePathStyle pulumi.BoolPtrInput `pulumi:"forcePathStyle"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix pulumi.StringPtrInput `pulumi:"keyPrefix"`
	// Optional signing region, up to 64 characters. Omitted or null uses the API default us-east-1.
	Region pulumi.StringPtrInput `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey pulumi.StringPtrInput `pulumi:"secretAccessKey"`
}

func (StorageDestinationConnectionInfoOtherS3CompatibleArgs) ElementType

func (StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatibleOutput

func (i StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatibleOutput() StorageDestinationConnectionInfoOtherS3CompatibleOutput

func (StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatibleOutputWithContext

func (i StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatibleOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoOtherS3CompatibleOutput

func (StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

func (i StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutput() StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

func (StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutputWithContext

func (i StorageDestinationConnectionInfoOtherS3CompatibleArgs) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

type StorageDestinationConnectionInfoOtherS3CompatibleInput

type StorageDestinationConnectionInfoOtherS3CompatibleInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoOtherS3CompatibleOutput() StorageDestinationConnectionInfoOtherS3CompatibleOutput
	ToStorageDestinationConnectionInfoOtherS3CompatibleOutputWithContext(context.Context) StorageDestinationConnectionInfoOtherS3CompatibleOutput
}

StorageDestinationConnectionInfoOtherS3CompatibleInput is an input type that accepts StorageDestinationConnectionInfoOtherS3CompatibleArgs and StorageDestinationConnectionInfoOtherS3CompatibleOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoOtherS3CompatibleInput` via:

StorageDestinationConnectionInfoOtherS3CompatibleArgs{...}

type StorageDestinationConnectionInfoOtherS3CompatibleOutput

type StorageDestinationConnectionInfoOtherS3CompatibleOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) ElementType

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) Endpoint

Required for other_s3_compatible. Public HTTPS origin, up to 512 characters, without credentials, path, query, or fragment.

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) ForcePathStyle

Other S3-compatible only. Omitted or null uses true. No value is injected into the request.

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) Region

Optional signing region, up to 64 characters. Omitted or null uses the API default us-east-1.

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) ToStorageDestinationConnectionInfoOtherS3CompatibleOutput

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) ToStorageDestinationConnectionInfoOtherS3CompatibleOutputWithContext

func (o StorageDestinationConnectionInfoOtherS3CompatibleOutput) ToStorageDestinationConnectionInfoOtherS3CompatibleOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoOtherS3CompatibleOutput

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

func (StorageDestinationConnectionInfoOtherS3CompatibleOutput) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutputWithContext

func (o StorageDestinationConnectionInfoOtherS3CompatibleOutput) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

type StorageDestinationConnectionInfoOtherS3CompatiblePtrInput

type StorageDestinationConnectionInfoOtherS3CompatiblePtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutput() StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput
	ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutputWithContext(context.Context) StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput
}

StorageDestinationConnectionInfoOtherS3CompatiblePtrInput is an input type that accepts StorageDestinationConnectionInfoOtherS3CompatibleArgs, StorageDestinationConnectionInfoOtherS3CompatiblePtr and StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoOtherS3CompatiblePtrInput` via:

        StorageDestinationConnectionInfoOtherS3CompatibleArgs{...}

or:

        nil

type StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

type StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) Elem

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) ElementType

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) Endpoint

Required for other_s3_compatible. Public HTTPS origin, up to 512 characters, without credentials, path, query, or fragment.

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) ForcePathStyle

Other S3-compatible only. Omitted or null uses true. No value is injected into the request.

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) Region

Optional signing region, up to 64 characters. Omitted or null uses the API default us-east-1.

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

func (StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutputWithContext

func (o StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput) ToStorageDestinationConnectionInfoOtherS3CompatiblePtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoOtherS3CompatiblePtrOutput

type StorageDestinationConnectionInfoOutput

type StorageDestinationConnectionInfoOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoOutput) AwsS3

Connection settings for aws_s3. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoOutput) BackblazeB2

Connection settings for backblaze_b2. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoOutput) CloudflareR2

Connection settings for cloudflare_r2. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoOutput) DigitaloceanSpaces

Connection settings for digitalocean_spaces. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoOutput) ElementType

func (StorageDestinationConnectionInfoOutput) GoogleCloudStorage

Connection settings for google_cloud_storage. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoOutput) OtherS3Compatible

Connection settings for other_s3_compatible. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoOutput

func (o StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoOutput() StorageDestinationConnectionInfoOutput

func (StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoOutputWithContext

func (o StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoOutput

func (StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoPtrOutput

func (o StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoPtrOutput() StorageDestinationConnectionInfoPtrOutput

func (StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoPtrOutputWithContext

func (o StorageDestinationConnectionInfoOutput) ToStorageDestinationConnectionInfoPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoPtrOutput

func (StorageDestinationConnectionInfoOutput) Wasabi

Connection settings for wasabi. Set exactly one provider object inside connection_info.

type StorageDestinationConnectionInfoPtrInput

type StorageDestinationConnectionInfoPtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoPtrOutput() StorageDestinationConnectionInfoPtrOutput
	ToStorageDestinationConnectionInfoPtrOutputWithContext(context.Context) StorageDestinationConnectionInfoPtrOutput
}

StorageDestinationConnectionInfoPtrInput is an input type that accepts StorageDestinationConnectionInfoArgs, StorageDestinationConnectionInfoPtr and StorageDestinationConnectionInfoPtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoPtrInput` via:

        StorageDestinationConnectionInfoArgs{...}

or:

        nil

type StorageDestinationConnectionInfoPtrOutput

type StorageDestinationConnectionInfoPtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoPtrOutput) AwsS3

Connection settings for aws_s3. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoPtrOutput) BackblazeB2

Connection settings for backblaze_b2. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoPtrOutput) CloudflareR2

Connection settings for cloudflare_r2. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoPtrOutput) DigitaloceanSpaces

Connection settings for digitalocean_spaces. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoPtrOutput) Elem

func (StorageDestinationConnectionInfoPtrOutput) ElementType

func (StorageDestinationConnectionInfoPtrOutput) GoogleCloudStorage

Connection settings for google_cloud_storage. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoPtrOutput) OtherS3Compatible

Connection settings for other_s3_compatible. Set exactly one provider object inside connection_info.

func (StorageDestinationConnectionInfoPtrOutput) ToStorageDestinationConnectionInfoPtrOutput

func (o StorageDestinationConnectionInfoPtrOutput) ToStorageDestinationConnectionInfoPtrOutput() StorageDestinationConnectionInfoPtrOutput

func (StorageDestinationConnectionInfoPtrOutput) ToStorageDestinationConnectionInfoPtrOutputWithContext

func (o StorageDestinationConnectionInfoPtrOutput) ToStorageDestinationConnectionInfoPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoPtrOutput

func (StorageDestinationConnectionInfoPtrOutput) Wasabi

Connection settings for wasabi. Set exactly one provider object inside connection_info.

type StorageDestinationConnectionInfoWasabi

type StorageDestinationConnectionInfoWasabi struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId string `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket string `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix *string `pulumi:"keyPrefix"`
	// Bucket region supported by wasabi.
	Region string `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey *string `pulumi:"secretAccessKey"`
}

type StorageDestinationConnectionInfoWasabiArgs

type StorageDestinationConnectionInfoWasabiArgs struct {
	// Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.
	AccessKeyId pulumi.StringInput `pulumi:"accessKeyId"`
	// Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.
	Bucket pulumi.StringInput `pulumi:"bucket"`
	// Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.
	KeyPrefix pulumi.StringPtrInput `pulumi:"keyPrefix"`
	// Bucket region supported by wasabi.
	Region pulumi.StringInput `pulumi:"region"`
	// Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.
	SecretAccessKey pulumi.StringPtrInput `pulumi:"secretAccessKey"`
}

func (StorageDestinationConnectionInfoWasabiArgs) ElementType

func (StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiOutput

func (i StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiOutput() StorageDestinationConnectionInfoWasabiOutput

func (StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiOutputWithContext

func (i StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoWasabiOutput

func (StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiPtrOutput

func (i StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiPtrOutput() StorageDestinationConnectionInfoWasabiPtrOutput

func (StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiPtrOutputWithContext

func (i StorageDestinationConnectionInfoWasabiArgs) ToStorageDestinationConnectionInfoWasabiPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoWasabiPtrOutput

type StorageDestinationConnectionInfoWasabiInput

type StorageDestinationConnectionInfoWasabiInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoWasabiOutput() StorageDestinationConnectionInfoWasabiOutput
	ToStorageDestinationConnectionInfoWasabiOutputWithContext(context.Context) StorageDestinationConnectionInfoWasabiOutput
}

StorageDestinationConnectionInfoWasabiInput is an input type that accepts StorageDestinationConnectionInfoWasabiArgs and StorageDestinationConnectionInfoWasabiOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoWasabiInput` via:

StorageDestinationConnectionInfoWasabiArgs{...}

type StorageDestinationConnectionInfoWasabiOutput

type StorageDestinationConnectionInfoWasabiOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoWasabiOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoWasabiOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoWasabiOutput) ElementType

func (StorageDestinationConnectionInfoWasabiOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoWasabiOutput) Region

Bucket region supported by wasabi.

func (StorageDestinationConnectionInfoWasabiOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiOutput

func (o StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiOutput() StorageDestinationConnectionInfoWasabiOutput

func (StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiOutputWithContext

func (o StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoWasabiOutput

func (StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiPtrOutput

func (o StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiPtrOutput() StorageDestinationConnectionInfoWasabiPtrOutput

func (StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiPtrOutputWithContext

func (o StorageDestinationConnectionInfoWasabiOutput) ToStorageDestinationConnectionInfoWasabiPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoWasabiPtrOutput

type StorageDestinationConnectionInfoWasabiPtrInput

type StorageDestinationConnectionInfoWasabiPtrInput interface {
	pulumi.Input

	ToStorageDestinationConnectionInfoWasabiPtrOutput() StorageDestinationConnectionInfoWasabiPtrOutput
	ToStorageDestinationConnectionInfoWasabiPtrOutputWithContext(context.Context) StorageDestinationConnectionInfoWasabiPtrOutput
}

StorageDestinationConnectionInfoWasabiPtrInput is an input type that accepts StorageDestinationConnectionInfoWasabiArgs, StorageDestinationConnectionInfoWasabiPtr and StorageDestinationConnectionInfoWasabiPtrOutput values. You can construct a concrete instance of `StorageDestinationConnectionInfoWasabiPtrInput` via:

        StorageDestinationConnectionInfoWasabiArgs{...}

or:

        nil

type StorageDestinationConnectionInfoWasabiPtrOutput

type StorageDestinationConnectionInfoWasabiPtrOutput struct{ *pulumi.OutputState }

func (StorageDestinationConnectionInfoWasabiPtrOutput) AccessKeyId

Required except for AWS. Up to 512 characters. Google Cloud Storage requires an HMAC access ID beginning with GOOG.

func (StorageDestinationConnectionInfoWasabiPtrOutput) Bucket

Existing bucket or Space name, up to 255 characters. The provider never creates or deletes the bucket.

func (StorageDestinationConnectionInfoWasabiPtrOutput) Elem

func (StorageDestinationConnectionInfoWasabiPtrOutput) ElementType

func (StorageDestinationConnectionInfoWasabiPtrOutput) KeyPrefix

Object key prefix, up to 1024 characters. The API trims surrounding whitespace and slashes; omission uses the bucket root.

func (StorageDestinationConnectionInfoWasabiPtrOutput) Region

Bucket region supported by wasabi.

func (StorageDestinationConnectionInfoWasabiPtrOutput) SecretAccessKey

Sensitive access key secret. Required on create or a change of provider/access key ID. Omit on unrelated updates to retain the existing secret. Empty is invalid. Up to 990 UTF-16 units and 996 UTF-8 bytes after trimming.

func (StorageDestinationConnectionInfoWasabiPtrOutput) ToStorageDestinationConnectionInfoWasabiPtrOutput

func (o StorageDestinationConnectionInfoWasabiPtrOutput) ToStorageDestinationConnectionInfoWasabiPtrOutput() StorageDestinationConnectionInfoWasabiPtrOutput

func (StorageDestinationConnectionInfoWasabiPtrOutput) ToStorageDestinationConnectionInfoWasabiPtrOutputWithContext

func (o StorageDestinationConnectionInfoWasabiPtrOutput) ToStorageDestinationConnectionInfoWasabiPtrOutputWithContext(ctx context.Context) StorageDestinationConnectionInfoWasabiPtrOutput

type StorageDestinationInput

type StorageDestinationInput interface {
	pulumi.Input

	ToStorageDestinationOutput() StorageDestinationOutput
	ToStorageDestinationOutputWithContext(ctx context.Context) StorageDestinationOutput
}

type StorageDestinationOutput

type StorageDestinationOutput struct{ *pulumi.OutputState }

func (StorageDestinationOutput) ConnectionInfo

Set exactly one provider object: aws_s3, cloudflare_r2, backblaze_b2, digitalocean_spaces, wasabi, google_cloud_storage, or other_s3_compatible. Switching objects updates in place.

func (StorageDestinationOutput) CreatedAt

Creation timestamp.

func (StorageDestinationOutput) Disabled

Disable this destination for new renders. Defaults to false.

func (StorageDestinationOutput) ElementType

func (StorageDestinationOutput) ElementType() reflect.Type

func (StorageDestinationOutput) HctiStorageDisabled

func (o StorageDestinationOutput) HctiStorageDisabled() pulumi.BoolOutput

Store output only at this destination. Defaults to false. True requires authenticated /store rendering and supplies no public HCTI CDN URL.

func (StorageDestinationOutput) LastTestError

func (o StorageDestinationOutput) LastTestError() pulumi.StringOutput

Latest API connection test error, or null. Marked sensitive because it is external service diagnostic text.

func (StorageDestinationOutput) LastTestSucceeded

func (o StorageDestinationOutput) LastTestSucceeded() pulumi.BoolOutput

Latest API connection test result, or null.

func (StorageDestinationOutput) LastTestedAt

func (o StorageDestinationOutput) LastTestedAt() pulumi.StringOutput

Timestamp of the latest API connection test, or null. Refresh does not run tests.

func (StorageDestinationOutput) Name

Display name, 3–255 characters after trimming.

func (StorageDestinationOutput) ToStorageDestinationOutput

func (o StorageDestinationOutput) ToStorageDestinationOutput() StorageDestinationOutput

func (StorageDestinationOutput) ToStorageDestinationOutputWithContext

func (o StorageDestinationOutput) ToStorageDestinationOutputWithContext(ctx context.Context) StorageDestinationOutput

func (StorageDestinationOutput) UpdatedAt

Last update timestamp.

type StorageDestinationState

type StorageDestinationState struct {
	// Set exactly one provider object: aws_s3, cloudflare_r2, backblaze_b2, digitalocean_spaces, wasabi, google_cloud_storage, or other_s3_compatible. Switching objects updates in place.
	ConnectionInfo StorageDestinationConnectionInfoPtrInput
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// Disable this destination for new renders. Defaults to false.
	Disabled pulumi.BoolPtrInput
	// Store output only at this destination. Defaults to false. True requires authenticated /store rendering and supplies no public HCTI CDN URL.
	HctiStorageDisabled pulumi.BoolPtrInput
	// Latest API connection test error, or null. Marked sensitive because it is external service diagnostic text.
	LastTestError pulumi.StringPtrInput
	// Latest API connection test result, or null.
	LastTestSucceeded pulumi.BoolPtrInput
	// Timestamp of the latest API connection test, or null. Refresh does not run tests.
	LastTestedAt pulumi.StringPtrInput
	// Display name, 3–255 characters after trimming.
	Name pulumi.StringPtrInput
	// Last update timestamp.
	UpdatedAt pulumi.StringPtrInput
}

func (StorageDestinationState) ElementType

func (StorageDestinationState) ElementType() reflect.Type

type Template

type Template struct {
	pulumi.CustomResourceState

	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrOutput `pulumi:"colorScheme"`
	// Creation timestamp.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
	Css pulumi.StringPtrOutput `pulumi:"css"`
	// An optional description of the template for your reference. Maximum: 1024 characters.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrOutput `pulumi:"deviceScale"`
	// Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
	DisableTwemoji pulumi.BoolPtrOutput `pulumi:"disableTwemoji"`
	// Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
	GoogleFonts pulumi.StringArrayOutput `pulumi:"googleFonts"`
	// HTML to render for the template. Use Handlebars placeholders for values that will be substituted when an image is rendered. Must be non-empty, contain at least one Handlebars placeholder, and compile as valid Handlebars.
	Html pulumi.StringOutput `pulumi:"html"`
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrOutput `pulumi:"jumboMaxHeight"`
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrOutput `pulumi:"jumboMaxWidth"`
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrOutput `pulumi:"maxWaitMs"`
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrOutput `pulumi:"mediaType"`
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrOutput `pulumi:"msDelay"`
	// The name of the template, used to identify it in your account. Maximum: 64 characters.
	Name pulumi.StringPtrOutput `pulumi:"name"`
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrOutput `pulumi:"proxyId"`
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrOutput `pulumi:"renderWhenReady"`
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides TemplateRequestOverrideArrayOutput `pulumi:"requestOverrides"`
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrOutput `pulumi:"selector"`
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrOutput `pulumi:"storageDestinationId"`
	// Template type; this resource manages html_css templates.
	TemplateType pulumi.StringOutput `pulumi:"templateType"`
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrOutput `pulumi:"timezone"`
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrOutput `pulumi:"transparentBackground"`
	// Last update timestamp.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
	// Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
	Version pulumi.StringOutput `pulumi:"version"`
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrOutput `pulumi:"viewportHeight"`
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrOutput `pulumi:"viewportLandscape"`
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrOutput `pulumi:"viewportMobile"`
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrOutput `pulumi:"viewportTouch"`
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrOutput `pulumi:"viewportWidth"`
}

func GetTemplate

func GetTemplate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TemplateState, opts ...pulumi.ResourceOption) (*Template, error)

GetTemplate gets an existing Template resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTemplate

func NewTemplate(ctx *pulumi.Context,
	name string, args *TemplateArgs, opts ...pulumi.ResourceOption) (*Template, error)

NewTemplate registers a new resource with the given unique name, arguments, and options.

func (*Template) ElementType

func (*Template) ElementType() reflect.Type

func (*Template) ToTemplateOutput

func (i *Template) ToTemplateOutput() TemplateOutput

func (*Template) ToTemplateOutputWithContext

func (i *Template) ToTemplateOutputWithContext(ctx context.Context) TemplateOutput

type TemplateArgs

type TemplateArgs struct {
	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrInput
	// CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
	Css pulumi.StringPtrInput
	// An optional description of the template for your reference. Maximum: 1024 characters.
	Description pulumi.StringPtrInput
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrInput
	// Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
	DisableTwemoji pulumi.BoolPtrInput
	// Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
	GoogleFonts pulumi.StringArrayInput
	// HTML to render for the template. Use Handlebars placeholders for values that will be substituted when an image is rendered. Must be non-empty, contain at least one Handlebars placeholder, and compile as valid Handlebars.
	Html pulumi.StringInput
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrInput
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrInput
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrInput
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrInput
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrInput
	// The name of the template, used to identify it in your account. Maximum: 64 characters.
	Name pulumi.StringPtrInput
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrInput
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrInput
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides TemplateRequestOverrideArrayInput
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrInput
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrInput
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrInput
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrInput
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrInput
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrInput
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrInput
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrInput
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrInput
}

The set of arguments for constructing a Template resource.

func (TemplateArgs) ElementType

func (TemplateArgs) ElementType() reflect.Type

type TemplateInput

type TemplateInput interface {
	pulumi.Input

	ToTemplateOutput() TemplateOutput
	ToTemplateOutputWithContext(ctx context.Context) TemplateOutput
}

type TemplateOutput

type TemplateOutput struct{ *pulumi.OutputState }

func (TemplateOutput) ColorScheme

func (o TemplateOutput) ColorScheme() pulumi.StringPtrOutput

Sets the preferred color scheme: light or dark.

func (TemplateOutput) CreatedAt

func (o TemplateOutput) CreatedAt() pulumi.StringOutput

Creation timestamp.

func (TemplateOutput) Css

CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.

func (TemplateOutput) Description

func (o TemplateOutput) Description() pulumi.StringPtrOutput

An optional description of the template for your reference. Maximum: 1024 characters.

func (TemplateOutput) DeviceScale

func (o TemplateOutput) DeviceScale() pulumi.Float64PtrOutput

Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.

func (TemplateOutput) DisableTwemoji

func (o TemplateOutput) DisableTwemoji() pulumi.BoolPtrOutput

Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.

func (TemplateOutput) ElementType

func (TemplateOutput) ElementType() reflect.Type

func (TemplateOutput) GoogleFonts

func (o TemplateOutput) GoogleFonts() pulumi.StringArrayOutput

Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.

func (TemplateOutput) Html

HTML to render for the template. Use Handlebars placeholders for values that will be substituted when an image is rendered. Must be non-empty, contain at least one Handlebars placeholder, and compile as valid Handlebars.

func (TemplateOutput) JumboMaxHeight

func (o TemplateOutput) JumboMaxHeight() pulumi.IntPtrOutput

Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.

func (TemplateOutput) JumboMaxWidth

func (o TemplateOutput) JumboMaxWidth() pulumi.IntPtrOutput

Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.

func (TemplateOutput) MaxWaitMs

func (o TemplateOutput) MaxWaitMs() pulumi.IntPtrOutput

Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.

func (TemplateOutput) MediaType

func (o TemplateOutput) MediaType() pulumi.StringPtrOutput

CSS media type to emulate: screen or print.

func (TemplateOutput) MsDelay

func (o TemplateOutput) MsDelay() pulumi.IntPtrOutput

Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.

func (TemplateOutput) Name

The name of the template, used to identify it in your account. Maximum: 64 characters.

func (TemplateOutput) ProxyId

Specifies which configured organization proxy to use when rendering.

func (TemplateOutput) RenderWhenReady

func (o TemplateOutput) RenderWhenReady() pulumi.BoolPtrOutput

Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.

func (TemplateOutput) RequestOverrides added in v0.2.0

Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.

func (TemplateOutput) Selector

func (o TemplateOutput) Selector() pulumi.StringPtrOutput

A CSS selector for an element in the HTML. We’ll crop the image to this specific element.

func (TemplateOutput) StorageDestinationId

func (o TemplateOutput) StorageDestinationId() pulumi.StringPtrOutput

Specifies which configured organization storage destination receives the rendered image.

func (TemplateOutput) TemplateType

func (o TemplateOutput) TemplateType() pulumi.StringOutput

Template type; this resource manages html_css templates.

func (TemplateOutput) Timezone

func (o TemplateOutput) Timezone() pulumi.StringPtrOutput

Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.

func (TemplateOutput) ToTemplateOutput

func (o TemplateOutput) ToTemplateOutput() TemplateOutput

func (TemplateOutput) ToTemplateOutputWithContext

func (o TemplateOutput) ToTemplateOutputWithContext(ctx context.Context) TemplateOutput

func (TemplateOutput) TransparentBackground

func (o TemplateOutput) TransparentBackground() pulumi.BoolPtrOutput

Specifies whether the image is rendered with a transparent background.

func (TemplateOutput) UpdatedAt

func (o TemplateOutput) UpdatedAt() pulumi.StringOutput

Last update timestamp.

func (TemplateOutput) Version

func (o TemplateOutput) Version() pulumi.StringOutput

Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.

func (TemplateOutput) ViewportHeight

func (o TemplateOutput) ViewportHeight() pulumi.IntPtrOutput

Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

func (TemplateOutput) ViewportLandscape

func (o TemplateOutput) ViewportLandscape() pulumi.BoolPtrOutput

Specifies whether the emulated viewport is in landscape orientation.

func (TemplateOutput) ViewportMobile

func (o TemplateOutput) ViewportMobile() pulumi.BoolPtrOutput

Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.

func (TemplateOutput) ViewportTouch

func (o TemplateOutput) ViewportTouch() pulumi.BoolPtrOutput

Specifies whether the emulated viewport supports touch events.

func (TemplateOutput) ViewportWidth

func (o TemplateOutput) ViewportWidth() pulumi.IntPtrOutput

Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.

type TemplateRequestOverride added in v0.2.0

type TemplateRequestOverride struct {
	// Currently only `block` is supported.
	Action string `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes []RequestOverrideResourceType `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url *string `pulumi:"url"`
}

type TemplateRequestOverrideArgs added in v0.2.0

type TemplateRequestOverrideArgs struct {
	// Currently only `block` is supported.
	Action pulumi.StringInput `pulumi:"action"`
	// Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.
	ResourceTypes RequestOverrideResourceTypeArrayInput `pulumi:"resourceTypes"`
	// Case-sensitive URL wildcard pattern using `*`; at most 512 characters.
	Url pulumi.StringPtrInput `pulumi:"url"`
}

func (TemplateRequestOverrideArgs) ElementType added in v0.2.0

func (TemplateRequestOverrideArgs) ToTemplateRequestOverrideOutput added in v0.2.0

func (i TemplateRequestOverrideArgs) ToTemplateRequestOverrideOutput() TemplateRequestOverrideOutput

func (TemplateRequestOverrideArgs) ToTemplateRequestOverrideOutputWithContext added in v0.2.0

func (i TemplateRequestOverrideArgs) ToTemplateRequestOverrideOutputWithContext(ctx context.Context) TemplateRequestOverrideOutput

type TemplateRequestOverrideArray added in v0.2.0

type TemplateRequestOverrideArray []TemplateRequestOverrideInput

func (TemplateRequestOverrideArray) ElementType added in v0.2.0

func (TemplateRequestOverrideArray) ToTemplateRequestOverrideArrayOutput added in v0.2.0

func (i TemplateRequestOverrideArray) ToTemplateRequestOverrideArrayOutput() TemplateRequestOverrideArrayOutput

func (TemplateRequestOverrideArray) ToTemplateRequestOverrideArrayOutputWithContext added in v0.2.0

func (i TemplateRequestOverrideArray) ToTemplateRequestOverrideArrayOutputWithContext(ctx context.Context) TemplateRequestOverrideArrayOutput

type TemplateRequestOverrideArrayInput added in v0.2.0

type TemplateRequestOverrideArrayInput interface {
	pulumi.Input

	ToTemplateRequestOverrideArrayOutput() TemplateRequestOverrideArrayOutput
	ToTemplateRequestOverrideArrayOutputWithContext(context.Context) TemplateRequestOverrideArrayOutput
}

TemplateRequestOverrideArrayInput is an input type that accepts TemplateRequestOverrideArray and TemplateRequestOverrideArrayOutput values. You can construct a concrete instance of `TemplateRequestOverrideArrayInput` via:

TemplateRequestOverrideArray{ TemplateRequestOverrideArgs{...} }

type TemplateRequestOverrideArrayOutput added in v0.2.0

type TemplateRequestOverrideArrayOutput struct{ *pulumi.OutputState }

func (TemplateRequestOverrideArrayOutput) ElementType added in v0.2.0

func (TemplateRequestOverrideArrayOutput) Index added in v0.2.0

func (TemplateRequestOverrideArrayOutput) ToTemplateRequestOverrideArrayOutput added in v0.2.0

func (o TemplateRequestOverrideArrayOutput) ToTemplateRequestOverrideArrayOutput() TemplateRequestOverrideArrayOutput

func (TemplateRequestOverrideArrayOutput) ToTemplateRequestOverrideArrayOutputWithContext added in v0.2.0

func (o TemplateRequestOverrideArrayOutput) ToTemplateRequestOverrideArrayOutputWithContext(ctx context.Context) TemplateRequestOverrideArrayOutput

type TemplateRequestOverrideInput added in v0.2.0

type TemplateRequestOverrideInput interface {
	pulumi.Input

	ToTemplateRequestOverrideOutput() TemplateRequestOverrideOutput
	ToTemplateRequestOverrideOutputWithContext(context.Context) TemplateRequestOverrideOutput
}

TemplateRequestOverrideInput is an input type that accepts TemplateRequestOverrideArgs and TemplateRequestOverrideOutput values. You can construct a concrete instance of `TemplateRequestOverrideInput` via:

TemplateRequestOverrideArgs{...}

type TemplateRequestOverrideOutput added in v0.2.0

type TemplateRequestOverrideOutput struct{ *pulumi.OutputState }

func (TemplateRequestOverrideOutput) Action added in v0.2.0

Currently only `block` is supported.

func (TemplateRequestOverrideOutput) ElementType added in v0.2.0

func (TemplateRequestOverrideOutput) ResourceTypes added in v0.2.0

Browser resource types, such as `image`, `script`, `xhr`, and `fetch`. Each value must be a supported resource type.

func (TemplateRequestOverrideOutput) ToTemplateRequestOverrideOutput added in v0.2.0

func (o TemplateRequestOverrideOutput) ToTemplateRequestOverrideOutput() TemplateRequestOverrideOutput

func (TemplateRequestOverrideOutput) ToTemplateRequestOverrideOutputWithContext added in v0.2.0

func (o TemplateRequestOverrideOutput) ToTemplateRequestOverrideOutputWithContext(ctx context.Context) TemplateRequestOverrideOutput

func (TemplateRequestOverrideOutput) Url added in v0.2.0

Case-sensitive URL wildcard pattern using `*`; at most 512 characters.

type TemplateState

type TemplateState struct {
	// Sets the preferred color scheme: light or dark.
	ColorScheme pulumi.StringPtrInput
	// Creation timestamp.
	CreatedAt pulumi.StringPtrInput
	// CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
	Css pulumi.StringPtrInput
	// An optional description of the template for your reference. Maximum: 1024 characters.
	Description pulumi.StringPtrInput
	// Adjusts the pixel ratio used for the screenshot. Minimum: 0.1. Maximum: 3. HTML and template renders default to 2; URL renders default to 1.
	DeviceScale pulumi.Float64PtrInput
	// Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
	DisableTwemoji pulumi.BoolPtrInput
	// Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
	GoogleFonts pulumi.StringArrayInput
	// HTML to render for the template. Use Handlebars placeholders for values that will be substituted when an image is rendered. Must be non-empty, contain at least one Handlebars placeholder, and compile as valid Handlebars.
	Html pulumi.StringPtrInput
	// Maximum height of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_width. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxHeight pulumi.IntPtrInput
	// Maximum width of the rendered image in jumbo mode. Jumbo rendering consumes additional renders and requires jumbo_max_height. Supply both jumbo dimensions. Each must be greater than 0 and no more than 80000; at least one must exceed 8000; total area cannot exceed 400000000 pixels.
	JumboMaxWidth pulumi.IntPtrInput
	// Sets a limit on how long to wait before taking the screenshot when the page continues loading irrelevant content. Minimum: 500. Maximum: 10000 and subject to the account plan limit.
	MaxWaitMs pulumi.IntPtrInput
	// CSS media type to emulate: screen or print.
	MediaType pulumi.StringPtrInput
	// Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
	MsDelay pulumi.IntPtrInput
	// The name of the template, used to identify it in your account. Maximum: 64 characters.
	Name pulumi.StringPtrInput
	// Specifies which configured organization proxy to use when rendering.
	ProxyId pulumi.StringPtrInput
	// Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
	RenderWhenReady pulumi.BoolPtrInput
	// Browser network request block rules. Requires a paid plan; at most 100 rules. A rule matches its URL wildcard and/or resource types, and both must match when supplied together.
	RequestOverrides TemplateRequestOverrideArrayInput
	// A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
	Selector pulumi.StringPtrInput
	// Specifies which configured organization storage destination receives the rendered image.
	StorageDestinationId pulumi.StringPtrInput
	// Template type; this resource manages html_css templates.
	TemplateType pulumi.StringPtrInput
	// Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
	Timezone pulumi.StringPtrInput
	// Specifies whether the image is rendered with a transparent background.
	TransparentBackground pulumi.BoolPtrInput
	// Last update timestamp.
	UpdatedAt pulumi.StringPtrInput
	// Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
	Version pulumi.StringPtrInput
	// Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportHeight pulumi.IntPtrInput
	// Specifies whether the emulated viewport is in landscape orientation.
	ViewportLandscape pulumi.BoolPtrInput
	// Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
	ViewportMobile pulumi.BoolPtrInput
	// Specifies whether the emulated viewport supports touch events.
	ViewportTouch pulumi.BoolPtrInput
	// Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
	ViewportWidth pulumi.IntPtrInput
}

func (TemplateState) ElementType

func (TemplateState) ElementType() reflect.Type

type Webhook added in v0.3.0

type Webhook struct {
	pulumi.CustomResourceState

	// Delivery configuration version; increases when URL, parameters, or signing settings change.
	ConfigVersion pulumi.IntOutput `pulumi:"configVersion"`
	// Creation timestamp in RFC 3339 format.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// Disable deliveries. Defaults to false. Enabling queues an automatic test delivery.
	Disabled pulumi.BoolOutput `pulumi:"disabled"`
	// Complete set of event names, such as image_stored or template_updated. An empty set receives only tests. The API validates subscriptions and permissions; webhook_test cannot be subscribed to.
	Events pulumi.StringArrayOutput `pulumi:"events"`
	// Display name, up to 255 characters after trimming.
	Name pulumi.StringOutput `pulumi:"name"`
	// Complete list of custom headers and query parameters, up to 20 combined. Omission or an empty list removes all parameters. Values are sensitive in state, including non-secret parameters.
	Parameters WebhookParameterArrayOutput `pulumi:"parameters"`
	// Sign deliveries using Standard Webhooks. Defaults to false. Use the<span pulumi-lang-nodejs=" signingSecret " pulumi-lang-dotnet=" SigningSecret " pulumi-lang-go=" signingSecret " pulumi-lang-python=" signing_secret " pulumi-lang-yaml=" signingSecret " pulumi-lang-java=" signingSecret " pulumi-lang-hcl=" signing_secret "> signingSecret </span>output to configure your receiver. Create disabled while setting up the receiver.
	SigningEnabled pulumi.BoolOutput `pulumi:"signingEnabled"`
	// Signing secret returned only on creation, even when signing is disabled. Preserved in state across reads and updates. Unavailable after import. Store securely; this sensitive value is stored in Terraform state.
	SigningSecret pulumi.StringOutput `pulumi:"signingSecret"`
	// Last update timestamp in RFC 3339 format.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
	// HTTPS delivery endpoint, up to 2048 characters. HTTPS is assumed without a scheme. Use a DNS hostname on the default HTTPS port, without credentials, query, or fragment. Private destinations are blocked.
	Url pulumi.StringOutput `pulumi:"url"`
}

func GetWebhook added in v0.3.0

func GetWebhook(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WebhookState, opts ...pulumi.ResourceOption) (*Webhook, error)

GetWebhook gets an existing Webhook resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWebhook added in v0.3.0

func NewWebhook(ctx *pulumi.Context,
	name string, args *WebhookArgs, opts ...pulumi.ResourceOption) (*Webhook, error)

NewWebhook registers a new resource with the given unique name, arguments, and options.

func (*Webhook) ElementType added in v0.3.0

func (*Webhook) ElementType() reflect.Type

func (*Webhook) ToWebhookOutput added in v0.3.0

func (i *Webhook) ToWebhookOutput() WebhookOutput

func (*Webhook) ToWebhookOutputWithContext added in v0.3.0

func (i *Webhook) ToWebhookOutputWithContext(ctx context.Context) WebhookOutput

type WebhookArgs added in v0.3.0

type WebhookArgs struct {
	// Disable deliveries. Defaults to false. Enabling queues an automatic test delivery.
	Disabled pulumi.BoolPtrInput
	// Complete set of event names, such as image_stored or template_updated. An empty set receives only tests. The API validates subscriptions and permissions; webhook_test cannot be subscribed to.
	Events pulumi.StringArrayInput
	// Display name, up to 255 characters after trimming.
	Name pulumi.StringInput
	// Complete list of custom headers and query parameters, up to 20 combined. Omission or an empty list removes all parameters. Values are sensitive in state, including non-secret parameters.
	Parameters WebhookParameterArrayInput
	// Sign deliveries using Standard Webhooks. Defaults to false. Use the<span pulumi-lang-nodejs=" signingSecret " pulumi-lang-dotnet=" SigningSecret " pulumi-lang-go=" signingSecret " pulumi-lang-python=" signing_secret " pulumi-lang-yaml=" signingSecret " pulumi-lang-java=" signingSecret " pulumi-lang-hcl=" signing_secret "> signingSecret </span>output to configure your receiver. Create disabled while setting up the receiver.
	SigningEnabled pulumi.BoolPtrInput
	// HTTPS delivery endpoint, up to 2048 characters. HTTPS is assumed without a scheme. Use a DNS hostname on the default HTTPS port, without credentials, query, or fragment. Private destinations are blocked.
	Url pulumi.StringInput
}

The set of arguments for constructing a Webhook resource.

func (WebhookArgs) ElementType added in v0.3.0

func (WebhookArgs) ElementType() reflect.Type

type WebhookInput added in v0.3.0

type WebhookInput interface {
	pulumi.Input

	ToWebhookOutput() WebhookOutput
	ToWebhookOutputWithContext(ctx context.Context) WebhookOutput
}

type WebhookOutput added in v0.3.0

type WebhookOutput struct{ *pulumi.OutputState }

func (WebhookOutput) ConfigVersion added in v0.3.0

func (o WebhookOutput) ConfigVersion() pulumi.IntOutput

Delivery configuration version; increases when URL, parameters, or signing settings change.

func (WebhookOutput) CreatedAt added in v0.3.0

func (o WebhookOutput) CreatedAt() pulumi.StringOutput

Creation timestamp in RFC 3339 format.

func (WebhookOutput) Disabled added in v0.3.0

func (o WebhookOutput) Disabled() pulumi.BoolOutput

Disable deliveries. Defaults to false. Enabling queues an automatic test delivery.

func (WebhookOutput) ElementType added in v0.3.0

func (WebhookOutput) ElementType() reflect.Type

func (WebhookOutput) Events added in v0.3.0

Complete set of event names, such as image_stored or template_updated. An empty set receives only tests. The API validates subscriptions and permissions; webhook_test cannot be subscribed to.

func (WebhookOutput) Name added in v0.3.0

Display name, up to 255 characters after trimming.

func (WebhookOutput) Parameters added in v0.3.0

Complete list of custom headers and query parameters, up to 20 combined. Omission or an empty list removes all parameters. Values are sensitive in state, including non-secret parameters.

func (WebhookOutput) SigningEnabled added in v0.3.0

func (o WebhookOutput) SigningEnabled() pulumi.BoolOutput

Sign deliveries using Standard Webhooks. Defaults to false. Use the<span pulumi-lang-nodejs=" signingSecret " pulumi-lang-dotnet=" SigningSecret " pulumi-lang-go=" signingSecret " pulumi-lang-python=" signing_secret " pulumi-lang-yaml=" signingSecret " pulumi-lang-java=" signingSecret " pulumi-lang-hcl=" signing_secret "> signingSecret </span>output to configure your receiver. Create disabled while setting up the receiver.

func (WebhookOutput) SigningSecret added in v0.3.0

func (o WebhookOutput) SigningSecret() pulumi.StringOutput

Signing secret returned only on creation, even when signing is disabled. Preserved in state across reads and updates. Unavailable after import. Store securely; this sensitive value is stored in Terraform state.

func (WebhookOutput) ToWebhookOutput added in v0.3.0

func (o WebhookOutput) ToWebhookOutput() WebhookOutput

func (WebhookOutput) ToWebhookOutputWithContext added in v0.3.0

func (o WebhookOutput) ToWebhookOutputWithContext(ctx context.Context) WebhookOutput

func (WebhookOutput) UpdatedAt added in v0.3.0

func (o WebhookOutput) UpdatedAt() pulumi.StringOutput

Last update timestamp in RFC 3339 format.

func (WebhookOutput) Url added in v0.3.0

HTTPS delivery endpoint, up to 2048 characters. HTTPS is assumed without a scheme. Use a DNS hostname on the default HTTPS port, without credentials, query, or fragment. Private destinations are blocked.

type WebhookParameter added in v0.3.0

type WebhookParameter struct {
	// Parameter name, up to 512 UTF-8 bytes, unique within its location. Header names match case-insensitively. Transport and HCTI signing headers are reserved.
	Key string `pulumi:"key"`
	// header or query_parameter.
	Location string `pulumi:"location"`
	// Encrypt the value and omit it from API reads and delivery history. Defaults to false. Use true for credentials.
	Secret *bool `pulumi:"secret"`
	// Parameter value, up to 4096 UTF-8 bytes. An empty string is valid. Required for creation, non-secret parameters, or changes to the location, key, or endpoint URL. Omitted on update retains an existing secret with the same location/key and endpoint. Supplied values are stored in Terraform state even when secret is true.
	Value *string `pulumi:"value"`
}

type WebhookParameterArgs added in v0.3.0

type WebhookParameterArgs struct {
	// Parameter name, up to 512 UTF-8 bytes, unique within its location. Header names match case-insensitively. Transport and HCTI signing headers are reserved.
	Key pulumi.StringInput `pulumi:"key"`
	// header or query_parameter.
	Location pulumi.StringInput `pulumi:"location"`
	// Encrypt the value and omit it from API reads and delivery history. Defaults to false. Use true for credentials.
	Secret pulumi.BoolPtrInput `pulumi:"secret"`
	// Parameter value, up to 4096 UTF-8 bytes. An empty string is valid. Required for creation, non-secret parameters, or changes to the location, key, or endpoint URL. Omitted on update retains an existing secret with the same location/key and endpoint. Supplied values are stored in Terraform state even when secret is true.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (WebhookParameterArgs) ElementType added in v0.3.0

func (WebhookParameterArgs) ElementType() reflect.Type

func (WebhookParameterArgs) ToWebhookParameterOutput added in v0.3.0

func (i WebhookParameterArgs) ToWebhookParameterOutput() WebhookParameterOutput

func (WebhookParameterArgs) ToWebhookParameterOutputWithContext added in v0.3.0

func (i WebhookParameterArgs) ToWebhookParameterOutputWithContext(ctx context.Context) WebhookParameterOutput

type WebhookParameterArray added in v0.3.0

type WebhookParameterArray []WebhookParameterInput

func (WebhookParameterArray) ElementType added in v0.3.0

func (WebhookParameterArray) ElementType() reflect.Type

func (WebhookParameterArray) ToWebhookParameterArrayOutput added in v0.3.0

func (i WebhookParameterArray) ToWebhookParameterArrayOutput() WebhookParameterArrayOutput

func (WebhookParameterArray) ToWebhookParameterArrayOutputWithContext added in v0.3.0

func (i WebhookParameterArray) ToWebhookParameterArrayOutputWithContext(ctx context.Context) WebhookParameterArrayOutput

type WebhookParameterArrayInput added in v0.3.0

type WebhookParameterArrayInput interface {
	pulumi.Input

	ToWebhookParameterArrayOutput() WebhookParameterArrayOutput
	ToWebhookParameterArrayOutputWithContext(context.Context) WebhookParameterArrayOutput
}

WebhookParameterArrayInput is an input type that accepts WebhookParameterArray and WebhookParameterArrayOutput values. You can construct a concrete instance of `WebhookParameterArrayInput` via:

WebhookParameterArray{ WebhookParameterArgs{...} }

type WebhookParameterArrayOutput added in v0.3.0

type WebhookParameterArrayOutput struct{ *pulumi.OutputState }

func (WebhookParameterArrayOutput) ElementType added in v0.3.0

func (WebhookParameterArrayOutput) Index added in v0.3.0

func (WebhookParameterArrayOutput) ToWebhookParameterArrayOutput added in v0.3.0

func (o WebhookParameterArrayOutput) ToWebhookParameterArrayOutput() WebhookParameterArrayOutput

func (WebhookParameterArrayOutput) ToWebhookParameterArrayOutputWithContext added in v0.3.0

func (o WebhookParameterArrayOutput) ToWebhookParameterArrayOutputWithContext(ctx context.Context) WebhookParameterArrayOutput

type WebhookParameterInput added in v0.3.0

type WebhookParameterInput interface {
	pulumi.Input

	ToWebhookParameterOutput() WebhookParameterOutput
	ToWebhookParameterOutputWithContext(context.Context) WebhookParameterOutput
}

WebhookParameterInput is an input type that accepts WebhookParameterArgs and WebhookParameterOutput values. You can construct a concrete instance of `WebhookParameterInput` via:

WebhookParameterArgs{...}

type WebhookParameterOutput added in v0.3.0

type WebhookParameterOutput struct{ *pulumi.OutputState }

func (WebhookParameterOutput) ElementType added in v0.3.0

func (WebhookParameterOutput) ElementType() reflect.Type

func (WebhookParameterOutput) Key added in v0.3.0

Parameter name, up to 512 UTF-8 bytes, unique within its location. Header names match case-insensitively. Transport and HCTI signing headers are reserved.

func (WebhookParameterOutput) Location added in v0.3.0

header or query_parameter.

func (WebhookParameterOutput) Secret added in v0.3.0

Encrypt the value and omit it from API reads and delivery history. Defaults to false. Use true for credentials.

func (WebhookParameterOutput) ToWebhookParameterOutput added in v0.3.0

func (o WebhookParameterOutput) ToWebhookParameterOutput() WebhookParameterOutput

func (WebhookParameterOutput) ToWebhookParameterOutputWithContext added in v0.3.0

func (o WebhookParameterOutput) ToWebhookParameterOutputWithContext(ctx context.Context) WebhookParameterOutput

func (WebhookParameterOutput) Value added in v0.3.0

Parameter value, up to 4096 UTF-8 bytes. An empty string is valid. Required for creation, non-secret parameters, or changes to the location, key, or endpoint URL. Omitted on update retains an existing secret with the same location/key and endpoint. Supplied values are stored in Terraform state even when secret is true.

type WebhookState added in v0.3.0

type WebhookState struct {
	// Delivery configuration version; increases when URL, parameters, or signing settings change.
	ConfigVersion pulumi.IntPtrInput
	// Creation timestamp in RFC 3339 format.
	CreatedAt pulumi.StringPtrInput
	// Disable deliveries. Defaults to false. Enabling queues an automatic test delivery.
	Disabled pulumi.BoolPtrInput
	// Complete set of event names, such as image_stored or template_updated. An empty set receives only tests. The API validates subscriptions and permissions; webhook_test cannot be subscribed to.
	Events pulumi.StringArrayInput
	// Display name, up to 255 characters after trimming.
	Name pulumi.StringPtrInput
	// Complete list of custom headers and query parameters, up to 20 combined. Omission or an empty list removes all parameters. Values are sensitive in state, including non-secret parameters.
	Parameters WebhookParameterArrayInput
	// Sign deliveries using Standard Webhooks. Defaults to false. Use the<span pulumi-lang-nodejs=" signingSecret " pulumi-lang-dotnet=" SigningSecret " pulumi-lang-go=" signingSecret " pulumi-lang-python=" signing_secret " pulumi-lang-yaml=" signingSecret " pulumi-lang-java=" signingSecret " pulumi-lang-hcl=" signing_secret "> signingSecret </span>output to configure your receiver. Create disabled while setting up the receiver.
	SigningEnabled pulumi.BoolPtrInput
	// Signing secret returned only on creation, even when signing is disabled. Preserved in state across reads and updates. Unavailable after import. Store securely; this sensitive value is stored in Terraform state.
	SigningSecret pulumi.StringPtrInput
	// Last update timestamp in RFC 3339 format.
	UpdatedAt pulumi.StringPtrInput
	// HTTPS delivery endpoint, up to 2048 characters. HTTPS is assumed without a scheme. Use a DNS hostname on the default HTTPS port, without credentials, query, or fragment. Private destinations are blocked.
	Url pulumi.StringPtrInput
}

func (WebhookState) ElementType added in v0.3.0

func (WebhookState) ElementType() reflect.Type

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址