1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisCacheSettings
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.CisCacheSettings

Explore with Pulumi AI

Provides an IBM Cloud Internet Services cache settings resource. The resource allows to create, update, or delete cache settings of a domain of an IBM Cloud Internet Services CIS instance. For more information about cache setting, see CIS cache concepts.

Example Usage

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

// Change Cache Settings of the domain
const cacheSettings = new ibm.CisCacheSettings("cacheSettings", {
    cisId: data.ibm_cis.cis.id,
    domainId: data.ibm_cis_domain.cis_domain.domain_id,
    cachingLevel: "aggressive",
    browserExpiration: 14400,
    developmentMode: "off",
    queryStringSort: "off",
    purgeAll: true,
    serveStaleContent: "off",
});
Copy
import pulumi
import pulumi_ibm as ibm

# Change Cache Settings of the domain
cache_settings = ibm.CisCacheSettings("cacheSettings",
    cis_id=data["ibm_cis"]["cis"]["id"],
    domain_id=data["ibm_cis_domain"]["cis_domain"]["domain_id"],
    caching_level="aggressive",
    browser_expiration=14400,
    development_mode="off",
    query_string_sort="off",
    purge_all=True,
    serve_stale_content="off")
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 Cache Settings of the domain
		_, err := ibm.NewCisCacheSettings(ctx, "cacheSettings", &ibm.CisCacheSettingsArgs{
			CisId:             pulumi.Any(data.Ibm_cis.Cis.Id),
			DomainId:          pulumi.Any(data.Ibm_cis_domain.Cis_domain.Domain_id),
			CachingLevel:      pulumi.String("aggressive"),
			BrowserExpiration: pulumi.Float64(14400),
			DevelopmentMode:   pulumi.String("off"),
			QueryStringSort:   pulumi.String("off"),
			PurgeAll:          pulumi.Bool(true),
			ServeStaleContent: pulumi.String("off"),
		})
		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 Cache Settings of the domain
    var cacheSettings = new Ibm.CisCacheSettings("cacheSettings", new()
    {
        CisId = data.Ibm_cis.Cis.Id,
        DomainId = data.Ibm_cis_domain.Cis_domain.Domain_id,
        CachingLevel = "aggressive",
        BrowserExpiration = 14400,
        DevelopmentMode = "off",
        QueryStringSort = "off",
        PurgeAll = true,
        ServeStaleContent = "off",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CisCacheSettings;
import com.pulumi.ibm.CisCacheSettingsArgs;
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 Cache Settings of the domain
        var cacheSettings = new CisCacheSettings("cacheSettings", CisCacheSettingsArgs.builder()
            .cisId(data.ibm_cis().cis().id())
            .domainId(data.ibm_cis_domain().cis_domain().domain_id())
            .cachingLevel("aggressive")
            .browserExpiration(14400)
            .developmentMode("off")
            .queryStringSort("off")
            .purgeAll(true)
            .serveStaleContent("off")
            .build());

    }
}
Copy
resources:
  # Change Cache Settings of the domain
  cacheSettings:
    type: ibm:CisCacheSettings
    properties:
      cisId: ${data.ibm_cis.cis.id}
      domainId: ${data.ibm_cis_domain.cis_domain.domain_id}
      cachingLevel: aggressive
      browserExpiration: 14400
      developmentMode: off
      queryStringSort: off
      purgeAll: true
      serveStaleContent: off
Copy

Create CisCacheSettings Resource

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

Constructor syntax

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

@overload
def CisCacheSettings(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     cis_id: Optional[str] = None,
                     domain_id: Optional[str] = None,
                     browser_expiration: Optional[float] = None,
                     caching_level: Optional[str] = None,
                     cis_cache_settings_id: Optional[str] = None,
                     development_mode: Optional[str] = None,
                     purge_all: Optional[bool] = None,
                     purge_by_hosts: Optional[Sequence[str]] = None,
                     purge_by_tags: Optional[Sequence[str]] = None,
                     purge_by_urls: Optional[Sequence[str]] = None,
                     query_string_sort: Optional[str] = None,
                     serve_stale_content: Optional[str] = None)
func NewCisCacheSettings(ctx *Context, name string, args CisCacheSettingsArgs, opts ...ResourceOption) (*CisCacheSettings, error)
public CisCacheSettings(string name, CisCacheSettingsArgs args, CustomResourceOptions? opts = null)
public CisCacheSettings(String name, CisCacheSettingsArgs args)
public CisCacheSettings(String name, CisCacheSettingsArgs args, CustomResourceOptions options)
type: ibm:CisCacheSettings
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. CisCacheSettingsArgs
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. CisCacheSettingsArgs
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. CisCacheSettingsArgs
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. CisCacheSettingsArgs
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. CisCacheSettingsArgs
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 cisCacheSettingsResource = new Ibm.CisCacheSettings("cisCacheSettingsResource", new()
{
    CisId = "string",
    DomainId = "string",
    BrowserExpiration = 0,
    CachingLevel = "string",
    CisCacheSettingsId = "string",
    DevelopmentMode = "string",
    PurgeAll = false,
    PurgeByHosts = new[]
    {
        "string",
    },
    PurgeByTags = new[]
    {
        "string",
    },
    PurgeByUrls = new[]
    {
        "string",
    },
    QueryStringSort = "string",
    ServeStaleContent = "string",
});
Copy
example, err := ibm.NewCisCacheSettings(ctx, "cisCacheSettingsResource", &ibm.CisCacheSettingsArgs{
CisId: pulumi.String("string"),
DomainId: pulumi.String("string"),
BrowserExpiration: pulumi.Float64(0),
CachingLevel: pulumi.String("string"),
CisCacheSettingsId: pulumi.String("string"),
DevelopmentMode: pulumi.String("string"),
PurgeAll: pulumi.Bool(false),
PurgeByHosts: pulumi.StringArray{
pulumi.String("string"),
},
PurgeByTags: pulumi.StringArray{
pulumi.String("string"),
},
PurgeByUrls: pulumi.StringArray{
pulumi.String("string"),
},
QueryStringSort: pulumi.String("string"),
ServeStaleContent: pulumi.String("string"),
})
Copy
var cisCacheSettingsResource = new CisCacheSettings("cisCacheSettingsResource", CisCacheSettingsArgs.builder()
    .cisId("string")
    .domainId("string")
    .browserExpiration(0)
    .cachingLevel("string")
    .cisCacheSettingsId("string")
    .developmentMode("string")
    .purgeAll(false)
    .purgeByHosts("string")
    .purgeByTags("string")
    .purgeByUrls("string")
    .queryStringSort("string")
    .serveStaleContent("string")
    .build());
Copy
cis_cache_settings_resource = ibm.CisCacheSettings("cisCacheSettingsResource",
    cis_id="string",
    domain_id="string",
    browser_expiration=0,
    caching_level="string",
    cis_cache_settings_id="string",
    development_mode="string",
    purge_all=False,
    purge_by_hosts=["string"],
    purge_by_tags=["string"],
    purge_by_urls=["string"],
    query_string_sort="string",
    serve_stale_content="string")
Copy
const cisCacheSettingsResource = new ibm.CisCacheSettings("cisCacheSettingsResource", {
    cisId: "string",
    domainId: "string",
    browserExpiration: 0,
    cachingLevel: "string",
    cisCacheSettingsId: "string",
    developmentMode: "string",
    purgeAll: false,
    purgeByHosts: ["string"],
    purgeByTags: ["string"],
    purgeByUrls: ["string"],
    queryStringSort: "string",
    serveStaleContent: "string",
});
Copy
type: ibm:CisCacheSettings
properties:
    browserExpiration: 0
    cachingLevel: string
    cisCacheSettingsId: string
    cisId: string
    developmentMode: string
    domainId: string
    purgeAll: false
    purgeByHosts:
        - string
    purgeByTags:
        - string
    purgeByUrls:
        - string
    queryStringSort: string
    serveStaleContent: string
Copy

CisCacheSettings 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 CisCacheSettings 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 cache settings.
BrowserExpiration double
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
CachingLevel string
The cache level settings. Valid values are basic, simplified, aggressive.
CisCacheSettingsId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
DevelopmentMode string
The development mode enable or disable settings. Valid values are on, and off.
PurgeAll bool
Purge all cached files.
PurgeByHosts List<string>
Purge cached hosts.
PurgeByTags List<string>
Purge cached item that matches the tags.
PurgeByUrls List<string>
Purge cached URLs.
QueryStringSort string
The query string sort settings. Valid values are on, and off.
ServeStaleContent string

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

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 cache settings.
BrowserExpiration float64
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
CachingLevel string
The cache level settings. Valid values are basic, simplified, aggressive.
CisCacheSettingsId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
DevelopmentMode string
The development mode enable or disable settings. Valid values are on, and off.
PurgeAll bool
Purge all cached files.
PurgeByHosts []string
Purge cached hosts.
PurgeByTags []string
Purge cached item that matches the tags.
PurgeByUrls []string
Purge cached URLs.
QueryStringSort string
The query string sort settings. Valid values are on, and off.
ServeStaleContent string

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

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 cache settings.
browserExpiration Double
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
cachingLevel String
The cache level settings. Valid values are basic, simplified, aggressive.
cisCacheSettingsId String
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
developmentMode String
The development mode enable or disable settings. Valid values are on, and off.
purgeAll Boolean
Purge all cached files.
purgeByHosts List<String>
Purge cached hosts.
purgeByTags List<String>
Purge cached item that matches the tags.
purgeByUrls List<String>
Purge cached URLs.
queryStringSort String
The query string sort settings. Valid values are on, and off.
serveStaleContent String

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

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 cache settings.
browserExpiration number
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
cachingLevel string
The cache level settings. Valid values are basic, simplified, aggressive.
cisCacheSettingsId string
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
developmentMode string
The development mode enable or disable settings. Valid values are on, and off.
purgeAll boolean
Purge all cached files.
purgeByHosts string[]
Purge cached hosts.
purgeByTags string[]
Purge cached item that matches the tags.
purgeByUrls string[]
Purge cached URLs.
queryStringSort string
The query string sort settings. Valid values are on, and off.
serveStaleContent string

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

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 cache settings.
browser_expiration float
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
caching_level str
The cache level settings. Valid values are basic, simplified, aggressive.
cis_cache_settings_id str
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
development_mode str
The development mode enable or disable settings. Valid values are on, and off.
purge_all bool
Purge all cached files.
purge_by_hosts Sequence[str]
Purge cached hosts.
purge_by_tags Sequence[str]
Purge cached item that matches the tags.
purge_by_urls Sequence[str]
Purge cached URLs.
query_string_sort str
The query string sort settings. Valid values are on, and off.
serve_stale_content str

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

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 cache settings.
browserExpiration Number
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
cachingLevel String
The cache level settings. Valid values are basic, simplified, aggressive.
cisCacheSettingsId String
(String) The record ID. It is a combination of <domain_id>,<cis_id> attributes concatenated with :.
developmentMode String
The development mode enable or disable settings. Valid values are on, and off.
purgeAll Boolean
Purge all cached files.
purgeByHosts List<String>
Purge cached hosts.
purgeByTags List<String>
Purge cached item that matches the tags.
purgeByUrls List<String>
Purge cached URLs.
queryStringSort String
The query string sort settings. Valid values are on, and off.
serveStaleContent String

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the CisCacheSettings 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 CisCacheSettings Resource

Get an existing CisCacheSettings 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?: CisCacheSettingsState, opts?: CustomResourceOptions): CisCacheSettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        browser_expiration: Optional[float] = None,
        caching_level: Optional[str] = None,
        cis_cache_settings_id: Optional[str] = None,
        cis_id: Optional[str] = None,
        development_mode: Optional[str] = None,
        domain_id: Optional[str] = None,
        purge_all: Optional[bool] = None,
        purge_by_hosts: Optional[Sequence[str]] = None,
        purge_by_tags: Optional[Sequence[str]] = None,
        purge_by_urls: Optional[Sequence[str]] = None,
        query_string_sort: Optional[str] = None,
        serve_stale_content: Optional[str] = None) -> CisCacheSettings
func GetCisCacheSettings(ctx *Context, name string, id IDInput, state *CisCacheSettingsState, opts ...ResourceOption) (*CisCacheSettings, error)
public static CisCacheSettings Get(string name, Input<string> id, CisCacheSettingsState? state, CustomResourceOptions? opts = null)
public static CisCacheSettings get(String name, Output<String> id, CisCacheSettingsState state, CustomResourceOptions options)
resources:  _:    type: ibm:CisCacheSettings    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:
BrowserExpiration double
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
CachingLevel string
The cache level settings. Valid values are basic, simplified, aggressive.
CisCacheSettingsId 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.
DevelopmentMode string
The development mode enable or disable settings. Valid values are on, and off.
DomainId string
The ID of the domain to change cache settings.
PurgeAll bool
Purge all cached files.
PurgeByHosts List<string>
Purge cached hosts.
PurgeByTags List<string>
Purge cached item that matches the tags.
PurgeByUrls List<string>
Purge cached URLs.
QueryStringSort string
The query string sort settings. Valid values are on, and off.
ServeStaleContent string

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

BrowserExpiration float64
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
CachingLevel string
The cache level settings. Valid values are basic, simplified, aggressive.
CisCacheSettingsId 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.
DevelopmentMode string
The development mode enable or disable settings. Valid values are on, and off.
DomainId string
The ID of the domain to change cache settings.
PurgeAll bool
Purge all cached files.
PurgeByHosts []string
Purge cached hosts.
PurgeByTags []string
Purge cached item that matches the tags.
PurgeByUrls []string
Purge cached URLs.
QueryStringSort string
The query string sort settings. Valid values are on, and off.
ServeStaleContent string

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

browserExpiration Double
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
cachingLevel String
The cache level settings. Valid values are basic, simplified, aggressive.
cisCacheSettingsId 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.
developmentMode String
The development mode enable or disable settings. Valid values are on, and off.
domainId String
The ID of the domain to change cache settings.
purgeAll Boolean
Purge all cached files.
purgeByHosts List<String>
Purge cached hosts.
purgeByTags List<String>
Purge cached item that matches the tags.
purgeByUrls List<String>
Purge cached URLs.
queryStringSort String
The query string sort settings. Valid values are on, and off.
serveStaleContent String

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

browserExpiration number
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
cachingLevel string
The cache level settings. Valid values are basic, simplified, aggressive.
cisCacheSettingsId 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.
developmentMode string
The development mode enable or disable settings. Valid values are on, and off.
domainId string
The ID of the domain to change cache settings.
purgeAll boolean
Purge all cached files.
purgeByHosts string[]
Purge cached hosts.
purgeByTags string[]
Purge cached item that matches the tags.
purgeByUrls string[]
Purge cached URLs.
queryStringSort string
The query string sort settings. Valid values are on, and off.
serveStaleContent string

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

browser_expiration float
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
caching_level str
The cache level settings. Valid values are basic, simplified, aggressive.
cis_cache_settings_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.
development_mode str
The development mode enable or disable settings. Valid values are on, and off.
domain_id str
The ID of the domain to change cache settings.
purge_all bool
Purge all cached files.
purge_by_hosts Sequence[str]
Purge cached hosts.
purge_by_tags Sequence[str]
Purge cached item that matches the tags.
purge_by_urls Sequence[str]
Purge cached URLs.
query_string_sort str
The query string sort settings. Valid values are on, and off.
serve_stale_content str

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

browserExpiration Number
The Browser expiration settings. Valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000.
cachingLevel String
The cache level settings. Valid values are basic, simplified, aggressive.
cisCacheSettingsId 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.
developmentMode String
The development mode enable or disable settings. Valid values are on, and off.
domainId String
The ID of the domain to change cache settings.
purgeAll Boolean
Purge all cached files.
purgeByHosts List<String>
Purge cached hosts.
purgeByTags List<String>
Purge cached item that matches the tags.
purgeByUrls List<String>
Purge cached URLs.
queryStringSort String
The query string sort settings. Valid values are on, and off.
serveStaleContent String

Enable (on) or disable (off) the serve stale content setting.

Note

Among all the purge actions purge_all, purge_by-urls, purge_by_hosts, and purge_by_tags, only one is allowed to give inside a resource.

Import

The ibm_cis_cache_settings resource can be imported using the ID. The ID is formed from the 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.

  • 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/cisCacheSettings:CisCacheSettings cache_settings <domain-id>:<crn>
Copy

Example

$ pulumi import ibm:index/cisCacheSettings:CisCacheSettings cache_settings 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.