1. Packages
  2. Cloudflare
  3. API Docs
  4. AccessCustomPage
Cloudflare v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi

cloudflare.AccessCustomPage

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi

    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.AccessCustomPage("example", {
        zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
        name: "example",
        type: "forbidden",
        customHtml: "<html><body><h1>Forbidden</h1></body></html>",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.AccessCustomPage("example",
        zone_id="0da42c8d2132a9ddaf714f9e7c920711",
        name="example",
        type="forbidden",
        custom_html="<html><body><h1>Forbidden</h1></body></html>")
    
    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.NewAccessCustomPage(ctx, "example", &cloudflare.AccessCustomPageArgs{
    			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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Cloudflare.AccessCustomPage("example", new()
        {
            ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
            Name = "example",
            Type = "forbidden",
            CustomHtml = "<html><body><h1>Forbidden</h1></body></html>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.AccessCustomPage;
    import com.pulumi.cloudflare.AccessCustomPageArgs;
    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 AccessCustomPage("example", AccessCustomPageArgs.builder()
                .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
                .name("example")
                .type("forbidden")
                .customHtml("<html><body><h1>Forbidden</h1></body></html>")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:AccessCustomPage
        properties:
          zoneId: 0da42c8d2132a9ddaf714f9e7c920711
          name: example
          type: forbidden
          customHtml: <html><body><h1>Forbidden</h1></body></html>
    

    Create AccessCustomPage Resource

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

    Constructor syntax

    new AccessCustomPage(name: string, args: AccessCustomPageArgs, opts?: CustomResourceOptions);
    @overload
    def AccessCustomPage(resource_name: str,
                         args: AccessCustomPageArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccessCustomPage(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 NewAccessCustomPage(ctx *Context, name string, args AccessCustomPageArgs, opts ...ResourceOption) (*AccessCustomPage, error)
    public AccessCustomPage(string name, AccessCustomPageArgs args, CustomResourceOptions? opts = null)
    public AccessCustomPage(String name, AccessCustomPageArgs args)
    public AccessCustomPage(String name, AccessCustomPageArgs args, CustomResourceOptions options)
    
    type: cloudflare:AccessCustomPage
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AccessCustomPageArgs
    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 AccessCustomPageArgs
    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 AccessCustomPageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessCustomPageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessCustomPageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var accessCustomPageResource = new Cloudflare.AccessCustomPage("accessCustomPageResource", new()
    {
        Name = "string",
        Type = "string",
        AccountId = "string",
        AppCount = 0,
        CustomHtml = "string",
        ZoneId = "string",
    });
    
    example, err := cloudflare.NewAccessCustomPage(ctx, "accessCustomPageResource", &cloudflare.AccessCustomPageArgs{
    	Name:       pulumi.String("string"),
    	Type:       pulumi.String("string"),
    	AccountId:  pulumi.String("string"),
    	AppCount:   pulumi.Int(0),
    	CustomHtml: pulumi.String("string"),
    	ZoneId:     pulumi.String("string"),
    })
    
    var accessCustomPageResource = new AccessCustomPage("accessCustomPageResource", AccessCustomPageArgs.builder()
        .name("string")
        .type("string")
        .accountId("string")
        .appCount(0)
        .customHtml("string")
        .zoneId("string")
        .build());
    
    access_custom_page_resource = cloudflare.AccessCustomPage("accessCustomPageResource",
        name="string",
        type="string",
        account_id="string",
        app_count=0,
        custom_html="string",
        zone_id="string")
    
    const accessCustomPageResource = new cloudflare.AccessCustomPage("accessCustomPageResource", {
        name: "string",
        type: "string",
        accountId: "string",
        appCount: 0,
        customHtml: "string",
        zoneId: "string",
    });
    
    type: cloudflare:AccessCustomPage
    properties:
        accountId: string
        appCount: 0
        customHtml: string
        name: string
        type: string
        zoneId: string
    

    AccessCustomPage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AccessCustomPage resource accepts the following input properties:

    Name string
    Friendly name of the Access Custom Page configuration.
    Type string
    Type of Access custom page to create. Available values: identity_denied, forbidden.
    AccountId 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 string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    Name string
    Friendly name of the Access Custom Page configuration.
    Type string
    Type of Access custom page to create. Available values: identity_denied, forbidden.
    AccountId 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 string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name String
    Friendly name of the Access Custom Page configuration.
    type String
    Type of Access custom page to create. Available values: identity_denied, forbidden.
    accountId 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 String
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name string
    Friendly name of the Access Custom Page configuration.
    type string
    Type of Access custom page to create. Available values: identity_denied, forbidden.
    accountId 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 string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name str
    Friendly name of the Access Custom Page configuration.
    type str
    Type of Access custom page to create. Available values: identity_denied, forbidden.
    account_id 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 str
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    name String
    Friendly name of the Access Custom Page configuration.
    type String
    Type of Access custom page to create. Available values: identity_denied, forbidden.
    accountId 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 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 AccessCustomPage 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 AccessCustomPage Resource

    Get an existing AccessCustomPage 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?: AccessCustomPageState, opts?: CustomResourceOptions): AccessCustomPage
    @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) -> AccessCustomPage
    func GetAccessCustomPage(ctx *Context, name string, id IDInput, state *AccessCustomPageState, opts ...ResourceOption) (*AccessCustomPage, error)
    public static AccessCustomPage Get(string name, Input<string> id, AccessCustomPageState? state, CustomResourceOptions? opts = null)
    public static AccessCustomPage get(String name, Output<String> id, AccessCustomPageState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AccountId 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 string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    AccountId 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 string
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    accountId 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 String
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    accountId 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 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 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 str
    The zone identifier to target for the resource. Conflicts with account_id. Modifying this attribute will force creation of a new resource.
    accountId 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 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 logo
    Cloudflare v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi