Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ZeroTrustAccessCustomPage
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.ZeroTrustAccessCustomPage

Explore with Pulumi AI

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

Provides a resource to customize the pages your end users will see when trying to reach applications behind Cloudflare Access.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const example = new cloudflare.ZeroTrustAccessCustomPage("example", {
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
    name: "example",
    type: "forbidden",
    customHtml: "<html><body><h1>Forbidden</h1></body></html>",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.ZeroTrustAccessCustomPage("example",
    zone_id="0da42c8d2132a9ddaf714f9e7c920711",
    name="example",
    type="forbidden",
    custom_html="<html><body><h1>Forbidden</h1></body></html>")
Copy
package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewZeroTrustAccessCustomPage(ctx, "example", &cloudflare.ZeroTrustAccessCustomPageArgs{
			ZoneId:     pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
			Name:       pulumi.String("example"),
			Type:       pulumi.String("forbidden"),
			CustomHtml: pulumi.String("<html><body><h1>Forbidden</h1></body></html>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = new Cloudflare.ZeroTrustAccessCustomPage("example", new()
    {
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
        Name = "example",
        Type = "forbidden",
        CustomHtml = "<html><body><h1>Forbidden</h1></body></html>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.ZeroTrustAccessCustomPage;
import com.pulumi.cloudflare.ZeroTrustAccessCustomPageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ZeroTrustAccessCustomPage("example", ZeroTrustAccessCustomPageArgs.builder()
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .name("example")
            .type("forbidden")
            .customHtml("<html><body><h1>Forbidden</h1></body></html>")
            .build());

    }
}
Copy
resources:
  example:
    type: cloudflare:ZeroTrustAccessCustomPage
    properties:
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711
      name: example
      type: forbidden
      customHtml: <html><body><h1>Forbidden</h1></body></html>
Copy

Create ZeroTrustAccessCustomPage Resource

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

Constructor syntax

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

@overload
def ZeroTrustAccessCustomPage(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              name: Optional[str] = None,
                              type: Optional[str] = None,
                              account_id: Optional[str] = None,
                              app_count: Optional[int] = None,
                              custom_html: Optional[str] = None,
                              zone_id: Optional[str] = None)
func NewZeroTrustAccessCustomPage(ctx *Context, name string, args ZeroTrustAccessCustomPageArgs, opts ...ResourceOption) (*ZeroTrustAccessCustomPage, error)
public ZeroTrustAccessCustomPage(string name, ZeroTrustAccessCustomPageArgs args, CustomResourceOptions? opts = null)
public ZeroTrustAccessCustomPage(String name, ZeroTrustAccessCustomPageArgs args)
public ZeroTrustAccessCustomPage(String name, ZeroTrustAccessCustomPageArgs args, CustomResourceOptions options)

type: cloudflare:ZeroTrustAccessCustomPage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ZeroTrustAccessCustomPageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ZeroTrustAccessCustomPageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ZeroTrustAccessCustomPageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ZeroTrustAccessCustomPageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ZeroTrustAccessCustomPageArgs
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 zeroTrustAccessCustomPageResource = new Cloudflare.ZeroTrustAccessCustomPage("zeroTrustAccessCustomPageResource", new()
{
    Name = "string",
    Type = "string",
    AccountId = "string",
    AppCount = 0,
    CustomHtml = "string",
    ZoneId = "string",
});
Copy
example, err := cloudflare.NewZeroTrustAccessCustomPage(ctx, "zeroTrustAccessCustomPageResource", &cloudflare.ZeroTrustAccessCustomPageArgs{
	Name:       pulumi.String("string"),
	Type:       pulumi.String("string"),
	AccountId:  pulumi.String("string"),
	AppCount:   pulumi.Int(0),
	CustomHtml: pulumi.String("string"),
	ZoneId:     pulumi.String("string"),
})
Copy
var zeroTrustAccessCustomPageResource = new ZeroTrustAccessCustomPage("zeroTrustAccessCustomPageResource", ZeroTrustAccessCustomPageArgs.builder()
    .name("string")
    .type("string")
    .accountId("string")
    .appCount(0)
    .customHtml("string")
    .zoneId("string")
    .build());
Copy
zero_trust_access_custom_page_resource = cloudflare.ZeroTrustAccessCustomPage("zeroTrustAccessCustomPageResource",
    name="string",
    type="string",
    account_id="string",
    app_count=0,
    custom_html="string",
    zone_id="string")
Copy
const zeroTrustAccessCustomPageResource = new cloudflare.ZeroTrustAccessCustomPage("zeroTrustAccessCustomPageResource", {
    name: "string",
    type: "string",
    accountId: "string",
    appCount: 0,
    customHtml: "string",
    zoneId: "string",
});
Copy
type: cloudflare:ZeroTrustAccessCustomPage
properties:
    accountId: string
    appCount: 0
    customHtml: string
    name: string
    type: string
    zoneId: string
Copy

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

Name This property is required. string
Friendly name of the Access Custom Page configuration.
Type This property is required. string
Type of Access custom page to create. Available values: identity_denied, forbidden.
AccountId Changes to this property will trigger replacement. string
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
AppCount int
Number of apps to display on the custom page.
CustomHtml string
Custom HTML to display on the custom page.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
Name This property is required. string
Friendly name of the Access Custom Page configuration.
Type This property is required. string
Type of Access custom page to create. Available values: identity_denied, forbidden.
AccountId Changes to this property will trigger replacement. string
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
AppCount int
Number of apps to display on the custom page.
CustomHtml string
Custom HTML to display on the custom page.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
name This property is required. String
Friendly name of the Access Custom Page configuration.
type This property is required. String
Type of Access custom page to create. Available values: identity_denied, forbidden.
accountId Changes to this property will trigger replacement. String
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
appCount Integer
Number of apps to display on the custom page.
customHtml String
Custom HTML to display on the custom page.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
name This property is required. string
Friendly name of the Access Custom Page configuration.
type This property is required. string
Type of Access custom page to create. Available values: identity_denied, forbidden.
accountId Changes to this property will trigger replacement. string
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
appCount number
Number of apps to display on the custom page.
customHtml string
Custom HTML to display on the custom page.
zoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
name This property is required. str
Friendly name of the Access Custom Page configuration.
type This property is required. str
Type of Access custom page to create. Available values: identity_denied, forbidden.
account_id Changes to this property will trigger replacement. str
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
app_count int
Number of apps to display on the custom page.
custom_html str
Custom HTML to display on the custom page.
zone_id Changes to this property will trigger replacement. str
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
name This property is required. String
Friendly name of the Access Custom Page configuration.
type This property is required. String
Type of Access custom page to create. Available values: identity_denied, forbidden.
accountId Changes to this property will trigger replacement. String
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
appCount Number
Number of apps to display on the custom page.
customHtml String
Custom HTML to display on the custom page.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ZeroTrustAccessCustomPage Resource

Get an existing ZeroTrustAccessCustomPage 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?: ZeroTrustAccessCustomPageState, opts?: CustomResourceOptions): ZeroTrustAccessCustomPage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        app_count: Optional[int] = None,
        custom_html: Optional[str] = None,
        name: Optional[str] = None,
        type: Optional[str] = None,
        zone_id: Optional[str] = None) -> ZeroTrustAccessCustomPage
func GetZeroTrustAccessCustomPage(ctx *Context, name string, id IDInput, state *ZeroTrustAccessCustomPageState, opts ...ResourceOption) (*ZeroTrustAccessCustomPage, error)
public static ZeroTrustAccessCustomPage Get(string name, Input<string> id, ZeroTrustAccessCustomPageState? state, CustomResourceOptions? opts = null)
public static ZeroTrustAccessCustomPage get(String name, Output<String> id, ZeroTrustAccessCustomPageState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:ZeroTrustAccessCustomPage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccountId Changes to this property will trigger replacement. string
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
AppCount int
Number of apps to display on the custom page.
CustomHtml string
Custom HTML to display on the custom page.
Name string
Friendly name of the Access Custom Page configuration.
Type string
Type of Access custom page to create. Available values: identity_denied, forbidden.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
AccountId Changes to this property will trigger replacement. string
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
AppCount int
Number of apps to display on the custom page.
CustomHtml string
Custom HTML to display on the custom page.
Name string
Friendly name of the Access Custom Page configuration.
Type string
Type of Access custom page to create. Available values: identity_denied, forbidden.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
accountId Changes to this property will trigger replacement. String
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
appCount Integer
Number of apps to display on the custom page.
customHtml String
Custom HTML to display on the custom page.
name String
Friendly name of the Access Custom Page configuration.
type String
Type of Access custom page to create. Available values: identity_denied, forbidden.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
accountId Changes to this property will trigger replacement. string
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
appCount number
Number of apps to display on the custom page.
customHtml string
Custom HTML to display on the custom page.
name string
Friendly name of the Access Custom Page configuration.
type string
Type of Access custom page to create. Available values: identity_denied, forbidden.
zoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
account_id Changes to this property will trigger replacement. str
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
app_count int
Number of apps to display on the custom page.
custom_html str
Custom HTML to display on the custom page.
name str
Friendly name of the Access Custom Page configuration.
type str
Type of Access custom page to create. Available values: identity_denied, forbidden.
zone_id Changes to this property will trigger replacement. str
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
accountId Changes to this property will trigger replacement. String
The account identifier to target for the resource. Conflicts with zone_id. Modifying this attribute will force creation of a new resource.
appCount Number
Number of apps to display on the custom page.
customHtml String
Custom HTML to display on the custom page.
name String
Friendly name of the Access Custom Page configuration.
type String
Type of Access custom page to create. Available values: identity_denied, forbidden.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare