published on Tuesday, Sep 29, 2026 by htmlcsstoimage
HTML/CSS to Imagepublished on Tuesday, Sep 29, 2026 by htmlcsstoimage
Create ImageUrl Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ImageUrl(name: string, args: ImageUrlArgs, opts?: CustomResourceOptions);@overload
def ImageUrl(resource_name: str,
args: ImageUrlArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ImageUrl(resource_name: str,
opts: Optional[ResourceOptions] = None,
url: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
ms_delay: Optional[int] = None,
css: Optional[str] = None,
device_scale: Optional[float] = None,
disable_twemoji: Optional[bool] = None,
format: Optional[str] = None,
full_screen: Optional[bool] = None,
headers: Optional[Mapping[str, str]] = None,
identify_as_hcti: Optional[bool] = None,
include_headers_on_subrequests: Optional[bool] = None,
jumbo_max_height: Optional[int] = None,
jumbo_max_width: Optional[int] = None,
max_render_once: Optional[bool] = None,
max_wait_ms: Optional[int] = None,
color_scheme: Optional[str] = None,
media_type: Optional[str] = None,
proxy_id: Optional[str] = None,
pdf_options: Optional[ImageUrlPdfOptionsArgs] = None,
additional_header_origins: Optional[Sequence[str]] = None,
render_when_ready: Optional[bool] = None,
request_overrides: Optional[Sequence[ImageUrlRequestOverrideArgs]] = None,
selector: Optional[str] = None,
storage_destination_id: Optional[str] = None,
timezone: Optional[str] = None,
transparent_background: Optional[bool] = None,
block_consent_banners: 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 NewImageUrl(ctx *Context, name string, args ImageUrlArgs, opts ...ResourceOption) (*ImageUrl, error)public ImageUrl(string name, ImageUrlArgs args, CustomResourceOptions? opts = null)
public ImageUrl(String name, ImageUrlArgs args)
public ImageUrl(String name, ImageUrlArgs args, CustomResourceOptions options)
type: html-css-to-image:ImageUrl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "html-css-to-image_image_url" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ImageUrlArgs
- 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 ImageUrlArgs
- 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 ImageUrlArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ImageUrlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ImageUrlArgs
- 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 imageUrlResource = new HtmlCssToImage.ImageUrl("imageUrlResource", new()
{
Url = "string",
Metadata =
{
{ "string", "string" },
},
MsDelay = 0,
Css = "string",
DeviceScale = 0.0,
DisableTwemoji = false,
Format = "string",
FullScreen = false,
Headers =
{
{ "string", "string" },
},
IdentifyAsHcti = false,
IncludeHeadersOnSubrequests = false,
JumboMaxHeight = 0,
JumboMaxWidth = 0,
MaxRenderOnce = false,
MaxWaitMs = 0,
ColorScheme = "string",
MediaType = "string",
ProxyId = "string",
PdfOptions = new HtmlCssToImage.Inputs.ImageUrlPdfOptionsArgs
{
Margins = new HtmlCssToImage.Inputs.ImageUrlPdfOptionsMarginsArgs
{
Bottom = "string",
Left = "string",
Right = "string",
Top = "string",
},
PageHeight = "string",
PageWidth = "string",
PrintBackground = false,
Scale = 0.0,
},
AdditionalHeaderOrigins = new[]
{
"string",
},
RenderWhenReady = false,
RequestOverrides = new[]
{
new HtmlCssToImage.Inputs.ImageUrlRequestOverrideArgs
{
Action = "string",
ResourceTypes = new[]
{
HtmlCssToImage.RequestOverrideResourceType.Beacon,
},
Url = "string",
},
},
Selector = "string",
StorageDestinationId = "string",
Timezone = "string",
TransparentBackground = false,
BlockConsentBanners = false,
ViewportHeight = 0,
ViewportLandscape = false,
ViewportMobile = false,
ViewportTouch = false,
ViewportWidth = 0,
});
example, err := htmlcsstoimage.NewImageUrl(ctx, "imageUrlResource", &htmlcsstoimage.ImageUrlArgs{
Url: pulumi.String("string"),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
MsDelay: pulumi.Int(0),
Css: pulumi.String("string"),
DeviceScale: pulumi.Float64(0),
DisableTwemoji: pulumi.Bool(false),
Format: pulumi.String("string"),
FullScreen: pulumi.Bool(false),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
IdentifyAsHcti: pulumi.Bool(false),
IncludeHeadersOnSubrequests: pulumi.Bool(false),
JumboMaxHeight: pulumi.Int(0),
JumboMaxWidth: pulumi.Int(0),
MaxRenderOnce: pulumi.Bool(false),
MaxWaitMs: pulumi.Int(0),
ColorScheme: pulumi.String("string"),
MediaType: pulumi.String("string"),
ProxyId: pulumi.String("string"),
PdfOptions: &.ImageUrlPdfOptionsArgs{
Margins: &.ImageUrlPdfOptionsMarginsArgs{
Bottom: pulumi.String("string"),
Left: pulumi.String("string"),
Right: pulumi.String("string"),
Top: pulumi.String("string"),
},
PageHeight: pulumi.String("string"),
PageWidth: pulumi.String("string"),
PrintBackground: pulumi.Bool(false),
Scale: pulumi.Float64(0),
},
AdditionalHeaderOrigins: pulumi.StringArray{
pulumi.String("string"),
},
RenderWhenReady: pulumi.Bool(false),
RequestOverrides: .ImageUrlRequestOverrideArray{
&.ImageUrlRequestOverrideArgs{
Action: pulumi.String("string"),
ResourceTypes: html-css-to-image.RequestOverrideResourceTypeArray{
htmlcsstoimage.RequestOverrideResourceTypeBeacon,
},
Url: pulumi.String("string"),
},
},
Selector: pulumi.String("string"),
StorageDestinationId: pulumi.String("string"),
Timezone: pulumi.String("string"),
TransparentBackground: pulumi.Bool(false),
BlockConsentBanners: 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_image_url" "imageUrlResource" {
lifecycle {
create_before_destroy = true
}
url = "string"
metadata = {
"string" = "string"
}
ms_delay = 0
css = "string"
device_scale = 0
disable_twemoji = false
format = "string"
full_screen = false
headers = {
"string" = "string"
}
identify_as_hcti = false
include_headers_on_subrequests = false
jumbo_max_height = 0
jumbo_max_width = 0
max_render_once = false
max_wait_ms = 0
color_scheme = "string"
media_type = "string"
proxy_id = "string"
pdf_options = {
margins = {
bottom = "string"
left = "string"
right = "string"
top = "string"
}
page_height = "string"
page_width = "string"
print_background = false
scale = 0
}
additional_header_origins = ["string"]
render_when_ready = false
request_overrides {
action = "string"
resource_types = ["beacon"]
url = "string"
}
selector = "string"
storage_destination_id = "string"
timezone = "string"
transparent_background = false
block_consent_banners = false
viewport_height = 0
viewport_landscape = false
viewport_mobile = false
viewport_touch = false
viewport_width = 0
}
var imageUrlResource = new ImageUrl("imageUrlResource", ImageUrlArgs.builder()
.url("string")
.metadata(Map.of("string", "string"))
.msDelay(0)
.css("string")
.deviceScale(0.0)
.disableTwemoji(false)
.format("string")
.fullScreen(false)
.headers(Map.of("string", "string"))
.identifyAsHcti(false)
.includeHeadersOnSubrequests(false)
.jumboMaxHeight(0)
.jumboMaxWidth(0)
.maxRenderOnce(false)
.maxWaitMs(0)
.colorScheme("string")
.mediaType("string")
.proxyId("string")
.pdfOptions(ImageUrlPdfOptionsArgs.builder()
.margins(ImageUrlPdfOptionsMarginsArgs.builder()
.bottom("string")
.left("string")
.right("string")
.top("string")
.build())
.pageHeight("string")
.pageWidth("string")
.printBackground(false)
.scale(0.0)
.build())
.additionalHeaderOrigins("string")
.renderWhenReady(false)
.requestOverrides(ImageUrlRequestOverrideArgs.builder()
.action("string")
.resourceTypes("beacon")
.url("string")
.build())
.selector("string")
.storageDestinationId("string")
.timezone("string")
.transparentBackground(false)
.blockConsentBanners(false)
.viewportHeight(0)
.viewportLandscape(false)
.viewportMobile(false)
.viewportTouch(false)
.viewportWidth(0)
.build());
image_url_resource = html_css_to_image.ImageUrl("imageUrlResource",
url="string",
metadata={
"string": "string",
},
ms_delay=0,
css="string",
device_scale=float(0),
disable_twemoji=False,
format="string",
full_screen=False,
headers={
"string": "string",
},
identify_as_hcti=False,
include_headers_on_subrequests=False,
jumbo_max_height=0,
jumbo_max_width=0,
max_render_once=False,
max_wait_ms=0,
color_scheme="string",
media_type="string",
proxy_id="string",
pdf_options={
"margins": {
"bottom": "string",
"left": "string",
"right": "string",
"top": "string",
},
"page_height": "string",
"page_width": "string",
"print_background": False,
"scale": float(0),
},
additional_header_origins=["string"],
render_when_ready=False,
request_overrides=[{
"action": "string",
"resource_types": [html_css_to_image.RequestOverrideResourceType.BEACON],
"url": "string",
}],
selector="string",
storage_destination_id="string",
timezone="string",
transparent_background=False,
block_consent_banners=False,
viewport_height=0,
viewport_landscape=False,
viewport_mobile=False,
viewport_touch=False,
viewport_width=0)
const imageUrlResource = new html_css_to_image.ImageUrl("imageUrlResource", {
url: "string",
metadata: {
string: "string",
},
msDelay: 0,
css: "string",
deviceScale: 0,
disableTwemoji: false,
format: "string",
fullScreen: false,
headers: {
string: "string",
},
identifyAsHcti: false,
includeHeadersOnSubrequests: false,
jumboMaxHeight: 0,
jumboMaxWidth: 0,
maxRenderOnce: false,
maxWaitMs: 0,
colorScheme: "string",
mediaType: "string",
proxyId: "string",
pdfOptions: {
margins: {
bottom: "string",
left: "string",
right: "string",
top: "string",
},
pageHeight: "string",
pageWidth: "string",
printBackground: false,
scale: 0,
},
additionalHeaderOrigins: ["string"],
renderWhenReady: false,
requestOverrides: [{
action: "string",
resourceTypes: [html_css_to_image.RequestOverrideResourceType.Beacon],
url: "string",
}],
selector: "string",
storageDestinationId: "string",
timezone: "string",
transparentBackground: false,
blockConsentBanners: false,
viewportHeight: 0,
viewportLandscape: false,
viewportMobile: false,
viewportTouch: false,
viewportWidth: 0,
});
type: html-css-to-image:ImageUrl
properties:
additionalHeaderOrigins:
- string
blockConsentBanners: false
colorScheme: string
css: string
deviceScale: 0
disableTwemoji: false
format: string
fullScreen: false
headers:
string: string
identifyAsHcti: false
includeHeadersOnSubrequests: false
jumboMaxHeight: 0
jumboMaxWidth: 0
maxRenderOnce: false
maxWaitMs: 0
mediaType: string
metadata:
string: string
msDelay: 0
pdfOptions:
margins:
bottom: string
left: string
right: string
top: string
pageHeight: string
pageWidth: string
printBackground: false
scale: 0
proxyId: string
renderWhenReady: false
requestOverrides:
- action: string
resourceTypes:
- beacon
url: string
selector: string
storageDestinationId: string
timezone: string
transparentBackground: false
url: string
viewportHeight: 0
viewportLandscape: false
viewportMobile: false
viewportTouch: false
viewportWidth: 0
ImageUrl 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 ImageUrl resource accepts the following input properties:
- Url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- Additional
Header List<string>Origins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- Format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- Full
Screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- Headers Dictionary<string, string>
- 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. - Identify
As boolHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- Include
Headers boolOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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
Render boolOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- Metadata Dictionary<string, string>
- Custom key-value metadata stored with the image.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Pdf
Options Pulumi.Html Css To Image. Inputs. Image Url Pdf Options - Rendering option.
- 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. Image Url 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.
- Url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- Additional
Header []stringOrigins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- Format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- Full
Screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- Headers map[string]string
- 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. - Identify
As boolHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- Include
Headers boolOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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
Render boolOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- Metadata map[string]string
- Custom key-value metadata stored with the image.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Pdf
Options ImageUrl Pdf Options Args - Rendering option.
- 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 []ImageUrl Request 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.
- url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- additional_
header_ list(string)origins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- color_
scheme string - Sets the preferred color scheme: light or dark.
- css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full_
screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers map(string)
- 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. - identify_
as_ boolhcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- include_
headers_ boolon_ subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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_
render_ boolonce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata map(string)
- Custom key-value metadata stored with the image.
- ms_
delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- pdf_
options object - Rendering option.
- 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.
- url String
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- additional
Header List<String>Origins - 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.
- Boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- css String
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format String
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full
Screen Boolean - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers Map<String,String>
- 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. - identify
As BooleanHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- include
Headers BooleanOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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
Render BooleanOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata Map<String,String>
- Custom key-value metadata stored with the image.
- ms
Delay Integer - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- pdf
Options ImageUrl Pdf Options - Rendering option.
- 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<ImageUrl 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 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.
- url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- additional
Header string[]Origins - 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.
- boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme string - Sets the preferred color scheme: light or dark.
- css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full
Screen boolean - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers {[key: string]: string}
- 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. - identify
As booleanHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- include
Headers booleanOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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
Render booleanOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata {[key: string]: string}
- Custom key-value metadata stored with the image.
- ms
Delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- pdf
Options ImageUrl Pdf Options - Rendering option.
- 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 ImageUrl 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 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.
- url str
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- additional_
header_ Sequence[str]origins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- color_
scheme str - Sets the preferred color scheme: light or dark.
- css str
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format str
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full_
screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers Mapping[str, str]
- 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. - identify_
as_ boolhcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- include_
headers_ boolon_ subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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_
render_ boolonce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata Mapping[str, str]
- Custom key-value metadata stored with the image.
- ms_
delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- pdf_
options ImageUrl Pdf Options Args - Rendering option.
- 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[ImageUrl Request 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.
- url String
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- additional
Header List<String>Origins - 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.
- Boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- css String
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format String
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full
Screen Boolean - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers Map<String>
- 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. - identify
As BooleanHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- include
Headers BooleanOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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
Render BooleanOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata Map<String>
- Custom key-value metadata stored with the image.
- ms
Delay Number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- pdf
Options Property Map - Rendering option.
- 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 ImageUrl resource produces the following output properties:
- Created
At string - Creation timestamp.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Render stringStored At - Last HCTI stored-render timestamp, when available.
- Og
Config stringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- Og
Config stringId - Associated OG configuration ID, if any.
- Public
Url string - Public GET rendering URL, or null when HCTI storage is disabled.
- Render
Method string - HTTP method required to render: GET or PUT.
- Render
Requires boolAuth - Whether rendering requires API authentication.
- Rendering
Url string - Rendering operation URL. Creation does not render bytes.
- Saved
To stringStorage Destination At - Last base-image save to custom storage, when available.
- Storage
Destination boolHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- Created
At string - Creation timestamp.
- Id string
- The provider-assigned unique ID for this managed resource.
- Image
Url string - Rendering operation URL. Creation does not render bytes.
- Last
Render stringStored At - Last HCTI stored-render timestamp, when available.
- Og
Config stringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- Og
Config stringId - Associated OG configuration ID, if any.
- Public
Url string - Public GET rendering URL, or null when HCTI storage is disabled.
- Render
Method string - HTTP method required to render: GET or PUT.
- Render
Requires boolAuth - Whether rendering requires API authentication.
- Saved
To stringStorage Destination At - Last base-image save to custom storage, when available.
- Storage
Destination boolHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- created_
at string - Creation timestamp.
- id string
- The provider-assigned unique ID for this managed resource.
- image_
url string - Rendering operation URL. Creation does not render bytes.
- last_
render_ stringstored_ at - Last HCTI stored-render timestamp, when available.
- og_
config_ stringcontent_ version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og_
config_ stringid - Associated OG configuration ID, if any.
- public_
url string - Public GET rendering URL, or null when HCTI storage is disabled.
- render_
method string - HTTP method required to render: GET or PUT.
- render_
requires_ boolauth - Whether rendering requires API authentication.
- saved_
to_ stringstorage_ destination_ at - Last base-image save to custom storage, when available.
- storage_
destination_ boolhcti_ storage_ disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- created
At String - Creation timestamp.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Url String - Rendering operation URL. Creation does not render bytes.
- last
Render StringStored At - Last HCTI stored-render timestamp, when available.
- og
Config StringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og
Config StringId - Associated OG configuration ID, if any.
- public
Url String - Public GET rendering URL, or null when HCTI storage is disabled.
- render
Method String - HTTP method required to render: GET or PUT.
- render
Requires BooleanAuth - Whether rendering requires API authentication.
- saved
To StringStorage Destination At - Last base-image save to custom storage, when available.
- storage
Destination BooleanHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- created
At string - Creation timestamp.
- id string
- The provider-assigned unique ID for this managed resource.
- image
Url string - Rendering operation URL. Creation does not render bytes.
- last
Render stringStored At - Last HCTI stored-render timestamp, when available.
- og
Config stringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og
Config stringId - Associated OG configuration ID, if any.
- public
Url string - Public GET rendering URL, or null when HCTI storage is disabled.
- render
Method string - HTTP method required to render: GET or PUT.
- render
Requires booleanAuth - Whether rendering requires API authentication.
- saved
To stringStorage Destination At - Last base-image save to custom storage, when available.
- storage
Destination booleanHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- created_
at str - Creation timestamp.
- id str
- The provider-assigned unique ID for this managed resource.
- image_
url str - Rendering operation URL. Creation does not render bytes.
- last_
render_ strstored_ at - Last HCTI stored-render timestamp, when available.
- og_
config_ strcontent_ version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og_
config_ strid - Associated OG configuration ID, if any.
- public_
url str - Public GET rendering URL, or null when HCTI storage is disabled.
- render_
method str - HTTP method required to render: GET or PUT.
- render_
requires_ boolauth - Whether rendering requires API authentication.
- saved_
to_ strstorage_ destination_ at - Last base-image save to custom storage, when available.
- storage_
destination_ boolhcti_ storage_ disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- created
At String - Creation timestamp.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Url String - Rendering operation URL. Creation does not render bytes.
- last
Render StringStored At - Last HCTI stored-render timestamp, when available.
- og
Config StringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og
Config StringId - Associated OG configuration ID, if any.
- public
Url String - Public GET rendering URL, or null when HCTI storage is disabled.
- render
Method String - HTTP method required to render: GET or PUT.
- render
Requires BooleanAuth - Whether rendering requires API authentication.
- saved
To StringStorage Destination At - Last base-image save to custom storage, when available.
- storage
Destination BooleanHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
Look up Existing ImageUrl Resource
Get an existing ImageUrl 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?: ImageUrlState, opts?: CustomResourceOptions): ImageUrl@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_header_origins: Optional[Sequence[str]] = None,
block_consent_banners: Optional[bool] = None,
color_scheme: Optional[str] = None,
created_at: Optional[str] = None,
css: Optional[str] = None,
device_scale: Optional[float] = None,
disable_twemoji: Optional[bool] = None,
format: Optional[str] = None,
full_screen: Optional[bool] = None,
headers: Optional[Mapping[str, str]] = None,
identify_as_hcti: Optional[bool] = None,
image_url: Optional[str] = None,
include_headers_on_subrequests: Optional[bool] = None,
jumbo_max_height: Optional[int] = None,
jumbo_max_width: Optional[int] = None,
last_render_stored_at: Optional[str] = None,
max_render_once: Optional[bool] = None,
max_wait_ms: Optional[int] = None,
media_type: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
ms_delay: Optional[int] = None,
og_config_content_version: Optional[str] = None,
og_config_id: Optional[str] = None,
pdf_options: Optional[ImageUrlPdfOptionsArgs] = None,
proxy_id: Optional[str] = None,
public_url: Optional[str] = None,
render_method: Optional[str] = None,
render_requires_auth: Optional[bool] = None,
render_when_ready: Optional[bool] = None,
request_overrides: Optional[Sequence[ImageUrlRequestOverrideArgs]] = None,
saved_to_storage_destination_at: Optional[str] = None,
selector: Optional[str] = None,
storage_destination_hcti_storage_disabled: Optional[bool] = None,
storage_destination_id: Optional[str] = None,
timezone: Optional[str] = None,
transparent_background: Optional[bool] = None,
url: 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) -> ImageUrlfunc GetImageUrl(ctx *Context, name string, id IDInput, state *ImageUrlState, opts ...ResourceOption) (*ImageUrl, error)public static ImageUrl Get(string name, Input<string> id, ImageUrlState? state, CustomResourceOptions? opts = null)public static ImageUrl get(String name, Output<String> id, ImageUrlState state, CustomResourceOptions options)resources: _: type: html-css-to-image:ImageUrl get: id: ${id}import {
to = html-css-to-image_image_url.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.
- Additional
Header List<string>Origins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Created
At string - Creation timestamp.
- Css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- Format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- Full
Screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- Headers Dictionary<string, string>
- 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. - Identify
As boolHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- Include
Headers boolOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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.
- Last
Render stringStored At - Last HCTI stored-render timestamp, when available.
- Max
Render boolOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- Metadata Dictionary<string, string>
- Custom key-value metadata stored with the image.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Og
Config stringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- Og
Config stringId - Associated OG configuration ID, if any.
- Pdf
Options Pulumi.Html Css To Image. Inputs. Image Url Pdf Options - Rendering option.
- Proxy
Id string - Specifies which configured organization proxy to use when rendering.
- Public
Url string - Public GET rendering URL, or null when HCTI storage is disabled.
- Render
Method string - HTTP method required to render: GET or PUT.
- Render
Requires boolAuth - Whether rendering requires API authentication.
- Render
When boolReady - Waits until the page signals that the screenshot is ready. The image fails if the readiness signal is never sent.
- Rendering
Url string - Rendering operation URL. Creation does not render bytes.
- Request
Overrides List<Pulumi.Html Css To Image. Inputs. Image Url 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.
- Saved
To stringStorage Destination At - Last base-image save to custom storage, when available.
- Selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- Storage
Destination boolHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- 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.
- Url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- 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.
- Additional
Header []stringOrigins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- Color
Scheme string - Sets the preferred color scheme: light or dark.
- Created
At string - Creation timestamp.
- Css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- Format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- Full
Screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- Headers map[string]string
- 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. - Identify
As boolHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- Image
Url string - Rendering operation URL. Creation does not render bytes.
- Include
Headers boolOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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.
- Last
Render stringStored At - Last HCTI stored-render timestamp, when available.
- Max
Render boolOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- Metadata map[string]string
- Custom key-value metadata stored with the image.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Og
Config stringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- Og
Config stringId - Associated OG configuration ID, if any.
- Pdf
Options ImageUrl Pdf Options Args - Rendering option.
- Proxy
Id string - Specifies which configured organization proxy to use when rendering.
- Public
Url string - Public GET rendering URL, or null when HCTI storage is disabled.
- Render
Method string - HTTP method required to render: GET or PUT.
- Render
Requires boolAuth - Whether rendering requires API authentication.
- 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 []ImageUrl Request 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.
- Saved
To stringStorage Destination At - Last base-image save to custom storage, when available.
- Selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- Storage
Destination boolHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- 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.
- Url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- 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.
- additional_
header_ list(string)origins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- color_
scheme string - Sets the preferred color scheme: light or dark.
- created_
at string - Creation timestamp.
- css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full_
screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers map(string)
- 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. - identify_
as_ boolhcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- image_
url string - Rendering operation URL. Creation does not render bytes.
- include_
headers_ boolon_ subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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.
- last_
render_ stringstored_ at - Last HCTI stored-render timestamp, when available.
- max_
render_ boolonce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata map(string)
- Custom key-value metadata stored with the image.
- ms_
delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- og_
config_ stringcontent_ version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og_
config_ stringid - Associated OG configuration ID, if any.
- pdf_
options object - Rendering option.
- proxy_
id string - Specifies which configured organization proxy to use when rendering.
- public_
url string - Public GET rendering URL, or null when HCTI storage is disabled.
- render_
method string - HTTP method required to render: GET or PUT.
- render_
requires_ boolauth - Whether rendering requires API authentication.
- 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.
- saved_
to_ stringstorage_ destination_ at - Last base-image save to custom storage, when available.
- selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage_
destination_ boolhcti_ storage_ disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- 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.
- url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- 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.
- additional
Header List<String>Origins - 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.
- Boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- created
At String - Creation timestamp.
- css String
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format String
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full
Screen Boolean - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers Map<String,String>
- 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. - identify
As BooleanHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- image
Url String - Rendering operation URL. Creation does not render bytes.
- include
Headers BooleanOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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.
- last
Render StringStored At - Last HCTI stored-render timestamp, when available.
- max
Render BooleanOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata Map<String,String>
- Custom key-value metadata stored with the image.
- ms
Delay Integer - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- og
Config StringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og
Config StringId - Associated OG configuration ID, if any.
- pdf
Options ImageUrl Pdf Options - Rendering option.
- proxy
Id String - Specifies which configured organization proxy to use when rendering.
- public
Url String - Public GET rendering URL, or null when HCTI storage is disabled.
- render
Method String - HTTP method required to render: GET or PUT.
- render
Requires BooleanAuth - Whether rendering requires API authentication.
- 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<ImageUrl 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.
- saved
To StringStorage Destination At - Last base-image save to custom storage, when available.
- selector String
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination BooleanHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- 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.
- url String
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- 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.
- additional
Header string[]Origins - 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.
- boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme string - Sets the preferred color scheme: light or dark.
- created
At string - Creation timestamp.
- css string
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format string
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full
Screen boolean - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers {[key: string]: string}
- 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. - identify
As booleanHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- image
Url string - Rendering operation URL. Creation does not render bytes.
- include
Headers booleanOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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.
- last
Render stringStored At - Last HCTI stored-render timestamp, when available.
- max
Render booleanOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata {[key: string]: string}
- Custom key-value metadata stored with the image.
- ms
Delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- og
Config stringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og
Config stringId - Associated OG configuration ID, if any.
- pdf
Options ImageUrl Pdf Options - Rendering option.
- proxy
Id string - Specifies which configured organization proxy to use when rendering.
- public
Url string - Public GET rendering URL, or null when HCTI storage is disabled.
- render
Method string - HTTP method required to render: GET or PUT.
- render
Requires booleanAuth - Whether rendering requires API authentication.
- 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 ImageUrl 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.
- saved
To stringStorage Destination At - Last base-image save to custom storage, when available.
- selector string
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination booleanHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- 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.
- url string
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- 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.
- additional_
header_ Sequence[str]origins - 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- color_
scheme str - Sets the preferred color scheme: light or dark.
- created_
at str - Creation timestamp.
- css str
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format str
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full_
screen bool - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers Mapping[str, str]
- 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. - identify_
as_ boolhcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- image_
url str - Rendering operation URL. Creation does not render bytes.
- include_
headers_ boolon_ subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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.
- last_
render_ strstored_ at - Last HCTI stored-render timestamp, when available.
- max_
render_ boolonce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata Mapping[str, str]
- Custom key-value metadata stored with the image.
- ms_
delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- og_
config_ strcontent_ version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og_
config_ strid - Associated OG configuration ID, if any.
- pdf_
options ImageUrl Pdf Options Args - Rendering option.
- proxy_
id str - Specifies which configured organization proxy to use when rendering.
- public_
url str - Public GET rendering URL, or null when HCTI storage is disabled.
- render_
method str - HTTP method required to render: GET or PUT.
- render_
requires_ boolauth - Whether rendering requires API authentication.
- 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[ImageUrl Request 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.
- saved_
to_ strstorage_ destination_ at - Last base-image save to custom storage, when available.
- selector str
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage_
destination_ boolhcti_ storage_ disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- 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.
- url str
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- 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.
- additional
Header List<String>Origins - 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.
- Boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme String - Sets the preferred color scheme: light or dark.
- created
At String - Creation timestamp.
- css String
- CSS injected into the loaded URL to override styles on the page.
- 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 - Set false to inject Twemoji into the loaded URL page. Omitted or true leaves the page's emoji handling unchanged.
- format String
- Rendering URL format: png, jpg, jpeg, webp, or pdf. Does not restrict later renders to this format.
- full
Screen Boolean - Take a screenshot of the entire screen after scrolling down and back to the top.
- headers Map<String>
- 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. - identify
As BooleanHcti - Identify the top-level page navigation as an HCTI screenshot request using the X-HCTI-SCREENSHOT header.
- image
Url String - Rendering operation URL. Creation does not render bytes.
- include
Headers BooleanOn Subrequests - Include custom headers on subrequests to the requested URL's origin and any additional_header_origins. Defaults to false. Requires at least one header.
- 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.
- last
Render StringStored At - Last HCTI stored-render timestamp, when available.
- max
Render BooleanOnce - Ensure the image is only ever rendered and saved one time. This is an advanced option not applicable to most requests.
- 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.
- metadata Map<String>
- Custom key-value metadata stored with the image.
- ms
Delay Number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- og
Config StringContent Version - Associated OG content version, if any. Represented as a decimal string in Pulumi to preserve int64 precision.
- og
Config StringId - Associated OG configuration ID, if any.
- pdf
Options Property Map - Rendering option.
- proxy
Id String - Specifies which configured organization proxy to use when rendering.
- public
Url String - Public GET rendering URL, or null when HCTI storage is disabled.
- render
Method String - HTTP method required to render: GET or PUT.
- render
Requires BooleanAuth - Whether rendering requires API authentication.
- 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.
- saved
To StringStorage Destination At - Last base-image save to custom storage, when available.
- selector String
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage
Destination BooleanHcti Storage Disabled - Whether rendered output is saved only to custom storage, recorded when the image was created.
- 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.
- url String
- Public HTTP or HTTPS URL to capture. Required for URL image requests.
- 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
ImageUrlPdfOptions, ImageUrlPdfOptionsArgs
- Margins
Pulumi.
Html Css To Image. Inputs. Image Url Pdf Options Margins - PDF margins. Supply all four sides with units.
- Page
Height string - Page height with px, in, cm, mm, or pt units.
- Page
Width string - Page width with px, in, cm, mm, or pt units.
- Print
Background bool - Print page backgrounds. Omission lets the API choose.
- Scale double
- PDF scale from 0.1 to 2.
- Margins
Image
Url Pdf Options Margins - PDF margins. Supply all four sides with units.
- Page
Height string - Page height with px, in, cm, mm, or pt units.
- Page
Width string - Page width with px, in, cm, mm, or pt units.
- Print
Background bool - Print page backgrounds. Omission lets the API choose.
- Scale float64
- PDF scale from 0.1 to 2.
- margins object
- PDF margins. Supply all four sides with units.
- page_
height string - Page height with px, in, cm, mm, or pt units.
- page_
width string - Page width with px, in, cm, mm, or pt units.
- print_
background bool - Print page backgrounds. Omission lets the API choose.
- scale number
- PDF scale from 0.1 to 2.
- margins
Image
Url Pdf Options Margins - PDF margins. Supply all four sides with units.
- page
Height String - Page height with px, in, cm, mm, or pt units.
- page
Width String - Page width with px, in, cm, mm, or pt units.
- print
Background Boolean - Print page backgrounds. Omission lets the API choose.
- scale Double
- PDF scale from 0.1 to 2.
- margins
Image
Url Pdf Options Margins - PDF margins. Supply all four sides with units.
- page
Height string - Page height with px, in, cm, mm, or pt units.
- page
Width string - Page width with px, in, cm, mm, or pt units.
- print
Background boolean - Print page backgrounds. Omission lets the API choose.
- scale number
- PDF scale from 0.1 to 2.
- margins
Image
Url Pdf Options Margins - PDF margins. Supply all four sides with units.
- page_
height str - Page height with px, in, cm, mm, or pt units.
- page_
width str - Page width with px, in, cm, mm, or pt units.
- print_
background bool - Print page backgrounds. Omission lets the API choose.
- scale float
- PDF scale from 0.1 to 2.
- margins Property Map
- PDF margins. Supply all four sides with units.
- page
Height String - Page height with px, in, cm, mm, or pt units.
- page
Width String - Page width with px, in, cm, mm, or pt units.
- print
Background Boolean - Print page backgrounds. Omission lets the API choose.
- scale Number
- PDF scale from 0.1 to 2.
ImageUrlPdfOptionsMargins, ImageUrlPdfOptionsMarginsArgs
ImageUrlRequestOverride, ImageUrlRequestOverrideArgs
- 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.
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
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