1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCisCustomPages
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getCisCustomPages

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve information of an existing IBM Cloud Internet Services custom pages resource. 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";
    
    const customPages = ibm.getCisCustomPages({
        cisId: data.ibm_cis.cis.id,
        domainId: data.ibm_cis_domain.cis_domain.domain_id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    custom_pages = ibm.get_cis_custom_pages(cis_id=data["ibm_cis"]["cis"]["id"],
        domain_id=data["ibm_cis_domain"]["cis_domain"]["domain_id"])
    
    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 {
    		_, err := ibm.GetCisCustomPages(ctx, &ibm.GetCisCustomPagesArgs{
    			CisId:    data.Ibm_cis.Cis.Id,
    			DomainId: data.Ibm_cis_domain.Cis_domain.Domain_id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var customPages = Ibm.GetCisCustomPages.Invoke(new()
        {
            CisId = data.Ibm_cis.Cis.Id,
            DomainId = data.Ibm_cis_domain.Cis_domain.Domain_id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetCisCustomPagesArgs;
    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) {
            final var customPages = IbmFunctions.getCisCustomPages(GetCisCustomPagesArgs.builder()
                .cisId(data.ibm_cis().cis().id())
                .domainId(data.ibm_cis_domain().cis_domain().domain_id())
                .build());
    
        }
    }
    
    variables:
      customPages:
        fn::invoke:
          function: ibm:getCisCustomPages
          arguments:
            cisId: ${data.ibm_cis.cis.id}
            domainId: ${data.ibm_cis_domain.cis_domain.domain_id}
    

    Using getCisCustomPages

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCisCustomPages(args: GetCisCustomPagesArgs, opts?: InvokeOptions): Promise<GetCisCustomPagesResult>
    function getCisCustomPagesOutput(args: GetCisCustomPagesOutputArgs, opts?: InvokeOptions): Output<GetCisCustomPagesResult>
    def get_cis_custom_pages(cis_id: Optional[str] = None,
                             domain_id: Optional[str] = None,
                             id: Optional[str] = None,
                             timeouts: Optional[GetCisCustomPagesTimeouts] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCisCustomPagesResult
    def get_cis_custom_pages_output(cis_id: Optional[pulumi.Input[str]] = None,
                             domain_id: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             timeouts: Optional[pulumi.Input[GetCisCustomPagesTimeoutsArgs]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCisCustomPagesResult]
    func GetCisCustomPages(ctx *Context, args *GetCisCustomPagesArgs, opts ...InvokeOption) (*GetCisCustomPagesResult, error)
    func GetCisCustomPagesOutput(ctx *Context, args *GetCisCustomPagesOutputArgs, opts ...InvokeOption) GetCisCustomPagesResultOutput

    > Note: This function is named GetCisCustomPages in the Go SDK.

    public static class GetCisCustomPages 
    {
        public static Task<GetCisCustomPagesResult> InvokeAsync(GetCisCustomPagesArgs args, InvokeOptions? opts = null)
        public static Output<GetCisCustomPagesResult> Invoke(GetCisCustomPagesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCisCustomPagesResult> getCisCustomPages(GetCisCustomPagesArgs args, InvokeOptions options)
    public static Output<GetCisCustomPagesResult> getCisCustomPages(GetCisCustomPagesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getCisCustomPages:getCisCustomPages
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CisId string
    The ID of the CIS service instance.
    DomainId string
    The domain ID to change custom page.
    Id string
    The custom page ID. It is a combination of <page_id>, <domain_id>, <cis_id> attributes concatenated with :.
    Timeouts GetCisCustomPagesTimeouts
    CisId string
    The ID of the CIS service instance.
    DomainId string
    The domain ID to change custom page.
    Id string
    The custom page ID. It is a combination of <page_id>, <domain_id>, <cis_id> attributes concatenated with :.
    Timeouts GetCisCustomPagesTimeouts
    cisId String
    The ID of the CIS service instance.
    domainId String
    The domain ID to change custom page.
    id String
    The custom page ID. It is a combination of <page_id>, <domain_id>, <cis_id> attributes concatenated with :.
    timeouts GetCisCustomPagesTimeouts
    cisId string
    The ID of the CIS service instance.
    domainId string
    The domain ID to change custom page.
    id string
    The custom page ID. It is a combination of <page_id>, <domain_id>, <cis_id> attributes concatenated with :.
    timeouts GetCisCustomPagesTimeouts
    cis_id str
    The ID of the CIS service instance.
    domain_id str
    The domain ID to change custom page.
    id str
    The custom page ID. It is a combination of <page_id>, <domain_id>, <cis_id> attributes concatenated with :.
    timeouts GetCisCustomPagesTimeouts
    cisId String
    The ID of the CIS service instance.
    domainId String
    The domain ID to change custom page.
    id String
    The custom page ID. It is a combination of <page_id>, <domain_id>, <cis_id> attributes concatenated with :.
    timeouts Property Map

    getCisCustomPages Result

    The following output properties are available:

    Supporting Types

    GetCisCustomPagesCisCustomPage

    CreatedOn string
    Created date and time of the custom page.
    Description string
    The description of the custom page.
    ModifiedOn string
    Modified date and time of the custom page.

    • page_id - (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.
    PageId string
    PreviewTarget string
    The target custom page.
    RequiredTokens List<string>
    The custom page required token which is expected from the URL page.
    State 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.
    CreatedOn string
    Created date and time of the custom page.
    Description string
    The description of the custom page.
    ModifiedOn string
    Modified date and time of the custom page.

    • page_id - (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.
    PageId string
    PreviewTarget string
    The target custom page.
    RequiredTokens []string
    The custom page required token which is expected from the URL page.
    State 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.
    createdOn String
    Created date and time of the custom page.
    description String
    The description of the custom page.
    modifiedOn String
    Modified date and time of the custom page.

    • page_id - (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.
    pageId String
    previewTarget String
    The target custom page.
    requiredTokens List<String>
    The custom page required token which is expected from the URL page.
    state 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.
    createdOn string
    Created date and time of the custom page.
    description string
    The description of the custom page.
    modifiedOn string
    Modified date and time of the custom page.

    • page_id - (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.
    pageId string
    previewTarget string
    The target custom page.
    requiredTokens string[]
    The custom page required token which is expected from the URL page.
    state 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.
    created_on str
    Created date and time of the custom page.
    description str
    The description of the custom page.
    modified_on str
    Modified date and time of the custom page.

    • page_id - (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.
    page_id str
    preview_target str
    The target custom page.
    required_tokens Sequence[str]
    The custom page required token which is expected from the URL page.
    state str
    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.
    createdOn String
    Created date and time of the custom page.
    description String
    The description of the custom page.
    modifiedOn String
    Modified date and time of the custom page.

    • page_id - (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.
    pageId String
    previewTarget String
    The target custom page.
    requiredTokens List<String>
    The custom page required token which is expected from the URL page.
    state 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.

    GetCisCustomPagesTimeouts

    Read string
    Read string
    read String
    read string
    read str
    read String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud