Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisCustomPage
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.CisCustomPage

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides an IBM Cloud Internet Services custom page resource that is associated with an IBM CIS instance and a CIS domain resource. It allows to create, update, and delete a custom page of a domain of a CIS instance. For more information about custom page, refer to CIS custom page.

Example Usage

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

// Change Custom Page of the domain
const customPage = new ibm.CisCustomPage("customPage", {
    cisId: data.ibm_cis.cis.id,
    domainId: data.ibm_cis_domain.cis_domain.domain_id,
    pageId: "basic_challenge",
    url: "https://test.com/index.html",
});
Copy
import pulumi
import pulumi_ibm as ibm

# Change Custom Page of the domain
custom_page = ibm.CisCustomPage("customPage",
    cis_id=data["ibm_cis"]["cis"]["id"],
    domain_id=data["ibm_cis_domain"]["cis_domain"]["domain_id"],
    page_id="basic_challenge",
    url="https://test.com/index.html")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Change Custom Page of the domain
		_, err := ibm.NewCisCustomPage(ctx, "customPage", &ibm.CisCustomPageArgs{
			CisId:    pulumi.Any(data.Ibm_cis.Cis.Id),
			DomainId: pulumi.Any(data.Ibm_cis_domain.Cis_domain.Domain_id),
			PageId:   pulumi.String("basic_challenge"),
			Url:      pulumi.String("https://test.com/index.html"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    // Change Custom Page of the domain
    var customPage = new Ibm.CisCustomPage("customPage", new()
    {
        CisId = data.Ibm_cis.Cis.Id,
        DomainId = data.Ibm_cis_domain.Cis_domain.Domain_id,
        PageId = "basic_challenge",
        Url = "https://test.com/index.html",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CisCustomPage;
import com.pulumi.ibm.CisCustomPageArgs;
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) {
        // Change Custom Page of the domain
        var customPage = new CisCustomPage("customPage", CisCustomPageArgs.builder()
            .cisId(data.ibm_cis().cis().id())
            .domainId(data.ibm_cis_domain().cis_domain().domain_id())
            .pageId("basic_challenge")
            .url("https://test.com/index.html")
            .build());

    }
}
Copy
resources:
  # Change Custom Page of the domain
  customPage:
    type: ibm:CisCustomPage
    properties:
      cisId: ${data.ibm_cis.cis.id}
      domainId: ${data.ibm_cis_domain.cis_domain.domain_id}
      pageId: basic_challenge
      url: https://test.com/index.html
Copy

Create CisCustomPage Resource

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

Constructor syntax

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

@overload
def CisCustomPage(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cis_id: Optional[str] = None,
                  domain_id: Optional[str] = None,
                  page_id: Optional[str] = None,
                  url: Optional[str] = None,
                  cis_custom_page_id: Optional[str] = None)
func NewCisCustomPage(ctx *Context, name string, args CisCustomPageArgs, opts ...ResourceOption) (*CisCustomPage, error)
public CisCustomPage(string name, CisCustomPageArgs args, CustomResourceOptions? opts = null)
public CisCustomPage(String name, CisCustomPageArgs args)
public CisCustomPage(String name, CisCustomPageArgs args, CustomResourceOptions options)

type: ibm:CisCustomPage
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. CisCustomPageArgs
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. CisCustomPageArgs
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. CisCustomPageArgs
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. CisCustomPageArgs
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. CisCustomPageArgs
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 cisCustomPageResource = new Ibm.CisCustomPage("cisCustomPageResource", new()
{
    CisId = "string",
    DomainId = "string",
    PageId = "string",
    Url = "string",
    CisCustomPageId = "string",
});
Copy
example, err := ibm.NewCisCustomPage(ctx, "cisCustomPageResource", &ibm.CisCustomPageArgs{
	CisId:           pulumi.String("string"),
	DomainId:        pulumi.String("string"),
	PageId:          pulumi.String("string"),
	Url:             pulumi.String("string"),
	CisCustomPageId: pulumi.String("string"),
})
Copy
var cisCustomPageResource = new CisCustomPage("cisCustomPageResource", CisCustomPageArgs.builder()
    .cisId("string")
    .domainId("string")
    .pageId("string")
    .url("string")
    .cisCustomPageId("string")
    .build());
Copy
cis_custom_page_resource = ibm.CisCustomPage("cisCustomPageResource",
    cis_id="string",
    domain_id="string",
    page_id="string",
    url="string",
    cis_custom_page_id="string")
Copy
const cisCustomPageResource = new ibm.CisCustomPage("cisCustomPageResource", {
    cisId: "string",
    domainId: "string",
    pageId: "string",
    url: "string",
    cisCustomPageId: "string",
});
Copy
type: ibm:CisCustomPage
properties:
    cisCustomPageId: string
    cisId: string
    domainId: string
    pageId: string
    url: string
Copy

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

CisId This property is required. string
The ID of the IBM Cloud Internet Services instance.
DomainId This property is required. string
The ID of the domain to change custom page.
PageId This property is required. string
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
Url This property is required. string
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
CisCustomPageId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
CisId This property is required. string
The ID of the IBM Cloud Internet Services instance.
DomainId This property is required. string
The ID of the domain to change custom page.
PageId This property is required. string
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
Url This property is required. string
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
CisCustomPageId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cisId This property is required. String
The ID of the IBM Cloud Internet Services instance.
domainId This property is required. String
The ID of the domain to change custom page.
pageId This property is required. String
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
url This property is required. String
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cisCustomPageId String
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cisId This property is required. string
The ID of the IBM Cloud Internet Services instance.
domainId This property is required. string
The ID of the domain to change custom page.
pageId This property is required. string
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
url This property is required. string
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cisCustomPageId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cis_id This property is required. str
The ID of the IBM Cloud Internet Services instance.
domain_id This property is required. str
The ID of the domain to change custom page.
page_id This property is required. str
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
url This property is required. str
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cis_custom_page_id str
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cisId This property is required. String
The ID of the IBM Cloud Internet Services instance.
domainId This property is required. String
The ID of the domain to change custom page.
pageId This property is required. String
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
url This property is required. String
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cisCustomPageId String
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.

Outputs

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

CreatedOn string
(String) Created date and time of the custom page.
Description string
(String) The description of the custom page.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedOn string
(String) Modified date and time of the custom page.
PreviewTarget string
(String) The custom page target.
RequiredTokens List<string>
(List)The custom page required token which is expected from URL page.
State string
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
CreatedOn string
(String) Created date and time of the custom page.
Description string
(String) The description of the custom page.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedOn string
(String) Modified date and time of the custom page.
PreviewTarget string
(String) The custom page target.
RequiredTokens []string
(List)The custom page required token which is expected from URL page.
State string
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
createdOn String
(String) Created date and time of the custom page.
description String
(String) The description of the custom page.
id String
The provider-assigned unique ID for this managed resource.
modifiedOn String
(String) Modified date and time of the custom page.
previewTarget String
(String) The custom page target.
requiredTokens List<String>
(List)The custom page required token which is expected from URL page.
state String
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
createdOn string
(String) Created date and time of the custom page.
description string
(String) The description of the custom page.
id string
The provider-assigned unique ID for this managed resource.
modifiedOn string
(String) Modified date and time of the custom page.
previewTarget string
(String) The custom page target.
requiredTokens string[]
(List)The custom page required token which is expected from URL page.
state string
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
created_on str
(String) Created date and time of the custom page.
description str
(String) The description of the custom page.
id str
The provider-assigned unique ID for this managed resource.
modified_on str
(String) Modified date and time of the custom page.
preview_target str
(String) The custom page target.
required_tokens Sequence[str]
(List)The custom page required token which is expected from URL page.
state str
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
createdOn String
(String) Created date and time of the custom page.
description String
(String) The description of the custom page.
id String
The provider-assigned unique ID for this managed resource.
modifiedOn String
(String) Modified date and time of the custom page.
previewTarget String
(String) The custom page target.
requiredTokens List<String>
(List)The custom page required token which is expected from URL page.
state String
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.

Look up Existing CisCustomPage Resource

Get an existing CisCustomPage 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?: CisCustomPageState, opts?: CustomResourceOptions): CisCustomPage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cis_custom_page_id: Optional[str] = None,
        cis_id: Optional[str] = None,
        created_on: Optional[str] = None,
        description: Optional[str] = None,
        domain_id: Optional[str] = None,
        modified_on: Optional[str] = None,
        page_id: Optional[str] = None,
        preview_target: Optional[str] = None,
        required_tokens: Optional[Sequence[str]] = None,
        state: Optional[str] = None,
        url: Optional[str] = None) -> CisCustomPage
func GetCisCustomPage(ctx *Context, name string, id IDInput, state *CisCustomPageState, opts ...ResourceOption) (*CisCustomPage, error)
public static CisCustomPage Get(string name, Input<string> id, CisCustomPageState? state, CustomResourceOptions? opts = null)
public static CisCustomPage get(String name, Output<String> id, CisCustomPageState state, CustomResourceOptions options)
resources:  _:    type: ibm:CisCustomPage    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:
CisCustomPageId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
CisId string
The ID of the IBM Cloud Internet Services instance.
CreatedOn string
(String) Created date and time of the custom page.
Description string
(String) The description of the custom page.
DomainId string
The ID of the domain to change custom page.
ModifiedOn string
(String) Modified date and time of the custom page.
PageId string
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
PreviewTarget string
(String) The custom page target.
RequiredTokens List<string>
(List)The custom page required token which is expected from URL page.
State string
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
Url string
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
CisCustomPageId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
CisId string
The ID of the IBM Cloud Internet Services instance.
CreatedOn string
(String) Created date and time of the custom page.
Description string
(String) The description of the custom page.
DomainId string
The ID of the domain to change custom page.
ModifiedOn string
(String) Modified date and time of the custom page.
PageId string
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
PreviewTarget string
(String) The custom page target.
RequiredTokens []string
(List)The custom page required token which is expected from URL page.
State string
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
Url string
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cisCustomPageId String
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cisId String
The ID of the IBM Cloud Internet Services instance.
createdOn String
(String) Created date and time of the custom page.
description String
(String) The description of the custom page.
domainId String
The ID of the domain to change custom page.
modifiedOn String
(String) Modified date and time of the custom page.
pageId String
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
previewTarget String
(String) The custom page target.
requiredTokens List<String>
(List)The custom page required token which is expected from URL page.
state String
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
url String
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cisCustomPageId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cisId string
The ID of the IBM Cloud Internet Services instance.
createdOn string
(String) Created date and time of the custom page.
description string
(String) The description of the custom page.
domainId string
The ID of the domain to change custom page.
modifiedOn string
(String) Modified date and time of the custom page.
pageId string
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
previewTarget string
(String) The custom page target.
requiredTokens string[]
(List)The custom page required token which is expected from URL page.
state string
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
url string
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cis_custom_page_id str
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cis_id str
The ID of the IBM Cloud Internet Services instance.
created_on str
(String) Created date and time of the custom page.
description str
(String) The description of the custom page.
domain_id str
The ID of the domain to change custom page.
modified_on str
(String) Modified date and time of the custom page.
page_id str
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
preview_target str
(String) The custom page target.
required_tokens Sequence[str]
(List)The custom page required token which is expected from URL page.
state str
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
url str
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.
cisCustomPageId String
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
cisId String
The ID of the IBM Cloud Internet Services instance.
createdOn String
(String) Created date and time of the custom page.
description String
(String) The description of the custom page.
domainId String
The ID of the domain to change custom page.
modifiedOn String
(String) Modified date and time of the custom page.
pageId String
The custom page identifier. Valid values are basic_challenge, waf_challenge, waf_block, ratelimit_block, country_challenge, ip_block, under_attack, 500_errors, 1000_errors, always_online.
previewTarget String
(String) The custom page target.
requiredTokens List<String>
(List)The custom page required token which is expected from URL page.
state String
(String) The custom page state. This is set default when there is an empty URL and can customize when URL is set with some URL.
url String
The URL for custom page settings. By default URL is set with empty string "". Setting a duplicate empty string throws an error.

Import

The ibm_cis_custom_page resource can be imported by using the ID. The ID is formed from the page_id, domain ID of the domain and the CRN concatenated using a : character.

The domain ID and CRN will be located on the overview page of the IBM Cloud Internet Services instance of the console domain heading, or by using the ibmcloud cis command line commands.

  • Page ID is a string of the form: basic_challenge

  • Domain ID is a 32 digit character string of the form: 9caf68812ae9b3f0377fdf986751a78f

  • CRN is a 120 digit character string of the form: crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::

Syntax

$ pulumi import ibm:index/cisCustomPage:CisCustomPage custom_page <page_id>:<domain-id>:<crn>
Copy

Example

$ pulumi import ibm:index/cisCustomPage:CisCustomPage custom_page basic_challenge:9caf68812ae9b3f0377fdf986751a78f:crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm