1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCisFirewall
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getCisFirewall

Start a Neo task
Explain and create an ibm.getCisFirewall resource
ibm logo
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Using getCisFirewall

    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 getCisFirewall(args: GetCisFirewallArgs, opts?: InvokeOptions): Promise<GetCisFirewallResult>
function getCisFirewallOutput(args: GetCisFirewallOutputArgs, opts?: InvokeOptions): Output<GetCisFirewallResult>
    def get_cis_firewall(cis_id: Optional[str] = None,
                     domain_id: Optional[str] = None,
                     firewall_type: Optional[str] = None,
                     id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCisFirewallResult
def get_cis_firewall_output(cis_id: Optional[pulumi.Input[str]] = None,
                     domain_id: Optional[pulumi.Input[str]] = None,
                     firewall_type: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCisFirewallResult]
    func LookupCisFirewall(ctx *Context, args *LookupCisFirewallArgs, opts ...InvokeOption) (*LookupCisFirewallResult, error)
func LookupCisFirewallOutput(ctx *Context, args *LookupCisFirewallOutputArgs, opts ...InvokeOption) LookupCisFirewallResultOutput

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

    public static class GetCisFirewall 
{
    public static Task<GetCisFirewallResult> InvokeAsync(GetCisFirewallArgs args, InvokeOptions? opts = null)
    public static Output<GetCisFirewallResult> Invoke(GetCisFirewallInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCisFirewallResult> getCisFirewall(GetCisFirewallArgs args, InvokeOptions options)
public static Output<GetCisFirewallResult> getCisFirewall(GetCisFirewallArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getCisFirewall:getCisFirewall
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CisId string
    The ID of the IBM Cloud Internet Services instance where you want to create the firewall.
    DomainId string
    The ID of the domain where you want to add the lock down.
    FirewallType string
    The type of firewall that you want to create for your domain. Supported values are lockdowns, access_rules, and ua_rules. Note Consider the following information when choosing your firewall type: access_rules: Access rules allow, challenge, or block requests to your website. You can apply access rules to one domain only or all domains in the same service instance.lockdowns: Allow access to your domain for specific IP addresses or IP address ranges only. If you choose this firewall type, you must define your firewall rules in the lockdown input parameter.ua_rules: Apply firewall rules only if the user agent that is used by the client matches the user agent that you defined. .
    Id string
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    CisId string
    The ID of the IBM Cloud Internet Services instance where you want to create the firewall.
    DomainId string
    The ID of the domain where you want to add the lock down.
    FirewallType string
    The type of firewall that you want to create for your domain. Supported values are lockdowns, access_rules, and ua_rules. Note Consider the following information when choosing your firewall type: access_rules: Access rules allow, challenge, or block requests to your website. You can apply access rules to one domain only or all domains in the same service instance.lockdowns: Allow access to your domain for specific IP addresses or IP address ranges only. If you choose this firewall type, you must define your firewall rules in the lockdown input parameter.ua_rules: Apply firewall rules only if the user agent that is used by the client matches the user agent that you defined. .
    Id string
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    cisId String
    The ID of the IBM Cloud Internet Services instance where you want to create the firewall.
    domainId String
    The ID of the domain where you want to add the lock down.
    firewallType String
    The type of firewall that you want to create for your domain. Supported values are lockdowns, access_rules, and ua_rules. Note Consider the following information when choosing your firewall type: access_rules: Access rules allow, challenge, or block requests to your website. You can apply access rules to one domain only or all domains in the same service instance.lockdowns: Allow access to your domain for specific IP addresses or IP address ranges only. If you choose this firewall type, you must define your firewall rules in the lockdown input parameter.ua_rules: Apply firewall rules only if the user agent that is used by the client matches the user agent that you defined. .
    id String
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    cisId string
    The ID of the IBM Cloud Internet Services instance where you want to create the firewall.
    domainId string
    The ID of the domain where you want to add the lock down.
    firewallType string
    The type of firewall that you want to create for your domain. Supported values are lockdowns, access_rules, and ua_rules. Note Consider the following information when choosing your firewall type: access_rules: Access rules allow, challenge, or block requests to your website. You can apply access rules to one domain only or all domains in the same service instance.lockdowns: Allow access to your domain for specific IP addresses or IP address ranges only. If you choose this firewall type, you must define your firewall rules in the lockdown input parameter.ua_rules: Apply firewall rules only if the user agent that is used by the client matches the user agent that you defined. .
    id string
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    cis_id str
    The ID of the IBM Cloud Internet Services instance where you want to create the firewall.
    domain_id str
    The ID of the domain where you want to add the lock down.
    firewall_type str
    The type of firewall that you want to create for your domain. Supported values are lockdowns, access_rules, and ua_rules. Note Consider the following information when choosing your firewall type: access_rules: Access rules allow, challenge, or block requests to your website. You can apply access rules to one domain only or all domains in the same service instance.lockdowns: Allow access to your domain for specific IP addresses or IP address ranges only. If you choose this firewall type, you must define your firewall rules in the lockdown input parameter.ua_rules: Apply firewall rules only if the user agent that is used by the client matches the user agent that you defined. .
    id str
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    cisId String
    The ID of the IBM Cloud Internet Services instance where you want to create the firewall.
    domainId String
    The ID of the domain where you want to add the lock down.
    firewallType String
    The type of firewall that you want to create for your domain. Supported values are lockdowns, access_rules, and ua_rules. Note Consider the following information when choosing your firewall type: access_rules: Access rules allow, challenge, or block requests to your website. You can apply access rules to one domain only or all domains in the same service instance.lockdowns: Allow access to your domain for specific IP addresses or IP address ranges only. If you choose this firewall type, you must define your firewall rules in the lockdown input parameter.ua_rules: Apply firewall rules only if the user agent that is used by the client matches the user agent that you defined. .
    id String
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.

    getCisFirewall Result

    The following output properties are available:

    AccessRules List<GetCisFirewallAccessRule>
    (String) Create the data describing the access rule.
    CisId string
    DomainId string
    FirewallType string
    Id string
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    Lockdowns List<GetCisFirewallLockdown>
    (List) List of lock down to be created. The data describing a lock down rule.
    UaRules List<GetCisFirewallUaRule>
    (String) Create the data describing the user agent rule.
    AccessRules []GetCisFirewallAccessRule
    (String) Create the data describing the access rule.
    CisId string
    DomainId string
    FirewallType string
    Id string
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    Lockdowns []GetCisFirewallLockdown
    (List) List of lock down to be created. The data describing a lock down rule.
    UaRules []GetCisFirewallUaRule
    (String) Create the data describing the user agent rule.
    accessRules List<GetCisFirewallAccessRule>
    (String) Create the data describing the access rule.
    cisId String
    domainId String
    firewallType String
    id String
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    lockdowns List<GetCisFirewallLockdown>
    (List) List of lock down to be created. The data describing a lock down rule.
    uaRules List<GetCisFirewallUaRule>
    (String) Create the data describing the user agent rule.
    accessRules GetCisFirewallAccessRule[]
    (String) Create the data describing the access rule.
    cisId string
    domainId string
    firewallType string
    id string
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    lockdowns GetCisFirewallLockdown[]
    (List) List of lock down to be created. The data describing a lock down rule.
    uaRules GetCisFirewallUaRule[]
    (String) Create the data describing the user agent rule.
    access_rules Sequence[GetCisFirewallAccessRule]
    (String) Create the data describing the access rule.
    cis_id str
    domain_id str
    firewall_type str
    id str
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    lockdowns Sequence[GetCisFirewallLockdown]
    (List) List of lock down to be created. The data describing a lock down rule.
    ua_rules Sequence[GetCisFirewallUaRule]
    (String) Create the data describing the user agent rule.
    accessRules List<Property Map>
    (String) Create the data describing the access rule.
    cisId String
    domainId String
    firewallType String
    id String
    (String) The ID of the record. The ID is composed of <firewall_type>,<lockdown_id/access_rule_id/ua_rule_id>,<domain_ID>,<cis_crn>. Attributes are concatenated with :.
    lockdowns List<Property Map>
    (List) List of lock down to be created. The data describing a lock down rule.
    uaRules List<Property Map>
    (String) Create the data describing the user agent rule.

    Supporting Types

    GetCisFirewallAccessRule

    AccessRuleId string
    (String) The access rule ID.
    Configurations List<GetCisFirewallAccessRuleConfiguration>
    (List) The Configuration of firewall.
    Mode string
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    Notes string
    (String) The free text for notes.
    AccessRuleId string
    (String) The access rule ID.
    Configurations []GetCisFirewallAccessRuleConfiguration
    (List) The Configuration of firewall.
    Mode string
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    Notes string
    (String) The free text for notes.
    accessRuleId String
    (String) The access rule ID.
    configurations List<GetCisFirewallAccessRuleConfiguration>
    (List) The Configuration of firewall.
    mode String
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    notes String
    (String) The free text for notes.
    accessRuleId string
    (String) The access rule ID.
    configurations GetCisFirewallAccessRuleConfiguration[]
    (List) The Configuration of firewall.
    mode string
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    notes string
    (String) The free text for notes.
    access_rule_id str
    (String) The access rule ID.
    configurations Sequence[GetCisFirewallAccessRuleConfiguration]
    (List) The Configuration of firewall.
    mode str
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    notes str
    (String) The free text for notes.
    accessRuleId String
    (String) The access rule ID.
    configurations List<Property Map>
    (List) The Configuration of firewall.
    mode String
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    notes String
    (String) The free text for notes.

    GetCisFirewallAccessRuleConfiguration

    Target string
    (String) The request property to target. Valid values are ua.
    Value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    Target string
    (String) The request property to target. Valid values are ua.
    Value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target String
    (String) The request property to target. Valid values are ua.
    value String
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target string
    (String) The request property to target. Valid values are ua.
    value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target str
    (String) The request property to target. Valid values are ua.
    value str
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target String
    (String) The request property to target. Valid values are ua.
    value String
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.

    GetCisFirewallLockdown

    Configurations List<GetCisFirewallLockdownConfiguration>
    (List) A list of IP address or CIDR ranges that you want to allow access to the URLs that you defined in lockdown.urls.
    Description string
    (String) A description for your firewall rule.
    LockdownId string
    (String) The lock down ID.
    Paused bool
    (String) Whether the rule is currently disabled.
    Priority double
    (Integer) The priority of the firewall rule. A low number is associated with a high priority.
    Urls List<string>
    List of URLs-A list of URLs that you want to include in your firewall rule. You can specify wildcard URLs. The URL pattern is escaped before use.
    Configurations []GetCisFirewallLockdownConfiguration
    (List) A list of IP address or CIDR ranges that you want to allow access to the URLs that you defined in lockdown.urls.
    Description string
    (String) A description for your firewall rule.
    LockdownId string
    (String) The lock down ID.
    Paused bool
    (String) Whether the rule is currently disabled.
    Priority float64
    (Integer) The priority of the firewall rule. A low number is associated with a high priority.
    Urls []string
    List of URLs-A list of URLs that you want to include in your firewall rule. You can specify wildcard URLs. The URL pattern is escaped before use.
    configurations List<GetCisFirewallLockdownConfiguration>
    (List) A list of IP address or CIDR ranges that you want to allow access to the URLs that you defined in lockdown.urls.
    description String
    (String) A description for your firewall rule.
    lockdownId String
    (String) The lock down ID.
    paused Boolean
    (String) Whether the rule is currently disabled.
    priority Double
    (Integer) The priority of the firewall rule. A low number is associated with a high priority.
    urls List<String>
    List of URLs-A list of URLs that you want to include in your firewall rule. You can specify wildcard URLs. The URL pattern is escaped before use.
    configurations GetCisFirewallLockdownConfiguration[]
    (List) A list of IP address or CIDR ranges that you want to allow access to the URLs that you defined in lockdown.urls.
    description string
    (String) A description for your firewall rule.
    lockdownId string
    (String) The lock down ID.
    paused boolean
    (String) Whether the rule is currently disabled.
    priority number
    (Integer) The priority of the firewall rule. A low number is associated with a high priority.
    urls string[]
    List of URLs-A list of URLs that you want to include in your firewall rule. You can specify wildcard URLs. The URL pattern is escaped before use.
    configurations Sequence[GetCisFirewallLockdownConfiguration]
    (List) A list of IP address or CIDR ranges that you want to allow access to the URLs that you defined in lockdown.urls.
    description str
    (String) A description for your firewall rule.
    lockdown_id str
    (String) The lock down ID.
    paused bool
    (String) Whether the rule is currently disabled.
    priority float
    (Integer) The priority of the firewall rule. A low number is associated with a high priority.
    urls Sequence[str]
    List of URLs-A list of URLs that you want to include in your firewall rule. You can specify wildcard URLs. The URL pattern is escaped before use.
    configurations List<Property Map>
    (List) A list of IP address or CIDR ranges that you want to allow access to the URLs that you defined in lockdown.urls.
    description String
    (String) A description for your firewall rule.
    lockdownId String
    (String) The lock down ID.
    paused Boolean
    (String) Whether the rule is currently disabled.
    priority Number
    (Integer) The priority of the firewall rule. A low number is associated with a high priority.
    urls List<String>
    List of URLs-A list of URLs that you want to include in your firewall rule. You can specify wildcard URLs. The URL pattern is escaped before use.

    GetCisFirewallLockdownConfiguration

    Target string
    (String) The request property to target. Valid values are ua.
    Value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    Target string
    (String) The request property to target. Valid values are ua.
    Value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target String
    (String) The request property to target. Valid values are ua.
    value String
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target string
    (String) The request property to target. Valid values are ua.
    value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target str
    (String) The request property to target. Valid values are ua.
    value str
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target String
    (String) The request property to target. Valid values are ua.
    value String
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.

    GetCisFirewallUaRule

    Configurations List<GetCisFirewallUaRuleConfiguration>
    (List) The Configuration of firewall.
    Description string
    (String) A description for your firewall rule.
    Mode string
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    Paused bool
    (String) Whether the rule is currently disabled.
    UaRuleId string
    (String) The user agent rule ID.
    Configurations []GetCisFirewallUaRuleConfiguration
    (List) The Configuration of firewall.
    Description string
    (String) A description for your firewall rule.
    Mode string
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    Paused bool
    (String) Whether the rule is currently disabled.
    UaRuleId string
    (String) The user agent rule ID.
    configurations List<GetCisFirewallUaRuleConfiguration>
    (List) The Configuration of firewall.
    description String
    (String) A description for your firewall rule.
    mode String
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    paused Boolean
    (String) Whether the rule is currently disabled.
    uaRuleId String
    (String) The user agent rule ID.
    configurations GetCisFirewallUaRuleConfiguration[]
    (List) The Configuration of firewall.
    description string
    (String) A description for your firewall rule.
    mode string
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    paused boolean
    (String) Whether the rule is currently disabled.
    uaRuleId string
    (String) The user agent rule ID.
    configurations Sequence[GetCisFirewallUaRuleConfiguration]
    (List) The Configuration of firewall.
    description str
    (String) A description for your firewall rule.
    mode str
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    paused bool
    (String) Whether the rule is currently disabled.
    ua_rule_id str
    (String) The user agent rule ID.
    configurations List<Property Map>
    (List) The Configuration of firewall.
    description String
    (String) A description for your firewall rule.
    mode String
    (String) The mode of access rule. The valid modes are block, challenge, js_challenge.
    paused Boolean
    (String) Whether the rule is currently disabled.
    uaRuleId String
    (String) The user agent rule ID.

    GetCisFirewallUaRuleConfiguration

    Target string
    (String) The request property to target. Valid values are ua.
    Value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    Target string
    (String) The request property to target. Valid values are ua.
    Value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target String
    (String) The request property to target. Valid values are ua.
    value String
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target string
    (String) The request property to target. Valid values are ua.
    value string
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target str
    (String) The request property to target. Valid values are ua.
    value str
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.
    target String
    (String) The request property to target. Valid values are ua.
    value String
    (String) The exact User Agent string to match the rule.

    • description - (String) The free text for description.

    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.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm
      Meet Neo: Your AI Platform Teammate