published on Tuesday, Sep 29, 2026 by htmlcsstoimage
HTML/CSS to Imagepublished on Tuesday, Sep 29, 2026 by htmlcsstoimage
Create Template Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Template(name: string, args: TemplateArgs, opts?: CustomResourceOptions);@overload
def Template(resource_name: str,
args: TemplateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Template(resource_name: str,
opts: Optional[ResourceOptions] = None,
html: Optional[str] = None,
name: Optional[str] = None,
jumbo_max_height: Optional[int] = None,
device_scale: Optional[float] = None,
disable_twemoji: Optional[bool] = None,
google_fonts: Optional[Sequence[str]] = None,
css: Optional[str] = None,
color_scheme: Optional[str] = None,
jumbo_max_width: Optional[int] = None,
max_wait_ms: Optional[int] = None,
media_type: Optional[str] = None,
description: Optional[str] = None,
ms_delay: Optional[int] = None,
storage_destination_id: Optional[str] = None,
render_when_ready: Optional[bool] = None,
request_overrides: Optional[Sequence[TemplateRequestOverrideArgs]] = None,
selector: Optional[str] = None,
proxy_id: Optional[str] = None,
timezone: Optional[str] = None,
transparent_background: Optional[bool] = None,
viewport_height: Optional[int] = None,
viewport_landscape: Optional[bool] = None,
viewport_mobile: Optional[bool] = None,
viewport_touch: Optional[bool] = None,
viewport_width: Optional[int] = None)func NewTemplate(ctx *Context, name string, args TemplateArgs, opts ...ResourceOption) (*Template, error)public Template(string name, TemplateArgs args, CustomResourceOptions? opts = null)
public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)
type: html-css-to-image:Template
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "html-css-to-image_template" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var templateResource = new HtmlCssToImage.Template("templateResource", new()
{
Html = "string",
Name = "string",
JumboMaxHeight = 0,
DeviceScale = 0.0,
DisableTwemoji = false,
GoogleFonts = new[]
{
"string",
},
Css = "string",
ColorScheme = "string",
JumboMaxWidth = 0,
MaxWaitMs = 0,
MediaType = "string",
Description = "string",
MsDelay = 0,
StorageDestinationId = "string",
RenderWhenReady = false,
RequestOverrides = new[]
{
new HtmlCssToImage.Inputs.TemplateRequestOverrideArgs
{
Action = "string",
ResourceTypes = new[]
{
HtmlCssToImage.RequestOverrideResourceType.Beacon,
},
Url = "string",
},
},
Selector = "string",
ProxyId = "string",
Timezone = "string",
TransparentBackground = false,
ViewportHeight = 0,
ViewportLandscape = false,
ViewportMobile = false,
ViewportTouch = false,
ViewportWidth = 0,
});
example, err := htmlcsstoimage.NewTemplate(ctx, "templateResource", &htmlcsstoimage.TemplateArgs{
Html: pulumi.String("string"),
Name: pulumi.String("string"),
JumboMaxHeight: pulumi.Int(0),
DeviceScale: pulumi.Float64(0),
DisableTwemoji: pulumi.Bool(false),
GoogleFonts: pulumi.StringArray{
pulumi.String("string"),
},
Css: pulumi.String("string"),
ColorScheme: pulumi.String("string"),
JumboMaxWidth: pulumi.Int(0),
MaxWaitMs: pulumi.Int(0),
MediaType: pulumi.String("string"),
Description: pulumi.String("string"),
MsDelay: pulumi.Int(0),
StorageDestinationId: pulumi.String("string"),
RenderWhenReady: pulumi.Bool(false),
RequestOverrides: .TemplateRequestOverrideArray{
&.TemplateRequestOverrideArgs{
Action: pulumi.String("string"),
ResourceTypes: html-css-to-image.RequestOverrideResourceTypeArray{
htmlcsstoimage.RequestOverrideResourceTypeBeacon,
},
Url: pulumi.String("string"),
},
},
Selector: pulumi.String("string"),
ProxyId: pulumi.String("string"),
Timezone: pulumi.String("string"),
TransparentBackground: pulumi.Bool(false),
ViewportHeight: pulumi.Int(0),
ViewportLandscape: pulumi.Bool(false),
ViewportMobile: pulumi.Bool(false),
ViewportTouch: pulumi.Bool(false),
ViewportWidth: pulumi.Int(0),
})
resource "html-css-to-image_template" "templateResource" {
lifecycle {
create_before_destroy = true
}
html = "string"
name = "string"
jumbo_max_height = 0
device_scale = 0
disable_twemoji = false
google_fonts = ["string"]
css = "string"
color_scheme = "string"
jumbo_max_width = 0
max_wait_ms = 0
media_type = "string"
description = "string"
ms_delay = 0
storage_destination_id = "string"
render_when_ready = false
request_overrides {
action = "string"
resource_types = ["beacon"]
url = "string"
}
selector = "string"
proxy_id = "string"
timezone = "string"
transparent_background = false
viewport_height = 0
viewport_landscape = false
viewport_mobile = false
viewport_touch = false
viewport_width = 0
}
var templateResource = new Template("templateResource", TemplateArgs.builder()
.html("string")
.name("string")
.jumboMaxHeight(0)
.deviceScale(0.0)
.disableTwemoji(false)
.googleFonts("string")
.css("string")
.colorScheme("string")
.jumboMaxWidth(0)
.maxWaitMs(0)
.mediaType("string")
.description("string")
.msDelay(0)
.storageDestinationId("string")
.renderWhenReady(false)
.requestOverrides(TemplateRequestOverrideArgs.builder()
.action("string")
.resourceTypes("beacon")
.url("string")
.build())
.selector("string")
.proxyId("string")
.timezone("string")
.transparentBackground(false)
.viewportHeight(0)
.viewportLandscape(false)
.viewportMobile(false)
.viewportTouch(false)
.viewportWidth(0)
.build());
template_resource = html_css_to_image.Template("templateResource",
html="string",
name="string",
jumbo_max_height=0,
device_scale=float(0),
disable_twemoji=False,
google_fonts=["string"],
css="string",
color_scheme="string",
jumbo_max_width=0,
max_wait_ms=0,
media_type="string",
description="string",
ms_delay=0,
storage_destination_id="string",
render_when_ready=False,
request_overrides=[{
"action": "string",
"resource_types": [html_css_to_image.RequestOverrideResourceType.BEACON],
"url": "string",
}],
selector="string",
proxy_id="string",
timezone="string",
transparent_background=False,
viewport_height=0,
viewport_landscape=False,
viewport_mobile=False,
viewport_touch=False,
viewport_width=0)
const templateResource = new html_css_to_image.Template("templateResource", {
html: "string",
name: "string",
jumboMaxHeight: 0,
deviceScale: 0,
disableTwemoji: false,
googleFonts: ["string"],
css: "string",
colorScheme: "string",
jumboMaxWidth: 0,
maxWaitMs: 0,
mediaType: "string",
description: "string",
msDelay: 0,
storageDestinationId: "string",
renderWhenReady: false,
requestOverrides: [{
action: "string",
resourceTypes: [html_css_to_image.RequestOverrideResourceType.Beacon],
url: "string",
}],
selector: "string",
proxyId: "string",
timezone: "string",
transparentBackground: false,
viewportHeight: 0,
viewportLandscape: false,
viewportMobile: false,
viewportTouch: false,
viewportWidth: 0,
});
type: html-css-to-image:Template
properties:
colorScheme: string
css: string
description: string
deviceScale: 0
disableTwemoji: false
googleFonts:
- string
html: string
jumboMaxHeight: 0
jumboMaxWidth: 0
maxWaitMs: 0
mediaType: string
msDelay: 0
name: string
proxyId: string
renderWhenReady: false
requestOverrides:
- action: string
resourceTypes:
- beacon
url: string
selector: string
storageDestinationId: string
timezone: string
transparentBackground: false
viewportHeight: 0
viewportLandscape: false
viewportMobile: false
viewportTouch: false
viewportWidth: 0
Template Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Template resource accepts the following input properties:
- Html string
- 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.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- Description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- Device
Scale double - 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.
- Disable
Twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- Google
Fonts List<string> - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- Jumbo
Max intHeight - 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.
- Jumbo
Max intWidth - 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.
- Max
Wait intMs - 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.
- Media
Type string - CSS media type to emulate: screen or print.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- Proxy
Id string - Specifies which configured organization proxy to use when rendering.
- Render
When boolReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- Request
Overrides List<Pulumi.Html Css To Image. Inputs. Template Request Override> - 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.
- Selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- Storage
Destination stringId - Specifies which configured organization storage destination receives the rendered image.
- Timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- Transparent
Background bool - Specifies whether the image is rendered with a transparent background.
- Viewport
Height int - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- Viewport
Landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- Viewport
Mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- Viewport
Touch bool - Specifies whether the emulated viewport supports touch events.
- Viewport
Width int - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- Html string
- 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.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- Description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- Device
Scale float64 - 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.
- Disable
Twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- Google
Fonts []string - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- Jumbo
Max intHeight - 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.
- Jumbo
Max intWidth - 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.
- Max
Wait intMs - 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.
- Media
Type string - CSS media type to emulate: screen or print.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- Proxy
Id string - Specifies which configured organization proxy to use when rendering.
- Render
When boolReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- Request
Overrides []TemplateRequest Override Args - 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.
- Selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- Storage
Destination stringId - Specifies which configured organization storage destination receives the rendered image.
- Timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- Transparent
Background bool - Specifies whether the image is rendered with a transparent background.
- Viewport
Height int - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- Viewport
Landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- Viewport
Mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- Viewport
Touch bool - Specifies whether the emulated viewport supports touch events.
- Viewport
Width int - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- html string
- 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.
- color_
scheme string - Sets the preferred color scheme: light or dark.
- css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- device_
scale number - 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.
- disable_
twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google_
fonts list(string) - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- jumbo_
max_ numberheight - 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.
- jumbo_
max_ numberwidth - 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.
- max_
wait_ numberms - 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.
- media_
type string - CSS media type to emulate: screen or print.
- ms_
delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy_
id string - Specifies which configured organization proxy to use when rendering.
- render_
when_ boolready - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request_
overrides list(object) - 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.
- selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage_
destination_ stringid - Specifies which configured organization storage destination receives the rendered image.
- timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent_
background bool - Specifies whether the image is rendered with a transparent background.
- viewport_
height number - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport_
landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- viewport_
mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport_
touch bool - Specifies whether the emulated viewport supports touch events.
- viewport_
width number - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- html String
- 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.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- css String
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description String
- An optional description of the template for your reference. Maximum: 1024 characters.
- device
Scale Double - 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.
- disable
Twemoji Boolean - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google
Fonts List<String> - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- jumbo
Max IntegerHeight - 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.
- jumbo
Max IntegerWidth - 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.
- max
Wait IntegerMs - 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.
- media
Type String - CSS media type to emulate: screen or print.
- ms
Delay Integer - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name String
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy
Id String - Specifies which configured organization proxy to use when rendering.
- render
When BooleanReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request
Overrides List<TemplateRequest Override> - 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.
- selector String
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination StringId - Specifies which configured organization storage destination receives the rendered image.
- timezone String
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent
Background Boolean - Specifies whether the image is rendered with a transparent background.
- viewport
Height Integer - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport
Landscape Boolean - Specifies whether the emulated viewport is in landscape orientation.
- viewport
Mobile Boolean - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport
Touch Boolean - Specifies whether the emulated viewport supports touch events.
- viewport
Width Integer - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- html string
- 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.
- color
Scheme string - Sets the preferred color scheme: light or dark.
- css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- device
Scale number - 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.
- disable
Twemoji boolean - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google
Fonts string[] - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- jumbo
Max numberHeight - 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.
- jumbo
Max numberWidth - 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.
- max
Wait numberMs - 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.
- media
Type string - CSS media type to emulate: screen or print.
- ms
Delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy
Id string - Specifies which configured organization proxy to use when rendering.
- render
When booleanReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request
Overrides TemplateRequest Override[] - 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.
- selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination stringId - Specifies which configured organization storage destination receives the rendered image.
- timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent
Background boolean - Specifies whether the image is rendered with a transparent background.
- viewport
Height number - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport
Landscape boolean - Specifies whether the emulated viewport is in landscape orientation.
- viewport
Mobile boolean - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport
Touch boolean - Specifies whether the emulated viewport supports touch events.
- viewport
Width number - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- html str
- 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.
- color_
scheme str - Sets the preferred color scheme: light or dark.
- css str
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description str
- An optional description of the template for your reference. Maximum: 1024 characters.
- device_
scale float - 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.
- disable_
twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google_
fonts Sequence[str] - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- jumbo_
max_ intheight - 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.
- jumbo_
max_ intwidth - 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.
- max_
wait_ intms - 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.
- media_
type str - CSS media type to emulate: screen or print.
- ms_
delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name str
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy_
id str - Specifies which configured organization proxy to use when rendering.
- render_
when_ boolready - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request_
overrides Sequence[TemplateRequest Override Args] - 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.
- selector str
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage_
destination_ strid - Specifies which configured organization storage destination receives the rendered image.
- timezone str
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent_
background bool - Specifies whether the image is rendered with a transparent background.
- viewport_
height int - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport_
landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- viewport_
mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport_
touch bool - Specifies whether the emulated viewport supports touch events.
- viewport_
width int - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- html String
- 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.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- css String
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description String
- An optional description of the template for your reference. Maximum: 1024 characters.
- device
Scale Number - 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.
- disable
Twemoji Boolean - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google
Fonts List<String> - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- jumbo
Max NumberHeight - 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.
- jumbo
Max NumberWidth - 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.
- max
Wait NumberMs - 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.
- media
Type String - CSS media type to emulate: screen or print.
- ms
Delay Number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name String
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy
Id String - Specifies which configured organization proxy to use when rendering.
- render
When BooleanReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request
Overrides List<Property Map> - 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.
- selector String
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination StringId - Specifies which configured organization storage destination receives the rendered image.
- timezone String
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent
Background Boolean - Specifies whether the image is rendered with a transparent background.
- viewport
Height Number - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport
Landscape Boolean - Specifies whether the emulated viewport is in landscape orientation.
- viewport
Mobile Boolean - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport
Touch Boolean - Specifies whether the emulated viewport supports touch events.
- viewport
Width Number - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
Outputs
All input properties are implicitly available as output properties. Additionally, the Template resource produces the following output properties:
- Created
At string - Creation timestamp.
- Id string
- The provider-assigned unique ID for this managed resource.
- Template
Type string - Template type; this resource manages html_css templates.
- Updated
At string - Last update timestamp.
- Version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- Created
At string - Creation timestamp.
- Id string
- The provider-assigned unique ID for this managed resource.
- Template
Type string - Template type; this resource manages html_css templates.
- Updated
At string - Last update timestamp.
- Version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- created_
at string - Creation timestamp.
- id string
- The provider-assigned unique ID for this managed resource.
- template_
type string - Template type; this resource manages html_css templates.
- updated_
at string - Last update timestamp.
- version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- created
At String - Creation timestamp.
- id String
- The provider-assigned unique ID for this managed resource.
- template
Type String - Template type; this resource manages html_css templates.
- updated
At String - Last update timestamp.
- version String
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- created
At string - Creation timestamp.
- id string
- The provider-assigned unique ID for this managed resource.
- template
Type string - Template type; this resource manages html_css templates.
- updated
At string - Last update timestamp.
- version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- created_
at str - Creation timestamp.
- id str
- The provider-assigned unique ID for this managed resource.
- template_
type str - Template type; this resource manages html_css templates.
- updated_
at str - Last update timestamp.
- version str
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- created
At String - Creation timestamp.
- id String
- The provider-assigned unique ID for this managed resource.
- template
Type String - Template type; this resource manages html_css templates.
- updated
At String - Last update timestamp.
- version String
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
Look up Existing Template Resource
Get an existing Template resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TemplateState, opts?: CustomResourceOptions): Template@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
color_scheme: Optional[str] = None,
created_at: Optional[str] = None,
css: Optional[str] = None,
description: Optional[str] = None,
device_scale: Optional[float] = None,
disable_twemoji: Optional[bool] = None,
google_fonts: Optional[Sequence[str]] = None,
html: Optional[str] = None,
jumbo_max_height: Optional[int] = None,
jumbo_max_width: Optional[int] = None,
max_wait_ms: Optional[int] = None,
media_type: Optional[str] = None,
ms_delay: Optional[int] = None,
name: Optional[str] = None,
proxy_id: Optional[str] = None,
render_when_ready: Optional[bool] = None,
request_overrides: Optional[Sequence[TemplateRequestOverrideArgs]] = None,
selector: Optional[str] = None,
storage_destination_id: Optional[str] = None,
template_type: Optional[str] = None,
timezone: Optional[str] = None,
transparent_background: Optional[bool] = None,
updated_at: Optional[str] = None,
version: Optional[str] = None,
viewport_height: Optional[int] = None,
viewport_landscape: Optional[bool] = None,
viewport_mobile: Optional[bool] = None,
viewport_touch: Optional[bool] = None,
viewport_width: Optional[int] = None) -> Templatefunc GetTemplate(ctx *Context, name string, id IDInput, state *TemplateState, opts ...ResourceOption) (*Template, error)public static Template Get(string name, Input<string> id, TemplateState? state, CustomResourceOptions? opts = null)public static Template get(String name, Output<String> id, TemplateState state, CustomResourceOptions options)resources: _: type: html-css-to-image:Template get: id: ${id}import {
to = html-css-to-image_template.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Created
At string - Creation timestamp.
- Css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- Description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- Device
Scale double - 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.
- Disable
Twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- Google
Fonts List<string> - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- Html string
- 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.
- Jumbo
Max intHeight - 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.
- Jumbo
Max intWidth - 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.
- Max
Wait intMs - 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.
- Media
Type string - CSS media type to emulate: screen or print.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- Proxy
Id string - Specifies which configured organization proxy to use when rendering.
- Render
When boolReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- Request
Overrides List<Pulumi.Html Css To Image. Inputs. Template Request Override> - 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.
- Selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- Storage
Destination stringId - Specifies which configured organization storage destination receives the rendered image.
- Template
Type string - Template type; this resource manages html_css templates.
- Timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- Transparent
Background bool - Specifies whether the image is rendered with a transparent background.
- Updated
At string - Last update timestamp.
- Version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- Viewport
Height int - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- Viewport
Landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- Viewport
Mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- Viewport
Touch bool - Specifies whether the emulated viewport supports touch events.
- Viewport
Width int - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Created
At string - Creation timestamp.
- Css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- Description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- Device
Scale float64 - 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.
- Disable
Twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- Google
Fonts []string - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- Html string
- 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.
- Jumbo
Max intHeight - 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.
- Jumbo
Max intWidth - 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.
- Max
Wait intMs - 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.
- Media
Type string - CSS media type to emulate: screen or print.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- Proxy
Id string - Specifies which configured organization proxy to use when rendering.
- Render
When boolReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- Request
Overrides []TemplateRequest Override Args - 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.
- Selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- Storage
Destination stringId - Specifies which configured organization storage destination receives the rendered image.
- Template
Type string - Template type; this resource manages html_css templates.
- Timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- Transparent
Background bool - Specifies whether the image is rendered with a transparent background.
- Updated
At string - Last update timestamp.
- Version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- Viewport
Height int - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- Viewport
Landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- Viewport
Mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- Viewport
Touch bool - Specifies whether the emulated viewport supports touch events.
- Viewport
Width int - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- color_
scheme string - Sets the preferred color scheme: light or dark.
- created_
at string - Creation timestamp.
- css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- device_
scale number - 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.
- disable_
twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google_
fonts list(string) - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- html string
- 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.
- jumbo_
max_ numberheight - 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.
- jumbo_
max_ numberwidth - 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.
- max_
wait_ numberms - 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.
- media_
type string - CSS media type to emulate: screen or print.
- ms_
delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy_
id string - Specifies which configured organization proxy to use when rendering.
- render_
when_ boolready - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request_
overrides list(object) - 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.
- selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage_
destination_ stringid - Specifies which configured organization storage destination receives the rendered image.
- template_
type string - Template type; this resource manages html_css templates.
- timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent_
background bool - Specifies whether the image is rendered with a transparent background.
- updated_
at string - Last update timestamp.
- version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- viewport_
height number - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport_
landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- viewport_
mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport_
touch bool - Specifies whether the emulated viewport supports touch events.
- viewport_
width number - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- created
At String - Creation timestamp.
- css String
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description String
- An optional description of the template for your reference. Maximum: 1024 characters.
- device
Scale Double - 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.
- disable
Twemoji Boolean - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google
Fonts List<String> - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- html String
- 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.
- jumbo
Max IntegerHeight - 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.
- jumbo
Max IntegerWidth - 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.
- max
Wait IntegerMs - 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.
- media
Type String - CSS media type to emulate: screen or print.
- ms
Delay Integer - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name String
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy
Id String - Specifies which configured organization proxy to use when rendering.
- render
When BooleanReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request
Overrides List<TemplateRequest Override> - 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.
- selector String
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination StringId - Specifies which configured organization storage destination receives the rendered image.
- template
Type String - Template type; this resource manages html_css templates.
- timezone String
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent
Background Boolean - Specifies whether the image is rendered with a transparent background.
- updated
At String - Last update timestamp.
- version String
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- viewport
Height Integer - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport
Landscape Boolean - Specifies whether the emulated viewport is in landscape orientation.
- viewport
Mobile Boolean - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport
Touch Boolean - Specifies whether the emulated viewport supports touch events.
- viewport
Width Integer - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- color
Scheme string - Sets the preferred color scheme: light or dark.
- created
At string - Creation timestamp.
- css string
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description string
- An optional description of the template for your reference. Maximum: 1024 characters.
- device
Scale number - 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.
- disable
Twemoji boolean - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google
Fonts string[] - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- html string
- 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.
- jumbo
Max numberHeight - 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.
- jumbo
Max numberWidth - 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.
- max
Wait numberMs - 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.
- media
Type string - CSS media type to emulate: screen or print.
- ms
Delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name string
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy
Id string - Specifies which configured organization proxy to use when rendering.
- render
When booleanReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request
Overrides TemplateRequest Override[] - 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.
- selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination stringId - Specifies which configured organization storage destination receives the rendered image.
- template
Type string - Template type; this resource manages html_css templates.
- timezone string
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent
Background boolean - Specifies whether the image is rendered with a transparent background.
- updated
At string - Last update timestamp.
- version string
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- viewport
Height number - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport
Landscape boolean - Specifies whether the emulated viewport is in landscape orientation.
- viewport
Mobile boolean - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport
Touch boolean - Specifies whether the emulated viewport supports touch events.
- viewport
Width number - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- color_
scheme str - Sets the preferred color scheme: light or dark.
- created_
at str - Creation timestamp.
- css str
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description str
- An optional description of the template for your reference. Maximum: 1024 characters.
- device_
scale float - 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.
- disable_
twemoji bool - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google_
fonts Sequence[str] - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- html str
- 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.
- jumbo_
max_ intheight - 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.
- jumbo_
max_ intwidth - 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.
- max_
wait_ intms - 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.
- media_
type str - CSS media type to emulate: screen or print.
- ms_
delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name str
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy_
id str - Specifies which configured organization proxy to use when rendering.
- render_
when_ boolready - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request_
overrides Sequence[TemplateRequest Override Args] - 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.
- selector str
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage_
destination_ strid - Specifies which configured organization storage destination receives the rendered image.
- template_
type str - Template type; this resource manages html_css templates.
- timezone str
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent_
background bool - Specifies whether the image is rendered with a transparent background.
- updated_
at str - Last update timestamp.
- version str
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- viewport_
height int - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport_
landscape bool - Specifies whether the emulated viewport is in landscape orientation.
- viewport_
mobile bool - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport_
touch bool - Specifies whether the emulated viewport supports touch events.
- viewport_
width int - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- created
At String - Creation timestamp.
- css String
- CSS used to style images rendered from the template. Handlebars expressions are not supported in CSS; put dynamic CSS in the HTML instead.
- description String
- An optional description of the template for your reference. Maximum: 1024 characters.
- device
Scale Number - 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.
- disable
Twemoji Boolean - Templates use Twemoji by default; set true to use supplied or native emoji fonts instead.
- google
Fonts List<String> - Google fonts to load. Separate multiple fonts with a pipe, such as 'Roboto|OpenSans', and set font-family in the CSS to use them.
- html String
- 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.
- jumbo
Max NumberHeight - 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.
- jumbo
Max NumberWidth - 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.
- max
Wait NumberMs - 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.
- media
Type String - CSS media type to emulate: screen or print.
- ms
Delay Number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- name String
- The name of the template, used to identify it in your account. Maximum: 64 characters.
- proxy
Id String - Specifies which configured organization proxy to use when rendering.
- render
When BooleanReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- request
Overrides List<Property Map> - 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.
- selector String
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination StringId - Specifies which configured organization storage destination receives the rendered image.
- template
Type String - Template type; this resource manages html_css templates.
- timezone String
- Sets the IANA timezone used by Chrome while rendering. Must be a recognized IANA timezone identifier.
- transparent
Background Boolean - Specifies whether the image is rendered with a transparent background.
- updated
At String - Last update timestamp.
- version String
- Latest saved template version. Represented as a decimal string in Pulumi to preserve int64 precision.
- viewport
Height Number - Sets the height of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
- viewport
Landscape Boolean - Specifies whether the emulated viewport is in landscape orientation.
- viewport
Mobile Boolean - Specifies whether the page uses mobile viewport behavior, including its viewport meta tag.
- viewport
Touch Boolean - Specifies whether the emulated viewport supports touch events.
- viewport
Width Number - Sets the width of Chrome's viewport and disables automatic cropping. Minimum: 1. Maximum: 6000. Both viewport dimensions must be supplied together.
Supporting Types
RequestOverrideResourceType, RequestOverrideResourceTypeArgs
- Beacon
beacon- Document
document- Stylesheet
stylesheet- Image
image- Image
Set image_set- Media
media- Font
font- Script
script- Text
Track text_track- Xhr
xhr- Fetch
fetch- Event
Source event_source- Manifest
manifest- Ping
ping- Img
img- Other
other
- Request
Override Resource Type Beacon beacon- Request
Override Resource Type Document document- Request
Override Resource Type Stylesheet stylesheet- Request
Override Resource Type Image image- Request
Override Resource Type Image Set image_set- Request
Override Resource Type Media media- Request
Override Resource Type Font font- Request
Override Resource Type Script script- Request
Override Resource Type Text Track text_track- Request
Override Resource Type Xhr xhr- Request
Override Resource Type Fetch fetch- Request
Override Resource Type Event Source event_source- Request
Override Resource Type Manifest manifest- Request
Override Resource Type Ping ping- Request
Override Resource Type Img img- Request
Override Resource Type Other other
- "beacon"
beacon- "document"
document- "stylesheet"
stylesheet- "image"
image- "image_
set" image_set- "media"
media- "font"
font- "script"
script- "text_
track" text_track- "xhr"
xhr- "fetch"
fetch- "event_
source" event_source- "manifest"
manifest- "ping"
ping- "img"
img- "other"
other
- Beacon
beacon- Document
document- Stylesheet
stylesheet- Image
image- Image
Set image_set- Media
media- Font
font- Script
script- Text
Track text_track- Xhr
xhr- Fetch
fetch- Event
Source event_source- Manifest
manifest- Ping
ping- Img
img- Other
other
- Beacon
beacon- Document
document- Stylesheet
stylesheet- Image
image- Image
Set image_set- Media
media- Font
font- Script
script- Text
Track text_track- Xhr
xhr- Fetch
fetch- Event
Source event_source- Manifest
manifest- Ping
ping- Img
img- Other
other
- BEACON
beacon- DOCUMENT
document- STYLESHEET
stylesheet- IMAGE
image- IMAGE_SET
image_set- MEDIA
media- FONT
font- SCRIPT
script- TEXT_TRACK
text_track- XHR
xhr- FETCH
fetch- EVENT_SOURCE
event_source- MANIFEST
manifest- PING
ping- IMG
img- OTHER
other
- "beacon"
beacon- "document"
document- "stylesheet"
stylesheet- "image"
image- "image_
set" image_set- "media"
media- "font"
font- "script"
script- "text_
track" text_track- "xhr"
xhr- "fetch"
fetch- "event_
source" event_source- "manifest"
manifest- "ping"
ping- "img"
img- "other"
other
TemplateRequestOverride, TemplateRequestOverrideArgs
- Action string
- Currently only
blockis supported. - Resource
Types List<Pulumi.Html Css To Image. Request Override Resource Type> - Browser resource types, such as
image,script,xhr, andfetch. Each value must be a supported resource type. - Url string
- Case-sensitive URL wildcard pattern using
*; at most 512 characters.
- Action string
- Currently only
blockis supported. - Resource
Types []RequestOverride Resource Type - Browser resource types, such as
image,script,xhr, andfetch. Each value must be a supported resource type. - Url string
- Case-sensitive URL wildcard pattern using
*; at most 512 characters.
- action string
- Currently only
blockis supported. - resource_
types list("beacon" | "document" | "stylesheet" | "image" | "image_set" | "media" | "font" | "script" | "text_ track" | "xhr" | "fetch" | "event_ source" | "manifest" | "ping" | "img" | "other") - Browser resource types, such as
image,script,xhr, andfetch. Each value must be a supported resource type. - url string
- Case-sensitive URL wildcard pattern using
*; at most 512 characters.
- action String
- Currently only
blockis supported. - resource
Types List<RequestOverride Resource Type> - Browser resource types, such as
image,script,xhr, andfetch. Each value must be a supported resource type. - url String
- Case-sensitive URL wildcard pattern using
*; at most 512 characters.
- action string
- Currently only
blockis supported. - resource
Types RequestOverride Resource Type[] - Browser resource types, such as
image,script,xhr, andfetch. Each value must be a supported resource type. - url string
- Case-sensitive URL wildcard pattern using
*; at most 512 characters.
- action str
- Currently only
blockis supported. - resource_
types Sequence[RequestOverride Resource Type] - Browser resource types, such as
image,script,xhr, andfetch. Each value must be a supported resource type. - url str
- Case-sensitive URL wildcard pattern using
*; at most 512 characters.
- action String
- Currently only
blockis supported. - resource
Types List<"beacon" | "document" | "stylesheet" | "image" | "image_set" | "media" | "font" | "script" | "text_ track" | "xhr" | "fetch" | "event_ source" | "manifest" | "ping" | "img" | "other"> - Browser resource types, such as
image,script,xhr, andfetch. Each value must be a supported resource type. - url String
- Case-sensitive URL wildcard pattern using
*; at most 512 characters.
Package Details
- Repository
- html-css-to-image htmlcsstoimage/pulumi-html-css-to-image
- License
- MIT
- Notes
- This Pulumi package is based on the
html-css-to-imageTerraform Provider.
HTML/CSS to Imagepublished on Tuesday, Sep 29, 2026 by htmlcsstoimage