Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. HTML/CSS to Image
  4. API Docs
  5. Proxy
Viewing docs for HTML/CSS to Image v0.2.0
published on Tuesday, Sep 29, 2026 by htmlcsstoimage
Schema (JSON)
htmlcsstoimage/pulumi-html-css-to-image

html-css-to-image.Proxy

html-css-to-image logo HTML/CSS to Image
Viewing docs for HTML/CSS to Image v0.2.0
published on Tuesday, Sep 29, 2026 by htmlcsstoimage
Schema (JSON)
htmlcsstoimage/pulumi-html-css-to-image

    Create Proxy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Proxy(name: string, args: ProxyArgs, opts?: CustomResourceOptions);
    @overload
def Proxy(resource_name: str,
          args: ProxyArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Proxy(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          name: Optional[str] = None,
          url: Optional[str] = None,
          authentication: Optional[ProxyAuthenticationArgs] = None,
          bypass_hosts: Optional[Sequence[str]] = None,
          disabled: Optional[bool] = None,
          port: Optional[int] = None)
    func NewProxy(ctx *Context, name string, args ProxyArgs, opts ...ResourceOption) (*Proxy, error)
    public Proxy(string name, ProxyArgs args, CustomResourceOptions? opts = null)
    public Proxy(String name, ProxyArgs args)
public Proxy(String name, ProxyArgs args, CustomResourceOptions options)

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


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

    Parameters

    name string
    The unique name of the resource.
    args ProxyArgs
    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 ProxyArgs
    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 ProxyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProxyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProxyArgs
    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 proxyResource = new HtmlCssToImage.Proxy("proxyResource", new()
{
    Name = "string",
    Url = "string",
    Authentication = new HtmlCssToImage.Inputs.ProxyAuthenticationArgs
    {
        Username = "string",
        Password = "string",
    },
    BypassHosts = new[]
    {
        "string",
    },
    Disabled = false,
    Port = 0,
});

    example, err := htmlcsstoimage.NewProxy(ctx, "proxyResource", &htmlcsstoimage.ProxyArgs{
Name: pulumi.String("string"),
Url: pulumi.String("string"),
Authentication: &.ProxyAuthenticationArgs{
Username: pulumi.String("string"),
Password: pulumi.String("string"),
},
BypassHosts: pulumi.StringArray{
pulumi.String("string"),
},
Disabled: pulumi.Bool(false),
Port: pulumi.Int(0),
})

    resource "html-css-to-image_proxy" "proxyResource" {
  lifecycle {
    create_before_destroy = true
  }
  name = "string"
  url  = "string"
  authentication = {
    username = "string"
    password = "string"
  }
  bypass_hosts = ["string"]
  disabled     = false
  port         = 0
}

    var proxyResource = new Proxy("proxyResource", ProxyArgs.builder()
    .name("string")
    .url("string")
    .authentication(ProxyAuthenticationArgs.builder()
        .username("string")
        .password("string")
        .build())
    .bypassHosts("string")
    .disabled(false)
    .port(0)
    .build());

    proxy_resource = html_css_to_image.Proxy("proxyResource",
    name="string",
    url="string",
    authentication={
        "username": "string",
        "password": "string",
    },
    bypass_hosts=["string"],
    disabled=False,
    port=0)

    const proxyResource = new html_css_to_image.Proxy("proxyResource", {
    name: "string",
    url: "string",
    authentication: {
        username: "string",
        password: "string",
    },
    bypassHosts: ["string"],
    disabled: false,
    port: 0,
});

    type: html-css-to-image:Proxy
properties:
    authentication:
        password: string
        username: string
    bypassHosts:
        - string
    disabled: false
    name: string
    port: 0
    url: string

    Proxy 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 Proxy resource accepts the following input properties:

    Name string
    Display name, 3–500 characters after trimming.
    Url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    Authentication Pulumi.HtmlCssToImage.Inputs.ProxyAuthentication
    Proxy credentials. Omit the whole object to remove authentication.
    BypassHosts List<string>
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    Disabled bool
    Disable the proxy. Defaults to false.
    Port int
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    Name string
    Display name, 3–500 characters after trimming.
    Url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    Authentication ProxyAuthenticationArgs
    Proxy credentials. Omit the whole object to remove authentication.
    BypassHosts []string
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    Disabled bool
    Disable the proxy. Defaults to false.
    Port int
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    name string
    Display name, 3–500 characters after trimming.
    url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication object
    Proxy credentials. Omit the whole object to remove authentication.
    bypass_hosts list(string)
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    disabled bool
    Disable the proxy. Defaults to false.
    port number
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    name String
    Display name, 3–500 characters after trimming.
    url String
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication ProxyAuthentication
    Proxy credentials. Omit the whole object to remove authentication.
    bypassHosts List<String>
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    disabled Boolean
    Disable the proxy. Defaults to false.
    port Integer
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    name string
    Display name, 3–500 characters after trimming.
    url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication ProxyAuthentication
    Proxy credentials. Omit the whole object to remove authentication.
    bypassHosts string[]
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    disabled boolean
    Disable the proxy. Defaults to false.
    port number
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    name str
    Display name, 3–500 characters after trimming.
    url str
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication ProxyAuthenticationArgs
    Proxy credentials. Omit the whole object to remove authentication.
    bypass_hosts Sequence[str]
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    disabled bool
    Disable the proxy. Defaults to false.
    port int
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    name String
    Display name, 3–500 characters after trimming.
    url String
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication Property Map
    Proxy credentials. Omit the whole object to remove authentication.
    bypassHosts List<String>
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    disabled Boolean
    Disable the proxy. Defaults to false.
    port Number
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.

    Outputs

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

    CreatedAt string
    Creation timestamp.
    EffectivePort int
    Port returned by the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update timestamp.
    CreatedAt string
    Creation timestamp.
    EffectivePort int
    Port returned by the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update timestamp.
    created_at string
    Creation timestamp.
    effective_port number
    Port returned by the API.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at string
    Last update timestamp.
    createdAt String
    Creation timestamp.
    effectivePort Integer
    Port returned by the API.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update timestamp.
    createdAt string
    Creation timestamp.
    effectivePort number
    Port returned by the API.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    Last update timestamp.
    created_at str
    Creation timestamp.
    effective_port int
    Port returned by the API.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    Last update timestamp.
    createdAt String
    Creation timestamp.
    effectivePort Number
    Port returned by the API.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update timestamp.

    Look up Existing Proxy Resource

    Get an existing Proxy 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?: ProxyState, opts?: CustomResourceOptions): Proxy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[ProxyAuthenticationArgs] = None,
        bypass_hosts: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        disabled: Optional[bool] = None,
        effective_port: Optional[int] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        updated_at: Optional[str] = None,
        url: Optional[str] = None) -> Proxy
    func GetProxy(ctx *Context, name string, id IDInput, state *ProxyState, opts ...ResourceOption) (*Proxy, error)
    public static Proxy Get(string name, Input<string> id, ProxyState? state, CustomResourceOptions? opts = null)
    public static Proxy get(String name, Output<String> id, ProxyState state, CustomResourceOptions options)
    resources:  _:    type: html-css-to-image:Proxy    get:      id: ${id}
    import {
  to = html-css-to-image_proxy.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Authentication Pulumi.HtmlCssToImage.Inputs.ProxyAuthentication
    Proxy credentials. Omit the whole object to remove authentication.
    BypassHosts List<string>
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    CreatedAt string
    Creation timestamp.
    Disabled bool
    Disable the proxy. Defaults to false.
    EffectivePort int
    Port returned by the API.
    Name string
    Display name, 3–500 characters after trimming.
    Port int
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    UpdatedAt string
    Last update timestamp.
    Url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    Authentication ProxyAuthenticationArgs
    Proxy credentials. Omit the whole object to remove authentication.
    BypassHosts []string
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    CreatedAt string
    Creation timestamp.
    Disabled bool
    Disable the proxy. Defaults to false.
    EffectivePort int
    Port returned by the API.
    Name string
    Display name, 3–500 characters after trimming.
    Port int
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    UpdatedAt string
    Last update timestamp.
    Url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication object
    Proxy credentials. Omit the whole object to remove authentication.
    bypass_hosts list(string)
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    created_at string
    Creation timestamp.
    disabled bool
    Disable the proxy. Defaults to false.
    effective_port number
    Port returned by the API.
    name string
    Display name, 3–500 characters after trimming.
    port number
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    updated_at string
    Last update timestamp.
    url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication ProxyAuthentication
    Proxy credentials. Omit the whole object to remove authentication.
    bypassHosts List<String>
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    createdAt String
    Creation timestamp.
    disabled Boolean
    Disable the proxy. Defaults to false.
    effectivePort Integer
    Port returned by the API.
    name String
    Display name, 3–500 characters after trimming.
    port Integer
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    updatedAt String
    Last update timestamp.
    url String
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication ProxyAuthentication
    Proxy credentials. Omit the whole object to remove authentication.
    bypassHosts string[]
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    createdAt string
    Creation timestamp.
    disabled boolean
    Disable the proxy. Defaults to false.
    effectivePort number
    Port returned by the API.
    name string
    Display name, 3–500 characters after trimming.
    port number
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    updatedAt string
    Last update timestamp.
    url string
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication ProxyAuthenticationArgs
    Proxy credentials. Omit the whole object to remove authentication.
    bypass_hosts Sequence[str]
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    created_at str
    Creation timestamp.
    disabled bool
    Disable the proxy. Defaults to false.
    effective_port int
    Port returned by the API.
    name str
    Display name, 3–500 characters after trimming.
    port int
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    updated_at str
    Last update timestamp.
    url str
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.
    authentication Property Map
    Proxy credentials. Omit the whole object to remove authentication.
    bypassHosts List<String>
    Up to 100 hostnames or URLs to bypass. Host comparison ignores case, URL paths, duplicates, and surrounding whitespace. Omission clears the list.
    createdAt String
    Creation timestamp.
    disabled Boolean
    Disable the proxy. Defaults to false.
    effectivePort Number
    Port returned by the API.
    name String
    Display name, 3–500 characters after trimming.
    port Number
    Port from 1 to 65535. Omitted sends null; the API chooses the scheme default.
    updatedAt String
    Last update timestamp.
    url String
    HTTP(S) proxy origin without credentials, port, query, fragment, or a non-root path.

    Supporting Types

    ProxyAuthentication, ProxyAuthenticationArgs

    Username string
    Username, up to 512 characters. Empty is valid; whitespace is preserved.
    Password string
    Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
    Username string
    Username, up to 512 characters. Empty is valid; whitespace is preserved.
    Password string
    Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
    username string
    Username, up to 512 characters. Empty is valid; whitespace is preserved.
    password string
    Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
    username String
    Username, up to 512 characters. Empty is valid; whitespace is preserved.
    password String
    Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
    username string
    Username, up to 512 characters. Empty is valid; whitespace is preserved.
    password string
    Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
    username str
    Username, up to 512 characters. Empty is valid; whitespace is preserved.
    password str
    Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.
    username String
    Username, up to 512 characters. Empty is valid; whitespace is preserved.
    password String
    Password, up to 484 UTF-8 bytes. Empty is valid. Required for creation or a username change; omitted on update retains the password only when the existing username matches.

    Package Details

    Repository
    html-css-to-image htmlcsstoimage/pulumi-html-css-to-image
    License
    MIT
    Notes
    This Pulumi package is based on the html-css-to-image Terraform Provider.
    html-css-to-image logo HTML/CSS to Image
    Viewing docs for HTML/CSS to Image v0.2.0
    published on Tuesday, Sep 29, 2026 by htmlcsstoimage
    Schema (JSON)
    htmlcsstoimage/pulumi-html-css-to-image

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial