CisPageRule

ibm 2.0.0, Mar 30 26

Viewing docs for ibm 2.0.0
published on Monday, Mar 30, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Viewing docs for ibm 2.0.0
published on Monday, Mar 30, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Provides an IBM Cloud Internet Services page rule resource, to create, update, delete page rules of a domain. This resource is associated with an IBM Cloud Internet Services instance and an IBM Cloud Internet Services domain resource. For more information, about IBM Cloud Internet Services page rules, see using page rules.

Example Usage

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

// Add a page rule to the domain
const pageRule = new ibm.CisPageRule("page_rule", {
    cisId: cisCrn,
    domainId: zoneId,
    targets: [{
        target: "url",
        constraint: {
            operator: "matches",
            value: "example.com",
        },
    }],
    actions: [
        {
            id: "email_obfuscation",
            value: "on",
        },
        {
            id: "forwarding_url",
            url: "https://ibm.travis-kuganes1.sdk.cistest-load.com/*",
            statusCode: 302,
        },
        {
            id: "minify",
            html: "off",
            css: "on",
            js: "off",
        },
    ],
});

import pulumi
import pulumi_ibm as ibm

# Add a page rule to the domain
page_rule = ibm.CisPageRule("page_rule",
    cis_id=cis_crn,
    domain_id=zone_id,
    targets=[{
        "target": "url",
        "constraint": {
            "operator": "matches",
            "value": "example.com",
        },
    }],
    actions=[
        {
            "id": "email_obfuscation",
            "value": "on",
        },
        {
            "id": "forwarding_url",
            "url": "https://ibm.travis-kuganes1.sdk.cistest-load.com/*",
            "status_code": 302,
        },
        {
            "id": "minify",
            "html": "off",
            "css": "on",
            "js": "off",
        },
    ])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Add a page rule to the domain
		_, err := ibm.NewCisPageRule(ctx, "page_rule", &ibm.CisPageRuleArgs{
			CisId:    pulumi.Any(cisCrn),
			DomainId: pulumi.Any(zoneId),
			Targets: ibm.CisPageRuleTargetArray{
				&ibm.CisPageRuleTargetArgs{
					Target: pulumi.String("url"),
					Constraint: &ibm.CisPageRuleTargetConstraintArgs{
						Operator: pulumi.String("matches"),
						Value:    pulumi.String("example.com"),
					},
				},
			},
			Actions: ibm.CisPageRuleActionArray{
				&ibm.CisPageRuleActionArgs{
					Id:    pulumi.String("email_obfuscation"),
					Value: pulumi.String("on"),
				},
				&ibm.CisPageRuleActionArgs{
					Id:         pulumi.String("forwarding_url"),
					Url:        pulumi.String("https://ibm.travis-kuganes1.sdk.cistest-load.com/*"),
					StatusCode: pulumi.Float64(302),
				},
				&ibm.CisPageRuleActionArgs{
					Id:   pulumi.String("minify"),
					Html: pulumi.String("off"),
					Css:  pulumi.String("on"),
					Js:   pulumi.String("off"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    // Add a page rule to the domain
    var pageRule = new Ibm.CisPageRule("page_rule", new()
    {
        CisId = cisCrn,
        DomainId = zoneId,
        Targets = new[]
        {
            new Ibm.Inputs.CisPageRuleTargetArgs
            {
                Target = "url",
                Constraint = new Ibm.Inputs.CisPageRuleTargetConstraintArgs
                {
                    Operator = "matches",
                    Value = "example.com",
                },
            },
        },
        Actions = new[]
        {
            new Ibm.Inputs.CisPageRuleActionArgs
            {
                Id = "email_obfuscation",
                Value = "on",
            },
            new Ibm.Inputs.CisPageRuleActionArgs
            {
                Id = "forwarding_url",
                Url = "https://ibm.travis-kuganes1.sdk.cistest-load.com/*",
                StatusCode = 302,
            },
            new Ibm.Inputs.CisPageRuleActionArgs
            {
                Id = "minify",
                Html = "off",
                Css = "on",
                Js = "off",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CisPageRule;
import com.pulumi.ibm.CisPageRuleArgs;
import com.pulumi.ibm.inputs.CisPageRuleTargetArgs;
import com.pulumi.ibm.inputs.CisPageRuleTargetConstraintArgs;
import com.pulumi.ibm.inputs.CisPageRuleActionArgs;
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) {
        // Add a page rule to the domain
        var pageRule = new CisPageRule("pageRule", CisPageRuleArgs.builder()
            .cisId(cisCrn)
            .domainId(zoneId)
            .targets(CisPageRuleTargetArgs.builder()
                .target("url")
                .constraint(CisPageRuleTargetConstraintArgs.builder()
                    .operator("matches")
                    .value("example.com")
                    .build())
                .build())
            .actions(            
                CisPageRuleActionArgs.builder()
                    .id("email_obfuscation")
                    .value("on")
                    .build(),
                CisPageRuleActionArgs.builder()
                    .id("forwarding_url")
                    .url("https://ibm.travis-kuganes1.sdk.cistest-load.com/*")
                    .statusCode(302.0)
                    .build(),
                CisPageRuleActionArgs.builder()
                    .id("minify")
                    .html("off")
                    .css("on")
                    .js("off")
                    .build())
            .build());

    }
}

resources:
  # Add a page rule to the domain
  pageRule:
    type: ibm:CisPageRule
    name: page_rule
    properties:
      cisId: ${cisCrn}
      domainId: ${zoneId}
      targets:
        - target: url
          constraint:
            operator: matches
            value: example.com
      actions:
        - id: email_obfuscation
          value: on
        - id: forwarding_url
          url: https://ibm.travis-kuganes1.sdk.cistest-load.com/*
          statusCode: 302
        - id: minify
          html: off
          css: on
          js: off

Create CisPageRule Resource

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

Constructor syntax

new CisPageRule(name: string, args: CisPageRuleArgs, opts?: CustomResourceOptions);

@overload
def CisPageRule(resource_name: str,
                args: CisPageRuleArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def CisPageRule(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                actions: Optional[Sequence[CisPageRuleActionArgs]] = None,
                cis_id: Optional[str] = None,
                domain_id: Optional[str] = None,
                targets: Optional[Sequence[CisPageRuleTargetArgs]] = None,
                cis_page_rule_id: Optional[str] = None,
                priority: Optional[float] = None,
                status: Optional[str] = None)

func NewCisPageRule(ctx *Context, name string, args CisPageRuleArgs, opts ...ResourceOption) (*CisPageRule, error)

public CisPageRule(string name, CisPageRuleArgs args, CustomResourceOptions? opts = null)

public CisPageRule(String name, CisPageRuleArgs args)
public CisPageRule(String name, CisPageRuleArgs args, CustomResourceOptions options)

type: ibm:CisPageRule
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 CisPageRuleArgs: 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 CisPageRuleArgs: 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 CisPageRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CisPageRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CisPageRuleArgs: 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 cisPageRuleResource = new Ibm.Index.CisPageRule("cisPageRuleResource", new()
{
    Actions = new[]
    {
        new Ibm.Inputs.CisPageRuleActionArgs
        {
            Id = "string",
            Css = "string",
            Html = "string",
            Js = "string",
            StatusCode = 0,
            Url = "string",
            Value = "string",
        },
    },
    CisId = "string",
    DomainId = "string",
    Targets = new[]
    {
        new Ibm.Inputs.CisPageRuleTargetArgs
        {
            Constraint = new Ibm.Inputs.CisPageRuleTargetConstraintArgs
            {
                Operator = "string",
                Value = "string",
            },
            Target = "string",
        },
    },
    CisPageRuleId = "string",
    Priority = 0,
    Status = "string",
});

example, err := ibm.NewCisPageRule(ctx, "cisPageRuleResource", &ibm.CisPageRuleArgs{
	Actions: ibm.CisPageRuleActionArray{
		&ibm.CisPageRuleActionArgs{
			Id:         pulumi.String("string"),
			Css:        pulumi.String("string"),
			Html:       pulumi.String("string"),
			Js:         pulumi.String("string"),
			StatusCode: pulumi.Float64(0),
			Url:        pulumi.String("string"),
			Value:      pulumi.String("string"),
		},
	},
	CisId:    pulumi.String("string"),
	DomainId: pulumi.String("string"),
	Targets: ibm.CisPageRuleTargetArray{
		&ibm.CisPageRuleTargetArgs{
			Constraint: &ibm.CisPageRuleTargetConstraintArgs{
				Operator: pulumi.String("string"),
				Value:    pulumi.String("string"),
			},
			Target: pulumi.String("string"),
		},
	},
	CisPageRuleId: pulumi.String("string"),
	Priority:      pulumi.Float64(0),
	Status:        pulumi.String("string"),
})

var cisPageRuleResource = new CisPageRule("cisPageRuleResource", CisPageRuleArgs.builder()
    .actions(CisPageRuleActionArgs.builder()
        .id("string")
        .css("string")
        .html("string")
        .js("string")
        .statusCode(0.0)
        .url("string")
        .value("string")
        .build())
    .cisId("string")
    .domainId("string")
    .targets(CisPageRuleTargetArgs.builder()
        .constraint(CisPageRuleTargetConstraintArgs.builder()
            .operator("string")
            .value("string")
            .build())
        .target("string")
        .build())
    .cisPageRuleId("string")
    .priority(0.0)
    .status("string")
    .build());

cis_page_rule_resource = ibm.CisPageRule("cisPageRuleResource",
    actions=[{
        "id": "string",
        "css": "string",
        "html": "string",
        "js": "string",
        "status_code": 0,
        "url": "string",
        "value": "string",
    }],
    cis_id="string",
    domain_id="string",
    targets=[{
        "constraint": {
            "operator": "string",
            "value": "string",
        },
        "target": "string",
    }],
    cis_page_rule_id="string",
    priority=0,
    status="string")

const cisPageRuleResource = new ibm.CisPageRule("cisPageRuleResource", {
    actions: [{
        id: "string",
        css: "string",
        html: "string",
        js: "string",
        statusCode: 0,
        url: "string",
        value: "string",
    }],
    cisId: "string",
    domainId: "string",
    targets: [{
        constraint: {
            operator: "string",
            value: "string",
        },
        target: "string",
    }],
    cisPageRuleId: "string",
    priority: 0,
    status: "string",
});

type: ibm:CisPageRule
properties:
    actions:
        - css: string
          html: string
          id: string
          js: string
          statusCode: 0
          url: string
          value: string
    cisId: string
    cisPageRuleId: string
    domainId: string
    priority: 0
    status: string
    targets:
        - constraint:
            operator: string
            value: string
          target: string

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

Actions List<CisPageRuleAction>

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

CisId string

The ID of the IBM Cloud Internet Services instance.

DomainId string

The ID of the IBM Cloud Internet Services domain.

Targets List<CisPageRuleTarget>

The targets, where rule is added.

Nested scheme for targets:

CisPageRuleId string

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

Priority double

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

Status string

The status of the page rule. Valid values are active and disabled. Default value is disabled.

Actions []CisPageRuleActionArgs

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

CisId string

The ID of the IBM Cloud Internet Services instance.

DomainId string

The ID of the IBM Cloud Internet Services domain.

Targets []CisPageRuleTargetArgs

The targets, where rule is added.

Nested scheme for targets:

CisPageRuleId string

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

Priority float64

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

Status string

The status of the page rule. Valid values are active and disabled. Default value is disabled.

actions List<CisPageRuleAction>

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cisId String

The ID of the IBM Cloud Internet Services instance.

domainId String

The ID of the IBM Cloud Internet Services domain.

targets List<CisPageRuleTarget>

The targets, where rule is added.

Nested scheme for targets:

cisPageRuleId String

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

priority Double

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

status String

The status of the page rule. Valid values are active and disabled. Default value is disabled.

actions CisPageRuleAction[]

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cisId string

The ID of the IBM Cloud Internet Services instance.

domainId string

The ID of the IBM Cloud Internet Services domain.

targets CisPageRuleTarget[]

The targets, where rule is added.

Nested scheme for targets:

cisPageRuleId string

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

priority number

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

status string

The status of the page rule. Valid values are active and disabled. Default value is disabled.

actions Sequence[CisPageRuleActionArgs]

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cis_id str

The ID of the IBM Cloud Internet Services instance.

domain_id str

The ID of the IBM Cloud Internet Services domain.

targets Sequence[CisPageRuleTargetArgs]

The targets, where rule is added.

Nested scheme for targets:

cis_page_rule_id str

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

priority float

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

status str

The status of the page rule. Valid values are active and disabled. Default value is disabled.

actions List<Property Map>

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cisId String

The ID of the IBM Cloud Internet Services instance.

domainId String

The ID of the IBM Cloud Internet Services domain.

targets List<Property Map>

The targets, where rule is added.

Nested scheme for targets:

cisPageRuleId String

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

priority Number

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

status String

The status of the page rule. Valid values are active and disabled. Default value is disabled.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
RuleId string: (String) The page rule ID.

Id string: The provider-assigned unique ID for this managed resource.
RuleId string: (String) The page rule ID.

id String: The provider-assigned unique ID for this managed resource.
ruleId String: (String) The page rule ID.

id string: The provider-assigned unique ID for this managed resource.
ruleId string: (String) The page rule ID.

id str: The provider-assigned unique ID for this managed resource.
rule_id str: (String) The page rule ID.

id String: The provider-assigned unique ID for this managed resource.
ruleId String: (String) The page rule ID.

Look up Existing CisPageRule Resource

Get an existing CisPageRule 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?: CisPageRuleState, opts?: CustomResourceOptions): CisPageRule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actions: Optional[Sequence[CisPageRuleActionArgs]] = None,
        cis_id: Optional[str] = None,
        cis_page_rule_id: Optional[str] = None,
        domain_id: Optional[str] = None,
        priority: Optional[float] = None,
        rule_id: Optional[str] = None,
        status: Optional[str] = None,
        targets: Optional[Sequence[CisPageRuleTargetArgs]] = None) -> CisPageRule

func GetCisPageRule(ctx *Context, name string, id IDInput, state *CisPageRuleState, opts ...ResourceOption) (*CisPageRule, error)

public static CisPageRule Get(string name, Input<string> id, CisPageRuleState? state, CustomResourceOptions? opts = null)

public static CisPageRule get(String name, Output<String> id, CisPageRuleState state, CustomResourceOptions options)

resources:  _:    type: ibm:CisPageRule    get:      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:

Actions List<CisPageRuleAction>

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

CisId string

The ID of the IBM Cloud Internet Services instance.

CisPageRuleId string

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

DomainId string

The ID of the IBM Cloud Internet Services domain.

Priority double

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

RuleId string

(String) The page rule ID.

Status string

The status of the page rule. Valid values are active and disabled. Default value is disabled.

Targets List<CisPageRuleTarget>

The targets, where rule is added.

Nested scheme for targets:

Actions []CisPageRuleActionArgs

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

CisId string

The ID of the IBM Cloud Internet Services instance.

CisPageRuleId string

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

DomainId string

The ID of the IBM Cloud Internet Services domain.

Priority float64

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

RuleId string

(String) The page rule ID.

Status string

The status of the page rule. Valid values are active and disabled. Default value is disabled.

Targets []CisPageRuleTargetArgs

The targets, where rule is added.

Nested scheme for targets:

actions List<CisPageRuleAction>

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cisId String

The ID of the IBM Cloud Internet Services instance.

cisPageRuleId String

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

domainId String

The ID of the IBM Cloud Internet Services domain.

priority Double

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

ruleId String

(String) The page rule ID.

status String

The status of the page rule. Valid values are active and disabled. Default value is disabled.

targets List<CisPageRuleTarget>

The targets, where rule is added.

Nested scheme for targets:

actions CisPageRuleAction[]

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cisId string

The ID of the IBM Cloud Internet Services instance.

cisPageRuleId string

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

domainId string

The ID of the IBM Cloud Internet Services domain.

priority number

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

ruleId string

(String) The page rule ID.

status string

The status of the page rule. Valid values are active and disabled. Default value is disabled.

targets CisPageRuleTarget[]

The targets, where rule is added.

Nested scheme for targets:

actions Sequence[CisPageRuleActionArgs]

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cis_id str

The ID of the IBM Cloud Internet Services instance.

cis_page_rule_id str

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

domain_id str

The ID of the IBM Cloud Internet Services domain.

priority float

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

rule_id str

(String) The page rule ID.

status str

The status of the page rule. Valid values are active and disabled. Default value is disabled.

targets Sequence[CisPageRuleTargetArgs]

The targets, where rule is added.

Nested scheme for targets:

actions List<Property Map>

The list of actions performed on URL. Minimum items is 1.

Nested scheme for actions:

cisId String

The ID of the IBM Cloud Internet Services instance.

cisPageRuleId String

(String) The record ID. It is a combination of <rule_id>:<domain_id>:<cis_id> attributes of the origin pool.

domainId String

The ID of the IBM Cloud Internet Services domain.

priority Number

The priority of the page rule. Default value is 1. Set and Update are not supported yet.

ruleId String

(String) The page rule ID.

status String

The status of the page rule. Valid values are active and disabled. Default value is disabled.

targets List<Property Map>

The targets, where rule is added.

Nested scheme for targets:

Supporting Types

CisPageRuleAction, CisPageRuleActionArgs

Id string

The action ID. Valid values are page rule action field map from console to API CF-UI map API).

Css string

The required attribute for minify action. CSS supported values are on and off.

Html string

The required attribute for minify action. HTML supported values are on and off.

Js string

The required attribute for minify action. JS supported values are on and off.

StatusCode double

The status code to check for URL forwarding. The required attribute for forwarding_url action. Valid values are 301 and 302. It returns 0 for all other actions.

Url string

The forward rule URL, a required attribute for forwarding_url action.

Value string

The values for corresponding actions.

NOTE Below table shows corresponding valid values of id and value of actions argument

id	description	valid values
`always_online`	The action conflicts with all other settings.	`on`, `off`
`always_use_https`	The action conflicts with all other settings.	The value is not required.
`automatic_https_rewrites`	The automatic HTTPS rewrites.	`on`, `off`
`browser_cache_ttl`	The browser cache TTL.	`0`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `691200`, `1382400`, `2073600`, `2678400`, `5356800`, `16070400`, `31536000`
`bypass_cache_on_cookie`	The bypass cache on cookie.	cookie tags
`browser_check`	The browser integrity check.	`on`, `off`
`cache_level`	The cache level.	`bypass`, `aggressive`, `basic`, `simplified`, `cache_everything`
`cache_on_cookie`	The cache on cookie.	The cookie value
`cache_deception_armor`	The cache deception armor.	`on`, `off`
`disable_security`	The action conflicts with `email_obfuscation`, `server_side_exclude`, `waf`.	The value is not required.
`disable_apps`	The disable apps.	The value is not required
`disable_performance`	The disable performance.	The value is not required.
`edge_cache_ttl`	The edge cache TTL.	`0`, `30`, `60`, `300`, `600`, `1200`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `518400`, `604800`, `1209600`, `2419200`
`email_obfuscation`	The Email obfuscation.	`on`, `off`
`explicit_cache_control`	The origin cache control.	`on`, `off`
`forwarding_url`	The action conflicts with all other settings.	The value is not required.
`host_header_override`	The host header override.	The header value.
`image_load_optimization`	The image load optimization.	`on`, `off`
`image_size_optimization`	The image size optimization.	`on`, `off`
`ip_geolocation`	The IP geography location header.	`on`, `off`
`opportunistic_encryption`	The opportunistic encryption.	`on`, `off`
`origin_error_page_pass_thru`	The origin error page pass-through.	`on`, `off`
`resolve_override`	The resolve override.	The value for resolving URL override.
`response_buffering`	The response buffering.	`on`, `off`
`script_load_optimization`	The script load optimization.	`off`, `lossless`, `lossy`
`ssl`	The TLS settings.	`off`, `flexible`, `full`, `strict`,`origin_pull`
`security_level`	The security level.	`disable_security`, `always_use_https`
`server_side_exclude`	The server side excludes.	`on`, `off`
`server_stale_content`	The server stale content.	`on`, `off`
`sort_query_string_for_cache`	The sort query string.	`on`, `off`
`true_client_ip_header`	The true client IP header.	`on`, `off`
`waf`	The Web Application Firewall.	`on`, `off`
`minify`	The Minify web content	The value is not required

Id string

The action ID. Valid values are page rule action field map from console to API CF-UI map API).

Css string

The required attribute for minify action. CSS supported values are on and off.

Html string

The required attribute for minify action. HTML supported values are on and off.

Js string

The required attribute for minify action. JS supported values are on and off.

StatusCode float64

The status code to check for URL forwarding. The required attribute for forwarding_url action. Valid values are 301 and 302. It returns 0 for all other actions.

Url string

The forward rule URL, a required attribute for forwarding_url action.

Value string

The values for corresponding actions.

NOTE Below table shows corresponding valid values of id and value of actions argument

id	description	valid values
`always_online`	The action conflicts with all other settings.	`on`, `off`
`always_use_https`	The action conflicts with all other settings.	The value is not required.
`automatic_https_rewrites`	The automatic HTTPS rewrites.	`on`, `off`
`browser_cache_ttl`	The browser cache TTL.	`0`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `691200`, `1382400`, `2073600`, `2678400`, `5356800`, `16070400`, `31536000`
`bypass_cache_on_cookie`	The bypass cache on cookie.	cookie tags
`browser_check`	The browser integrity check.	`on`, `off`
`cache_level`	The cache level.	`bypass`, `aggressive`, `basic`, `simplified`, `cache_everything`
`cache_on_cookie`	The cache on cookie.	The cookie value
`cache_deception_armor`	The cache deception armor.	`on`, `off`
`disable_security`	The action conflicts with `email_obfuscation`, `server_side_exclude`, `waf`.	The value is not required.
`disable_apps`	The disable apps.	The value is not required
`disable_performance`	The disable performance.	The value is not required.
`edge_cache_ttl`	The edge cache TTL.	`0`, `30`, `60`, `300`, `600`, `1200`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `518400`, `604800`, `1209600`, `2419200`
`email_obfuscation`	The Email obfuscation.	`on`, `off`
`explicit_cache_control`	The origin cache control.	`on`, `off`
`forwarding_url`	The action conflicts with all other settings.	The value is not required.
`host_header_override`	The host header override.	The header value.
`image_load_optimization`	The image load optimization.	`on`, `off`
`image_size_optimization`	The image size optimization.	`on`, `off`
`ip_geolocation`	The IP geography location header.	`on`, `off`
`opportunistic_encryption`	The opportunistic encryption.	`on`, `off`
`origin_error_page_pass_thru`	The origin error page pass-through.	`on`, `off`
`resolve_override`	The resolve override.	The value for resolving URL override.
`response_buffering`	The response buffering.	`on`, `off`
`script_load_optimization`	The script load optimization.	`off`, `lossless`, `lossy`
`ssl`	The TLS settings.	`off`, `flexible`, `full`, `strict`,`origin_pull`
`security_level`	The security level.	`disable_security`, `always_use_https`
`server_side_exclude`	The server side excludes.	`on`, `off`
`server_stale_content`	The server stale content.	`on`, `off`
`sort_query_string_for_cache`	The sort query string.	`on`, `off`
`true_client_ip_header`	The true client IP header.	`on`, `off`
`waf`	The Web Application Firewall.	`on`, `off`
`minify`	The Minify web content	The value is not required

id String

The action ID. Valid values are page rule action field map from console to API CF-UI map API).

css String

The required attribute for minify action. CSS supported values are on and off.

html String

The required attribute for minify action. HTML supported values are on and off.

js String

The required attribute for minify action. JS supported values are on and off.

statusCode Double

The status code to check for URL forwarding. The required attribute for forwarding_url action. Valid values are 301 and 302. It returns 0 for all other actions.

url String

The forward rule URL, a required attribute for forwarding_url action.

value String

The values for corresponding actions.

NOTE Below table shows corresponding valid values of id and value of actions argument

id	description	valid values
`always_online`	The action conflicts with all other settings.	`on`, `off`
`always_use_https`	The action conflicts with all other settings.	The value is not required.
`automatic_https_rewrites`	The automatic HTTPS rewrites.	`on`, `off`
`browser_cache_ttl`	The browser cache TTL.	`0`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `691200`, `1382400`, `2073600`, `2678400`, `5356800`, `16070400`, `31536000`
`bypass_cache_on_cookie`	The bypass cache on cookie.	cookie tags
`browser_check`	The browser integrity check.	`on`, `off`
`cache_level`	The cache level.	`bypass`, `aggressive`, `basic`, `simplified`, `cache_everything`
`cache_on_cookie`	The cache on cookie.	The cookie value
`cache_deception_armor`	The cache deception armor.	`on`, `off`
`disable_security`	The action conflicts with `email_obfuscation`, `server_side_exclude`, `waf`.	The value is not required.
`disable_apps`	The disable apps.	The value is not required
`disable_performance`	The disable performance.	The value is not required.
`edge_cache_ttl`	The edge cache TTL.	`0`, `30`, `60`, `300`, `600`, `1200`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `518400`, `604800`, `1209600`, `2419200`
`email_obfuscation`	The Email obfuscation.	`on`, `off`
`explicit_cache_control`	The origin cache control.	`on`, `off`
`forwarding_url`	The action conflicts with all other settings.	The value is not required.
`host_header_override`	The host header override.	The header value.
`image_load_optimization`	The image load optimization.	`on`, `off`
`image_size_optimization`	The image size optimization.	`on`, `off`
`ip_geolocation`	The IP geography location header.	`on`, `off`
`opportunistic_encryption`	The opportunistic encryption.	`on`, `off`
`origin_error_page_pass_thru`	The origin error page pass-through.	`on`, `off`
`resolve_override`	The resolve override.	The value for resolving URL override.
`response_buffering`	The response buffering.	`on`, `off`
`script_load_optimization`	The script load optimization.	`off`, `lossless`, `lossy`
`ssl`	The TLS settings.	`off`, `flexible`, `full`, `strict`,`origin_pull`
`security_level`	The security level.	`disable_security`, `always_use_https`
`server_side_exclude`	The server side excludes.	`on`, `off`
`server_stale_content`	The server stale content.	`on`, `off`
`sort_query_string_for_cache`	The sort query string.	`on`, `off`
`true_client_ip_header`	The true client IP header.	`on`, `off`
`waf`	The Web Application Firewall.	`on`, `off`
`minify`	The Minify web content	The value is not required

id string

The action ID. Valid values are page rule action field map from console to API CF-UI map API).

css string

The required attribute for minify action. CSS supported values are on and off.

html string

The required attribute for minify action. HTML supported values are on and off.

js string

The required attribute for minify action. JS supported values are on and off.

statusCode number

The status code to check for URL forwarding. The required attribute for forwarding_url action. Valid values are 301 and 302. It returns 0 for all other actions.

url string

The forward rule URL, a required attribute for forwarding_url action.

value string

The values for corresponding actions.

NOTE Below table shows corresponding valid values of id and value of actions argument

id	description	valid values
`always_online`	The action conflicts with all other settings.	`on`, `off`
`always_use_https`	The action conflicts with all other settings.	The value is not required.
`automatic_https_rewrites`	The automatic HTTPS rewrites.	`on`, `off`
`browser_cache_ttl`	The browser cache TTL.	`0`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `691200`, `1382400`, `2073600`, `2678400`, `5356800`, `16070400`, `31536000`
`bypass_cache_on_cookie`	The bypass cache on cookie.	cookie tags
`browser_check`	The browser integrity check.	`on`, `off`
`cache_level`	The cache level.	`bypass`, `aggressive`, `basic`, `simplified`, `cache_everything`
`cache_on_cookie`	The cache on cookie.	The cookie value
`cache_deception_armor`	The cache deception armor.	`on`, `off`
`disable_security`	The action conflicts with `email_obfuscation`, `server_side_exclude`, `waf`.	The value is not required.
`disable_apps`	The disable apps.	The value is not required
`disable_performance`	The disable performance.	The value is not required.
`edge_cache_ttl`	The edge cache TTL.	`0`, `30`, `60`, `300`, `600`, `1200`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `518400`, `604800`, `1209600`, `2419200`
`email_obfuscation`	The Email obfuscation.	`on`, `off`
`explicit_cache_control`	The origin cache control.	`on`, `off`
`forwarding_url`	The action conflicts with all other settings.	The value is not required.
`host_header_override`	The host header override.	The header value.
`image_load_optimization`	The image load optimization.	`on`, `off`
`image_size_optimization`	The image size optimization.	`on`, `off`
`ip_geolocation`	The IP geography location header.	`on`, `off`
`opportunistic_encryption`	The opportunistic encryption.	`on`, `off`
`origin_error_page_pass_thru`	The origin error page pass-through.	`on`, `off`
`resolve_override`	The resolve override.	The value for resolving URL override.
`response_buffering`	The response buffering.	`on`, `off`
`script_load_optimization`	The script load optimization.	`off`, `lossless`, `lossy`
`ssl`	The TLS settings.	`off`, `flexible`, `full`, `strict`,`origin_pull`
`security_level`	The security level.	`disable_security`, `always_use_https`
`server_side_exclude`	The server side excludes.	`on`, `off`
`server_stale_content`	The server stale content.	`on`, `off`
`sort_query_string_for_cache`	The sort query string.	`on`, `off`
`true_client_ip_header`	The true client IP header.	`on`, `off`
`waf`	The Web Application Firewall.	`on`, `off`
`minify`	The Minify web content	The value is not required

id str

The action ID. Valid values are page rule action field map from console to API CF-UI map API).

css str

The required attribute for minify action. CSS supported values are on and off.

html str

The required attribute for minify action. HTML supported values are on and off.

js str

The required attribute for minify action. JS supported values are on and off.

status_code float

The status code to check for URL forwarding. The required attribute for forwarding_url action. Valid values are 301 and 302. It returns 0 for all other actions.

url str

The forward rule URL, a required attribute for forwarding_url action.

value str

The values for corresponding actions.

NOTE Below table shows corresponding valid values of id and value of actions argument

id	description	valid values
`always_online`	The action conflicts with all other settings.	`on`, `off`
`always_use_https`	The action conflicts with all other settings.	The value is not required.
`automatic_https_rewrites`	The automatic HTTPS rewrites.	`on`, `off`
`browser_cache_ttl`	The browser cache TTL.	`0`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `691200`, `1382400`, `2073600`, `2678400`, `5356800`, `16070400`, `31536000`
`bypass_cache_on_cookie`	The bypass cache on cookie.	cookie tags
`browser_check`	The browser integrity check.	`on`, `off`
`cache_level`	The cache level.	`bypass`, `aggressive`, `basic`, `simplified`, `cache_everything`
`cache_on_cookie`	The cache on cookie.	The cookie value
`cache_deception_armor`	The cache deception armor.	`on`, `off`
`disable_security`	The action conflicts with `email_obfuscation`, `server_side_exclude`, `waf`.	The value is not required.
`disable_apps`	The disable apps.	The value is not required
`disable_performance`	The disable performance.	The value is not required.
`edge_cache_ttl`	The edge cache TTL.	`0`, `30`, `60`, `300`, `600`, `1200`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `518400`, `604800`, `1209600`, `2419200`
`email_obfuscation`	The Email obfuscation.	`on`, `off`
`explicit_cache_control`	The origin cache control.	`on`, `off`
`forwarding_url`	The action conflicts with all other settings.	The value is not required.
`host_header_override`	The host header override.	The header value.
`image_load_optimization`	The image load optimization.	`on`, `off`
`image_size_optimization`	The image size optimization.	`on`, `off`
`ip_geolocation`	The IP geography location header.	`on`, `off`
`opportunistic_encryption`	The opportunistic encryption.	`on`, `off`
`origin_error_page_pass_thru`	The origin error page pass-through.	`on`, `off`
`resolve_override`	The resolve override.	The value for resolving URL override.
`response_buffering`	The response buffering.	`on`, `off`
`script_load_optimization`	The script load optimization.	`off`, `lossless`, `lossy`
`ssl`	The TLS settings.	`off`, `flexible`, `full`, `strict`,`origin_pull`
`security_level`	The security level.	`disable_security`, `always_use_https`
`server_side_exclude`	The server side excludes.	`on`, `off`
`server_stale_content`	The server stale content.	`on`, `off`
`sort_query_string_for_cache`	The sort query string.	`on`, `off`
`true_client_ip_header`	The true client IP header.	`on`, `off`
`waf`	The Web Application Firewall.	`on`, `off`
`minify`	The Minify web content	The value is not required

id String

The action ID. Valid values are page rule action field map from console to API CF-UI map API).

css String

The required attribute for minify action. CSS supported values are on and off.

html String

The required attribute for minify action. HTML supported values are on and off.

js String

The required attribute for minify action. JS supported values are on and off.

statusCode Number

The status code to check for URL forwarding. The required attribute for forwarding_url action. Valid values are 301 and 302. It returns 0 for all other actions.

url String

The forward rule URL, a required attribute for forwarding_url action.

value String

The values for corresponding actions.

NOTE Below table shows corresponding valid values of id and value of actions argument

id	description	valid values
`always_online`	The action conflicts with all other settings.	`on`, `off`
`always_use_https`	The action conflicts with all other settings.	The value is not required.
`automatic_https_rewrites`	The automatic HTTPS rewrites.	`on`, `off`
`browser_cache_ttl`	The browser cache TTL.	`0`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `691200`, `1382400`, `2073600`, `2678400`, `5356800`, `16070400`, `31536000`
`bypass_cache_on_cookie`	The bypass cache on cookie.	cookie tags
`browser_check`	The browser integrity check.	`on`, `off`
`cache_level`	The cache level.	`bypass`, `aggressive`, `basic`, `simplified`, `cache_everything`
`cache_on_cookie`	The cache on cookie.	The cookie value
`cache_deception_armor`	The cache deception armor.	`on`, `off`
`disable_security`	The action conflicts with `email_obfuscation`, `server_side_exclude`, `waf`.	The value is not required.
`disable_apps`	The disable apps.	The value is not required
`disable_performance`	The disable performance.	The value is not required.
`edge_cache_ttl`	The edge cache TTL.	`0`, `30`, `60`, `300`, `600`, `1200`, `1800`, `3600`, `7200`, `10800`, `14400`, `18000`, `28800`, `43200`, `57600`, `72000`, `86400`, `172800`, `259200`, `345600`, `432000`, `518400`, `604800`, `1209600`, `2419200`
`email_obfuscation`	The Email obfuscation.	`on`, `off`
`explicit_cache_control`	The origin cache control.	`on`, `off`
`forwarding_url`	The action conflicts with all other settings.	The value is not required.
`host_header_override`	The host header override.	The header value.
`image_load_optimization`	The image load optimization.	`on`, `off`
`image_size_optimization`	The image size optimization.	`on`, `off`
`ip_geolocation`	The IP geography location header.	`on`, `off`
`opportunistic_encryption`	The opportunistic encryption.	`on`, `off`
`origin_error_page_pass_thru`	The origin error page pass-through.	`on`, `off`
`resolve_override`	The resolve override.	The value for resolving URL override.
`response_buffering`	The response buffering.	`on`, `off`
`script_load_optimization`	The script load optimization.	`off`, `lossless`, `lossy`
`ssl`	The TLS settings.	`off`, `flexible`, `full`, `strict`,`origin_pull`
`security_level`	The security level.	`disable_security`, `always_use_https`
`server_side_exclude`	The server side excludes.	`on`, `off`
`server_stale_content`	The server stale content.	`on`, `off`
`sort_query_string_for_cache`	The sort query string.	`on`, `off`
`true_client_ip_header`	The true client IP header.	`on`, `off`
`waf`	The Web Application Firewall.	`on`, `off`
`minify`	The Minify web content	The value is not required

CisPageRuleTarget, CisPageRuleTargetArgs

Constraint CisPageRuleTargetConstraint

The constraint of the page rule. Maximum item is 1.

Nested scheme for constraint:

Target string

The target type. Valid value is url.

Constraint CisPageRuleTargetConstraint

The constraint of the page rule. Maximum item is 1.

Nested scheme for constraint:

Target string

The target type. Valid value is url.

constraint CisPageRuleTargetConstraint

The constraint of the page rule. Maximum item is 1.

Nested scheme for constraint:

target String

The target type. Valid value is url.

constraint CisPageRuleTargetConstraint

The constraint of the page rule. Maximum item is 1.

Nested scheme for constraint:

target string

The target type. Valid value is url.

constraint CisPageRuleTargetConstraint

The constraint of the page rule. Maximum item is 1.

Nested scheme for constraint:

target str

The target type. Valid value is url.

constraint Property Map

The constraint of the page rule. Maximum item is 1.

Nested scheme for constraint:

target String

The target type. Valid value is url.

CisPageRuleTargetConstraint, CisPageRuleTargetConstraintArgs

Operator string: The operation on the page rule. The valid value is matches.
Value string: The URL value on which page rule is applied.

Operator string: The operation on the page rule. The valid value is matches.
Value string: The URL value on which page rule is applied.

operator String: The operation on the page rule. The valid value is matches.
value String: The URL value on which page rule is applied.

operator string: The operation on the page rule. The valid value is matches.
value string: The URL value on which page rule is applied.

operator str: The operation on the page rule. The valid value is matches.
value str: The URL value on which page rule is applied.

operator String: The operation on the page rule. The valid value is matches.
value String: The URL value on which page rule is applied.

Import

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

The domain ID and CRN is located on the Overview page of the Internet Services instance under the Domain heading of the console, or via the ibmcloud cis CLI.

Domain ID is a 32 digit character string of the form: 9caf68812ae9b3f0377fdf986751a78f.
CRN is a 120 digit character string of the format crn:v1:bluemix:public:internet-svcs:global:a/1aa1111a1a1111aa1a111111111111aa:11aa111a-11a1-1a11-111a-111aaa11a1a1::
Rule ID is a 32 digit character string in the format 489d96f0da6ed76251b475971b097205c.

syntax

$ pulumi import ibm:index/cisPageRule:CisPageRule myorg <rule_id>:<domain-id>:<crn>

Example

$ pulumi import ibm:index/cisPageRule:CisPageRule myorg page_rule 48996f0da6ed76251b475971b097205c:9caf68812ae9b3f0377fdf986751a78f:crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::

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.

Viewing docs for ibm 2.0.0
published on Monday, Mar 30, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

ibm.CisPageRule

On this page

On this page

Example Usage

Create CisPageRule Resource

Constructor syntax

Parameters

Constructor example

CisPageRule Resource Properties

Inputs

Outputs

Look up Existing CisPageRule Resource

Supporting Types

CisPageRuleAction, CisPageRuleActionArgs

CisPageRuleTarget, CisPageRuleTargetArgs

CisPageRuleTargetConstraint, CisPageRuleTargetConstraintArgs

Import

Package Details

On this page

On this page