published on Tuesday, Sep 29, 2026 by htmlcsstoimage
HTML/CSS to Imagepublished on Tuesday, Sep 29, 2026 by htmlcsstoimage
Create OgConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OgConfig(name: string, args: OgConfigArgs, opts?: CustomResourceOptions);@overload
def OgConfig(resource_name: str,
args: OgConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OgConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
base_url: Optional[str] = None,
config_type: Optional[str] = None,
extract_values: Optional[bool] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
additional_header_origins: Optional[Sequence[str]] = None,
headers: Optional[Mapping[str, str]] = None,
default_options: Optional[OgConfigDefaultOptionsArgs] = None,
optimization_mode: Optional[str] = None,
refresh_interval_s: Optional[int] = None,
template_id: Optional[str] = None,
template_values_mappings: Optional[Sequence[OgConfigTemplateValuesMappingArgs]] = None,
template_version: Optional[str] = None)func NewOgConfig(ctx *Context, name string, args OgConfigArgs, opts ...ResourceOption) (*OgConfig, error)public OgConfig(string name, OgConfigArgs args, CustomResourceOptions? opts = null)
public OgConfig(String name, OgConfigArgs args)
public OgConfig(String name, OgConfigArgs args, CustomResourceOptions options)
type: html-css-to-image:OgConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "html-css-to-image_og_config" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args OgConfigArgs
- 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 OgConfigArgs
- 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 OgConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OgConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OgConfigArgs
- 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 ogConfigResource = new HtmlCssToImage.OgConfig("ogConfigResource", new()
{
Name = "string",
BaseUrl = "string",
ConfigType = "string",
ExtractValues = false,
Description = "string",
Disabled = false,
AdditionalHeaderOrigins = new[]
{
"string",
},
Headers =
{
{ "string", "string" },
},
DefaultOptions = new HtmlCssToImage.Inputs.OgConfigDefaultOptionsArgs
{
AdditionalHeaderOrigins = new[]
{
"string",
},
BlockConsentBanners = false,
ColorScheme = "string",
Css = "string",
DeviceScale = 0.0,
DisableTwemoji = false,
Headers =
{
{ "string", "string" },
},
IdentifyAsHcti = false,
IncludeHeadersOnSubrequests = false,
MaxWaitMs = 0,
MediaType = "string",
MsDelay = 0,
ProxyId = "string",
RenderWhenReady = false,
RequestOverrides = new[]
{
new HtmlCssToImage.Inputs.OgConfigDefaultOptionsRequestOverrideArgs
{
Action = "string",
ResourceTypes = new[]
{
HtmlCssToImage.RequestOverrideResourceType.Beacon,
},
Url = "string",
},
},
Selector = "string",
StorageDestinationId = "string",
Timezone = "string",
TransparentBackground = false,
ViewportHeight = 0,
ViewportLandscape = false,
ViewportMobile = false,
ViewportTouch = false,
ViewportWidth = 0,
},
OptimizationMode = "string",
RefreshIntervalS = 0,
TemplateId = "string",
TemplateValuesMappings = new[]
{
new HtmlCssToImage.Inputs.OgConfigTemplateValuesMappingArgs
{
TemplateKey = "string",
Fallback = "string",
MetaKey = "string",
},
},
TemplateVersion = "string",
});
example, err := htmlcsstoimage.NewOgConfig(ctx, "ogConfigResource", &htmlcsstoimage.OgConfigArgs{
Name: pulumi.String("string"),
BaseUrl: pulumi.String("string"),
ConfigType: pulumi.String("string"),
ExtractValues: pulumi.Bool(false),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
AdditionalHeaderOrigins: pulumi.StringArray{
pulumi.String("string"),
},
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
DefaultOptions: &.OgConfigDefaultOptionsArgs{
AdditionalHeaderOrigins: pulumi.StringArray{
pulumi.String("string"),
},
BlockConsentBanners: pulumi.Bool(false),
ColorScheme: pulumi.String("string"),
Css: pulumi.String("string"),
DeviceScale: pulumi.Float64(0),
DisableTwemoji: pulumi.Bool(false),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
IdentifyAsHcti: pulumi.Bool(false),
IncludeHeadersOnSubrequests: pulumi.Bool(false),
MaxWaitMs: pulumi.Int(0),
MediaType: pulumi.String("string"),
MsDelay: pulumi.Int(0),
ProxyId: pulumi.String("string"),
RenderWhenReady: pulumi.Bool(false),
RequestOverrides: .OgConfigDefaultOptionsRequestOverrideArray{
&.OgConfigDefaultOptionsRequestOverrideArgs{
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),
ViewportHeight: pulumi.Int(0),
ViewportLandscape: pulumi.Bool(false),
ViewportMobile: pulumi.Bool(false),
ViewportTouch: pulumi.Bool(false),
ViewportWidth: pulumi.Int(0),
},
OptimizationMode: pulumi.String("string"),
RefreshIntervalS: pulumi.Int(0),
TemplateId: pulumi.String("string"),
TemplateValuesMappings: .OgConfigTemplateValuesMappingArray{
&.OgConfigTemplateValuesMappingArgs{
TemplateKey: pulumi.String("string"),
Fallback: pulumi.String("string"),
MetaKey: pulumi.String("string"),
},
},
TemplateVersion: pulumi.String("string"),
})
resource "html-css-to-image_og_config" "ogConfigResource" {
lifecycle {
create_before_destroy = true
}
name = "string"
base_url = "string"
config_type = "string"
extract_values = false
description = "string"
disabled = false
additional_header_origins = ["string"]
headers = {
"string" = "string"
}
default_options = {
additional_header_origins = ["string"]
block_consent_banners = false
color_scheme = "string"
css = "string"
device_scale = 0
disable_twemoji = false
headers = {
"string" = "string"
}
identify_as_hcti = false
include_headers_on_subrequests = false
max_wait_ms = 0
media_type = "string"
ms_delay = 0
proxy_id = "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
viewport_height = 0
viewport_landscape = false
viewport_mobile = false
viewport_touch = false
viewport_width = 0
}
optimization_mode = "string"
refresh_interval_s = 0
template_id = "string"
template_values_mappings {
template_key = "string"
fallback = "string"
meta_key = "string"
}
template_version = "string"
}
var ogConfigResource = new OgConfig("ogConfigResource", OgConfigArgs.builder()
.name("string")
.baseUrl("string")
.configType("string")
.extractValues(false)
.description("string")
.disabled(false)
.additionalHeaderOrigins("string")
.headers(Map.of("string", "string"))
.defaultOptions(OgConfigDefaultOptionsArgs.builder()
.additionalHeaderOrigins("string")
.blockConsentBanners(false)
.colorScheme("string")
.css("string")
.deviceScale(0.0)
.disableTwemoji(false)
.headers(Map.of("string", "string"))
.identifyAsHcti(false)
.includeHeadersOnSubrequests(false)
.maxWaitMs(0)
.mediaType("string")
.msDelay(0)
.proxyId("string")
.renderWhenReady(false)
.requestOverrides(OgConfigDefaultOptionsRequestOverrideArgs.builder()
.action("string")
.resourceTypes("beacon")
.url("string")
.build())
.selector("string")
.storageDestinationId("string")
.timezone("string")
.transparentBackground(false)
.viewportHeight(0)
.viewportLandscape(false)
.viewportMobile(false)
.viewportTouch(false)
.viewportWidth(0)
.build())
.optimizationMode("string")
.refreshIntervalS(0)
.templateId("string")
.templateValuesMappings(OgConfigTemplateValuesMappingArgs.builder()
.templateKey("string")
.fallback("string")
.metaKey("string")
.build())
.templateVersion("string")
.build());
og_config_resource = html_css_to_image.OgConfig("ogConfigResource",
name="string",
base_url="string",
config_type="string",
extract_values=False,
description="string",
disabled=False,
additional_header_origins=["string"],
headers={
"string": "string",
},
default_options={
"additional_header_origins": ["string"],
"block_consent_banners": False,
"color_scheme": "string",
"css": "string",
"device_scale": float(0),
"disable_twemoji": False,
"headers": {
"string": "string",
},
"identify_as_hcti": False,
"include_headers_on_subrequests": False,
"max_wait_ms": 0,
"media_type": "string",
"ms_delay": 0,
"proxy_id": "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,
"viewport_height": 0,
"viewport_landscape": False,
"viewport_mobile": False,
"viewport_touch": False,
"viewport_width": 0,
},
optimization_mode="string",
refresh_interval_s=0,
template_id="string",
template_values_mappings=[{
"template_key": "string",
"fallback": "string",
"meta_key": "string",
}],
template_version="string")
const ogConfigResource = new html_css_to_image.OgConfig("ogConfigResource", {
name: "string",
baseUrl: "string",
configType: "string",
extractValues: false,
description: "string",
disabled: false,
additionalHeaderOrigins: ["string"],
headers: {
string: "string",
},
defaultOptions: {
additionalHeaderOrigins: ["string"],
blockConsentBanners: false,
colorScheme: "string",
css: "string",
deviceScale: 0,
disableTwemoji: false,
headers: {
string: "string",
},
identifyAsHcti: false,
includeHeadersOnSubrequests: false,
maxWaitMs: 0,
mediaType: "string",
msDelay: 0,
proxyId: "string",
renderWhenReady: false,
requestOverrides: [{
action: "string",
resourceTypes: [html_css_to_image.RequestOverrideResourceType.Beacon],
url: "string",
}],
selector: "string",
storageDestinationId: "string",
timezone: "string",
transparentBackground: false,
viewportHeight: 0,
viewportLandscape: false,
viewportMobile: false,
viewportTouch: false,
viewportWidth: 0,
},
optimizationMode: "string",
refreshIntervalS: 0,
templateId: "string",
templateValuesMappings: [{
templateKey: "string",
fallback: "string",
metaKey: "string",
}],
templateVersion: "string",
});
type: html-css-to-image:OgConfig
properties:
additionalHeaderOrigins:
- string
baseUrl: string
configType: string
defaultOptions:
additionalHeaderOrigins:
- string
blockConsentBanners: false
colorScheme: string
css: string
deviceScale: 0
disableTwemoji: false
headers:
string: string
identifyAsHcti: false
includeHeadersOnSubrequests: false
maxWaitMs: 0
mediaType: string
msDelay: 0
proxyId: string
renderWhenReady: false
requestOverrides:
- action: string
resourceTypes:
- beacon
url: string
selector: string
storageDestinationId: string
timezone: string
transparentBackground: false
viewportHeight: 0
viewportLandscape: false
viewportMobile: false
viewportTouch: false
viewportWidth: 0
description: string
disabled: false
extractValues: false
headers:
string: string
name: string
optimizationMode: string
refreshIntervalS: 0
templateId: string
templateValuesMappings:
- fallback: string
metaKey: string
templateKey: string
templateVersion: string
OgConfig 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 OgConfig resource accepts the following input properties:
- Base
Url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- Config
Type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- Name string
- Display name, 1–255 characters after trimming.
- Additional
Header List<string>Origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- Default
Options Pulumi.Html Css To Image. Inputs. Og Config Default Options - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- Description string
- Optional description, up to 1023 characters. Omission clears it.
- Disabled bool
- Disable serving images. Defaults to false.
- Extract
Values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- Headers Dictionary<string, string>
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- Optimization
Mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- Refresh
Interval intS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- Template
Id string - Required for templated configurations. Template ID including its t- prefix.
- Template
Values List<Pulumi.Mappings Html Css To Image. Inputs. Og Config Template Values Mapping> - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- Template
Version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- Base
Url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- Config
Type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- Name string
- Display name, 1–255 characters after trimming.
- Additional
Header []stringOrigins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- Default
Options OgConfig Default Options Args - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- Description string
- Optional description, up to 1023 characters. Omission clears it.
- Disabled bool
- Disable serving images. Defaults to false.
- Extract
Values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- Headers map[string]string
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- Optimization
Mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- Refresh
Interval intS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- Template
Id string - Required for templated configurations. Template ID including its t- prefix.
- Template
Values []OgMappings Config Template Values Mapping Args - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- Template
Version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- base_
url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config_
type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- name string
- Display name, 1–255 characters after trimming.
- additional_
header_ list(string)origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- default_
options object - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description string
- Optional description, up to 1023 characters. Omission clears it.
- disabled bool
- Disable serving images. Defaults to false.
- extract_
values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers map(string)
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- optimization_
mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh_
interval_ numbers - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template_
id string - Required for templated configurations. Template ID including its t- prefix.
- template_
values_ list(object)mappings - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template_
version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- base
Url String - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config
Type String - Rendering source: html_css or templated. Changing type updates this configuration in place.
- name String
- Display name, 1–255 characters after trimming.
- additional
Header List<String>Origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- default
Options OgConfig Default Options - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description String
- Optional description, up to 1023 characters. Omission clears it.
- disabled Boolean
- Disable serving images. Defaults to false.
- extract
Values Boolean - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers Map<String,String>
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- optimization
Mode String - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh
Interval IntegerS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template
Id String - Required for templated configurations. Template ID including its t- prefix.
- template
Values List<OgMappings Config Template Values Mapping> - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template
Version String - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- base
Url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config
Type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- name string
- Display name, 1–255 characters after trimming.
- additional
Header string[]Origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- default
Options OgConfig Default Options - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description string
- Optional description, up to 1023 characters. Omission clears it.
- disabled boolean
- Disable serving images. Defaults to false.
- extract
Values boolean - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers {[key: string]: string}
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- optimization
Mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh
Interval numberS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template
Id string - Required for templated configurations. Template ID including its t- prefix.
- template
Values OgMappings Config Template Values Mapping[] - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template
Version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- base_
url str - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config_
type str - Rendering source: html_css or templated. Changing type updates this configuration in place.
- name str
- Display name, 1–255 characters after trimming.
- additional_
header_ Sequence[str]origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- default_
options OgConfig Default Options Args - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description str
- Optional description, up to 1023 characters. Omission clears it.
- disabled bool
- Disable serving images. Defaults to false.
- extract_
values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers Mapping[str, str]
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- optimization_
mode str - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh_
interval_ ints - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template_
id str - Required for templated configurations. Template ID including its t- prefix.
- template_
values_ Sequence[Ogmappings Config Template Values Mapping Args] - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template_
version str - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- base
Url String - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config
Type String - Rendering source: html_css or templated. Changing type updates this configuration in place.
- name String
- Display name, 1–255 characters after trimming.
- additional
Header List<String>Origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- default
Options Property Map - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description String
- Optional description, up to 1023 characters. Omission clears it.
- disabled Boolean
- Disable serving images. Defaults to false.
- extract
Values Boolean - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers Map<String>
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- optimization
Mode String - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh
Interval NumberS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template
Id String - Required for templated configurations. Template ID including its t- prefix.
- template
Values List<Property Map>Mappings - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template
Version String - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
Outputs
All input properties are implicitly available as output properties. Additionally, the OgConfig resource produces the following output properties:
- Created
At string - Creation timestamp.
- Domain
Id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- Effective
Optimization stringMode - Optimization mode returned by the API.
- Effective
Refresh intInterval S - Refresh interval returned by the API, in seconds.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - Last update timestamp.
- Created
At string - Creation timestamp.
- Domain
Id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- Effective
Optimization stringMode - Optimization mode returned by the API.
- Effective
Refresh intInterval S - Refresh interval returned by the API, in seconds.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - Last update timestamp.
- created_
at string - Creation timestamp.
- domain_
id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective_
optimization_ stringmode - Optimization mode returned by the API.
- effective_
refresh_ numberinterval_ s - Refresh interval returned by the API, in seconds.
- id string
- The provider-assigned unique ID for this managed resource.
- updated_
at string - Last update timestamp.
- created
At String - Creation timestamp.
- domain
Id String - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective
Optimization StringMode - Optimization mode returned by the API.
- effective
Refresh IntegerInterval S - Refresh interval returned by the API, in seconds.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - Last update timestamp.
- created
At string - Creation timestamp.
- domain
Id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective
Optimization stringMode - Optimization mode returned by the API.
- effective
Refresh numberInterval S - Refresh interval returned by the API, in seconds.
- id string
- The provider-assigned unique ID for this managed resource.
- updated
At string - Last update timestamp.
- created_
at str - Creation timestamp.
- domain_
id str - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective_
optimization_ strmode - Optimization mode returned by the API.
- effective_
refresh_ intinterval_ s - Refresh interval returned by the API, in seconds.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - Last update timestamp.
- created
At String - Creation timestamp.
- domain
Id String - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective
Optimization StringMode - Optimization mode returned by the API.
- effective
Refresh NumberInterval S - Refresh interval returned by the API, in seconds.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - Last update timestamp.
Look up Existing OgConfig Resource
Get an existing OgConfig 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?: OgConfigState, opts?: CustomResourceOptions): OgConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_header_origins: Optional[Sequence[str]] = None,
base_url: Optional[str] = None,
config_type: Optional[str] = None,
created_at: Optional[str] = None,
default_options: Optional[OgConfigDefaultOptionsArgs] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
domain_id: Optional[str] = None,
effective_optimization_mode: Optional[str] = None,
effective_refresh_interval_s: Optional[int] = None,
extract_values: Optional[bool] = None,
headers: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
optimization_mode: Optional[str] = None,
refresh_interval_s: Optional[int] = None,
template_id: Optional[str] = None,
template_values_mappings: Optional[Sequence[OgConfigTemplateValuesMappingArgs]] = None,
template_version: Optional[str] = None,
updated_at: Optional[str] = None) -> OgConfigfunc GetOgConfig(ctx *Context, name string, id IDInput, state *OgConfigState, opts ...ResourceOption) (*OgConfig, error)public static OgConfig Get(string name, Input<string> id, OgConfigState? state, CustomResourceOptions? opts = null)public static OgConfig get(String name, Output<String> id, OgConfigState state, CustomResourceOptions options)resources: _: type: html-css-to-image:OgConfig get: id: ${id}import {
to = html-css-to-image_og_config.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 - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- Base
Url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- Config
Type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- Created
At string - Creation timestamp.
- Default
Options Pulumi.Html Css To Image. Inputs. Og Config Default Options - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- Description string
- Optional description, up to 1023 characters. Omission clears it.
- Disabled bool
- Disable serving images. Defaults to false.
- Domain
Id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- Effective
Optimization stringMode - Optimization mode returned by the API.
- Effective
Refresh intInterval S - Refresh interval returned by the API, in seconds.
- Extract
Values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- Headers Dictionary<string, string>
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- Name string
- Display name, 1–255 characters after trimming.
- Optimization
Mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- Refresh
Interval intS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- Template
Id string - Required for templated configurations. Template ID including its t- prefix.
- Template
Values List<Pulumi.Mappings Html Css To Image. Inputs. Og Config Template Values Mapping> - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- Template
Version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- Updated
At string - Last update timestamp.
- Additional
Header []stringOrigins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- Base
Url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- Config
Type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- Created
At string - Creation timestamp.
- Default
Options OgConfig Default Options Args - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- Description string
- Optional description, up to 1023 characters. Omission clears it.
- Disabled bool
- Disable serving images. Defaults to false.
- Domain
Id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- Effective
Optimization stringMode - Optimization mode returned by the API.
- Effective
Refresh intInterval S - Refresh interval returned by the API, in seconds.
- Extract
Values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- Headers map[string]string
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- Name string
- Display name, 1–255 characters after trimming.
- Optimization
Mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- Refresh
Interval intS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- Template
Id string - Required for templated configurations. Template ID including its t- prefix.
- Template
Values []OgMappings Config Template Values Mapping Args - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- Template
Version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- Updated
At string - Last update timestamp.
- additional_
header_ list(string)origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- base_
url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config_
type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- created_
at string - Creation timestamp.
- default_
options object - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description string
- Optional description, up to 1023 characters. Omission clears it.
- disabled bool
- Disable serving images. Defaults to false.
- domain_
id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective_
optimization_ stringmode - Optimization mode returned by the API.
- effective_
refresh_ numberinterval_ s - Refresh interval returned by the API, in seconds.
- extract_
values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers map(string)
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- name string
- Display name, 1–255 characters after trimming.
- optimization_
mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh_
interval_ numbers - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template_
id string - Required for templated configurations. Template ID including its t- prefix.
- template_
values_ list(object)mappings - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template_
version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- updated_
at string - Last update timestamp.
- additional
Header List<String>Origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- base
Url String - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config
Type String - Rendering source: html_css or templated. Changing type updates this configuration in place.
- created
At String - Creation timestamp.
- default
Options OgConfig Default Options - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description String
- Optional description, up to 1023 characters. Omission clears it.
- disabled Boolean
- Disable serving images. Defaults to false.
- domain
Id String - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective
Optimization StringMode - Optimization mode returned by the API.
- effective
Refresh IntegerInterval S - Refresh interval returned by the API, in seconds.
- extract
Values Boolean - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers Map<String,String>
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- name String
- Display name, 1–255 characters after trimming.
- optimization
Mode String - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh
Interval IntegerS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template
Id String - Required for templated configurations. Template ID including its t- prefix.
- template
Values List<OgMappings Config Template Values Mapping> - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template
Version String - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- updated
At String - Last update timestamp.
- additional
Header string[]Origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- base
Url string - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config
Type string - Rendering source: html_css or templated. Changing type updates this configuration in place.
- created
At string - Creation timestamp.
- default
Options OgConfig Default Options - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description string
- Optional description, up to 1023 characters. Omission clears it.
- disabled boolean
- Disable serving images. Defaults to false.
- domain
Id string - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective
Optimization stringMode - Optimization mode returned by the API.
- effective
Refresh numberInterval S - Refresh interval returned by the API, in seconds.
- extract
Values boolean - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers {[key: string]: string}
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- name string
- Display name, 1–255 characters after trimming.
- optimization
Mode string - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh
Interval numberS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template
Id string - Required for templated configurations. Template ID including its t- prefix.
- template
Values OgMappings Config Template Values Mapping[] - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template
Version string - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- updated
At string - Last update timestamp.
- additional_
header_ Sequence[str]origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- base_
url str - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config_
type str - Rendering source: html_css or templated. Changing type updates this configuration in place.
- created_
at str - Creation timestamp.
- default_
options OgConfig Default Options Args - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description str
- Optional description, up to 1023 characters. Omission clears it.
- disabled bool
- Disable serving images. Defaults to false.
- domain_
id str - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective_
optimization_ strmode - Optimization mode returned by the API.
- effective_
refresh_ intinterval_ s - Refresh interval returned by the API, in seconds.
- extract_
values bool - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers Mapping[str, str]
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- name str
- Display name, 1–255 characters after trimming.
- optimization_
mode str - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh_
interval_ ints - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template_
id str - Required for templated configurations. Template ID including its t- prefix.
- template_
values_ Sequence[Ogmappings Config Template Values Mapping Args] - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template_
version str - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- updated_
at str - Last update timestamp.
- additional
Header List<String>Origins - Templated only. Up to 20 additional exact HTTP(S) origins allowed to receive headers, each up to 512 UTF-8 bytes. Omission clears them.
- base
Url String - HTTPS origin of the source website, up to 2048 characters, without a path, credentials, query, or fragment.
- config
Type String - Rendering source: html_css or templated. Changing type updates this configuration in place.
- created
At String - Creation timestamp.
- default
Options Property Map - HTML/CSS only. Default page rendering options. Unspecified fields are sent as null; the API owns render defaults.
- description String
- Optional description, up to 1023 characters. Omission clears it.
- disabled Boolean
- Disable serving images. Defaults to false.
- domain
Id String - Serving identifier used in OG image URLs. Distinct from the management ID.
- effective
Optimization StringMode - Optimization mode returned by the API.
- effective
Refresh NumberInterval S - Refresh interval returned by the API, in seconds.
- extract
Values Boolean - HTML/CSS only. Extract image options from page metadata, overriding default_options. Omission uses false.
- headers Map<String>
- Templated only. HTTP extraction headers, up to 20. Names: 512 ASCII characters; values: 8192 UTF-8 bytes. Omission clears them.
- name String
- Display name, 1–255 characters after trimming.
- optimization
Mode String - no_optimization keeps dimensions; post_process adapts after rendering; set_viewport renders at social-platform viewport sizes. Omission lets the API choose its default (currently post_process).
- refresh
Interval NumberS - Seconds before cached images may refresh: 1800–31536000, subject to the plan minimum. Omission lets the API choose its default (currently 86400).
- template
Id String - Required for templated configurations. Template ID including its t- prefix.
- template
Values List<Property Map>Mappings - Templated only. Up to 32 ordered mappings from page metadata to distinct template fields.
- template
Version String - Templated only. Positive int64 version. Omission follows the latest version at serving time. Represented as a decimal string in Pulumi to preserve int64 precision.
- updated
At String - Last update timestamp.
Supporting Types
OgConfigDefaultOptions, OgConfigDefaultOptionsArgs
- 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- Color
Scheme string - Sets Chrome's preferred color scheme. Valid values: light or dark.
- Css string
- CSS injected into the loaded page to override its styles.
- 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 captured URL page. Omitted or true leaves the page's emoji handling unchanged.
- 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.
- 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.
- 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 - Sets the CSS media type used while rendering the page. Valid values: print or screen.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Proxy
Id string - Configured proxy ID. Must refer to an enabled proxy.
- 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. Og Config Default Options 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 - Configured storage destination ID. Must be enabled and allow HCTI storage.
- 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.
- 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- Color
Scheme string - Sets Chrome's preferred color scheme. Valid values: light or dark.
- Css string
- CSS injected into the loaded page to override its styles.
- 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 captured URL page. Omitted or true leaves the page's emoji handling unchanged.
- 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.
- 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.
- 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 - Sets the CSS media type used while rendering the page. Valid values: print or screen.
- Ms
Delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- Proxy
Id string - Configured proxy ID. Must refer to an enabled proxy.
- 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 []OgConfig Default Options 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 - Configured storage destination ID. Must be enabled and allow HCTI storage.
- 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.
- 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- color_
scheme string - Sets Chrome's preferred color scheme. Valid values: light or dark.
- css string
- CSS injected into the loaded page to override its styles.
- 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 captured URL page. Omitted or true leaves the page's emoji handling unchanged.
- 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.
- 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.
- 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 - Sets the CSS media type used while rendering the page. Valid values: print or screen.
- ms_
delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- proxy_
id string - Configured proxy ID. Must refer to an enabled proxy.
- 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 - Configured storage destination ID. Must be enabled and allow HCTI storage.
- 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.
- 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.
- Boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme String - Sets Chrome's preferred color scheme. Valid values: light or dark.
- css String
- CSS injected into the loaded page to override its styles.
- 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 captured URL page. Omitted or true leaves the page's emoji handling unchanged.
- 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.
- 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.
- 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 - Sets the CSS media type used while rendering the page. Valid values: print or screen.
- ms
Delay Integer - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- proxy
Id String - Configured proxy ID. Must refer to an enabled proxy.
- 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<OgConfig Default Options 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 - Configured storage destination ID. Must be enabled and allow HCTI storage.
- 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.
- 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.
- boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme string - Sets Chrome's preferred color scheme. Valid values: light or dark.
- css string
- CSS injected into the loaded page to override its styles.
- 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 captured URL page. Omitted or true leaves the page's emoji handling unchanged.
- 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.
- 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.
- 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 - Sets the CSS media type used while rendering the page. Valid values: print or screen.
- ms
Delay number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- proxy
Id string - Configured proxy ID. Must refer to an enabled proxy.
- 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 OgConfig Default Options 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 - Configured storage destination ID. Must be enabled and allow HCTI storage.
- 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.
- 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.
- bool
- Attempt to block cookie/consent banners from displaying.
- color_
scheme str - Sets Chrome's preferred color scheme. Valid values: light or dark.
- css str
- CSS injected into the loaded page to override its styles.
- 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 captured URL page. Omitted or true leaves the page's emoji handling unchanged.
- 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.
- 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.
- 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 - Sets the CSS media type used while rendering the page. Valid values: print or screen.
- ms_
delay int - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- proxy_
id str - Configured proxy ID. Must refer to an enabled proxy.
- 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[OgConfig Default Options 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 str
- A CSS selector for an element in the HTML. We’ll crop the image to this specific element.
- storage_
destination_ strid - Configured storage destination ID. Must be enabled and allow HCTI storage.
- 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.
- 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.
- Boolean
- Attempt to block cookie/consent banners from displaying.
- color
Scheme String - Sets Chrome's preferred color scheme. Valid values: light or dark.
- css String
- CSS injected into the loaded page to override its styles.
- 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 captured URL page. Omitted or true leaves the page's emoji handling unchanged.
- 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.
- 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.
- 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 - Sets the CSS media type used while rendering the page. Valid values: print or screen.
- ms
Delay Number - Adds extra time in milliseconds before taking the screenshot so JavaScript can execute. Minimum: 0. Maximum: 10000.
- proxy
Id String - Configured proxy ID. Must refer to an enabled proxy.
- 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 - Configured storage destination ID. Must be enabled and allow HCTI storage.
- 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.
OgConfigDefaultOptionsRequestOverride, OgConfigDefaultOptionsRequestOverrideArgs
- 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.
OgConfigTemplateValuesMapping, OgConfigTemplateValuesMappingArgs
- Template
Key string - Destination template field path, up to 128 characters. Paths must not overlap.
- Fallback string
- Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
- Meta
Key string - Source meta tag name, up to 136 characters. Supply exactly one of metaKey or fallback.
- Template
Key string - Destination template field path, up to 128 characters. Paths must not overlap.
- Fallback string
- Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
- Meta
Key string - Source meta tag name, up to 136 characters. Supply exactly one of metaKey or fallback.
- template_
key string - Destination template field path, up to 128 characters. Paths must not overlap.
- fallback string
- Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
- meta_
key string - Source meta tag name, up to 136 characters. Supply exactly one of metaKey or fallback.
- template
Key String - Destination template field path, up to 128 characters. Paths must not overlap.
- fallback String
- Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
- meta
Key String - Source meta tag name, up to 136 characters. Supply exactly one of metaKey or fallback.
- template
Key string - Destination template field path, up to 128 characters. Paths must not overlap.
- fallback string
- Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
- meta
Key string - Source meta tag name, up to 136 characters. Supply exactly one of metaKey or fallback.
- template_
key str - Destination template field path, up to 128 characters. Paths must not overlap.
- fallback str
- Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
- meta_
key str - Source meta tag name, up to 136 characters. Supply exactly one of metaKey or fallback.
- template
Key String - Destination template field path, up to 128 characters. Paths must not overlap.
- fallback String
- Metadata fallback: titles or descriptions. This selects page metadata, not a literal value.
- meta
Key String - Source meta tag name, up to 136 characters. Supply exactly one of metaKey or fallback.
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