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

ibm.Cis

Explore with Pulumi AI

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
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.GetResourceGroupArgs;
import com.pulumi.ibm.Cis;
import com.pulumi.ibm.CisArgs;
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 group = IbmFunctions.getResourceGroup(GetResourceGroupArgs.builder()
            .name("test")
            .build());

        var cisInstance = new Cis("cisInstance", CisArgs.builder()
            .plan("standard-next")
            .resourceGroupId(group.applyValue(getResourceGroupResult -> getResourceGroupResult.id()))
            .tags(            
                "tag1",
                "tag2")
            .location("global")
            .timeouts(CisTimeoutsArgs.builder()
                .create("15m")
                .update("15m")
                .delete("15m")
                .build())
            .build());

    }
}
Copy
resources:
  cisInstance:
    type: ibm:Cis
    properties:
      plan: standard-next
      resourceGroupId: ${group.id}
      tags:
        - tag1
        - tag2
      location: global
      # User can increase timeouts
      timeouts:
        - create: 15m
          update: 15m
          delete: 15m
variables:
  group:
    fn::invoke:
      function: ibm:getResourceGroup
      arguments:
        name: test
Copy

Create Cis Resource

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

Constructor syntax

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

@overload
def Cis(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        plan: Optional[str] = None,
        cis_id: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        resource_group_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[CisTimeoutsArgs] = None)
func NewCis(ctx *Context, name string, args CisArgs, opts ...ResourceOption) (*Cis, error)
public Cis(string name, CisArgs args, CustomResourceOptions? opts = null)
public Cis(String name, CisArgs args)
public Cis(String name, CisArgs args, CustomResourceOptions options)
type: ibm:Cis
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. CisArgs
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. CisArgs
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. CisArgs
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. CisArgs
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. CisArgs
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 cisResource = new Ibm.Cis("cisResource", new()
{
    Location = "string",
    Plan = "string",
    CisId = "string",
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    ResourceGroupId = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.CisTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewCis(ctx, "cisResource", &ibm.CisArgs{
Location: pulumi.String("string"),
Plan: pulumi.String("string"),
CisId: pulumi.String("string"),
Name: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
ResourceGroupId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.CisTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var cisResource = new Cis("cisResource", CisArgs.builder()
    .location("string")
    .plan("string")
    .cisId("string")
    .name("string")
    .parameters(Map.of("string", "string"))
    .resourceGroupId("string")
    .tags("string")
    .timeouts(CisTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
cis_resource = ibm.Cis("cisResource",
    location="string",
    plan="string",
    cis_id="string",
    name="string",
    parameters={
        "string": "string",
    },
    resource_group_id="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const cisResource = new ibm.Cis("cisResource", {
    location: "string",
    plan: "string",
    cisId: "string",
    name: "string",
    parameters: {
        string: "string",
    },
    resourceGroupId: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ibm:Cis
properties:
    cisId: string
    location: string
    name: string
    parameters:
        string: string
    plan: string
    resourceGroupId: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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

Location This property is required. string
The target location where you want to create your instance.
Plan This property is required. string
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
CisId string
(String) The CRN of the CIS instance.
Name string
A descriptive name for your IBM Cloud Internet Services instance.
Parameters Dictionary<string, string>
Arbitrary parameters to create instance. The value must be a JSON object.
ResourceGroupId string
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
Tags List<string>
A list of tags that you want to associate with the instance.
Timeouts CisTimeouts
Location This property is required. string
The target location where you want to create your instance.
Plan This property is required. string
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
CisId string
(String) The CRN of the CIS instance.
Name string
A descriptive name for your IBM Cloud Internet Services instance.
Parameters map[string]string
Arbitrary parameters to create instance. The value must be a JSON object.
ResourceGroupId string
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
Tags []string
A list of tags that you want to associate with the instance.
Timeouts CisTimeoutsArgs
location This property is required. String
The target location where you want to create your instance.
plan This property is required. String
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
cisId String
(String) The CRN of the CIS instance.
name String
A descriptive name for your IBM Cloud Internet Services instance.
parameters Map<String,String>
Arbitrary parameters to create instance. The value must be a JSON object.
resourceGroupId String
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
tags List<String>
A list of tags that you want to associate with the instance.
timeouts CisTimeouts
location This property is required. string
The target location where you want to create your instance.
plan This property is required. string
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
cisId string
(String) The CRN of the CIS instance.
name string
A descriptive name for your IBM Cloud Internet Services instance.
parameters {[key: string]: string}
Arbitrary parameters to create instance. The value must be a JSON object.
resourceGroupId string
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
tags string[]
A list of tags that you want to associate with the instance.
timeouts CisTimeouts
location This property is required. str
The target location where you want to create your instance.
plan This property is required. str
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
cis_id str
(String) The CRN of the CIS instance.
name str
A descriptive name for your IBM Cloud Internet Services instance.
parameters Mapping[str, str]
Arbitrary parameters to create instance. The value must be a JSON object.
resource_group_id str
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
tags Sequence[str]
A list of tags that you want to associate with the instance.
timeouts CisTimeoutsArgs
location This property is required. String
The target location where you want to create your instance.
plan This property is required. String
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
cisId String
(String) The CRN of the CIS instance.
name String
A descriptive name for your IBM Cloud Internet Services instance.
parameters Map<String>
Arbitrary parameters to create instance. The value must be a JSON object.
resourceGroupId String
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
tags List<String>
A list of tags that you want to associate with the instance.
timeouts Property Map

Outputs

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

Guid string
(String) The unique identifier of the CIS instance.
Id string
The provider-assigned unique ID for this managed resource.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Service string
(String) The service type of the instance.
Status string
(String) The status of the CIS instance.
Guid string
(String) The unique identifier of the CIS instance.
Id string
The provider-assigned unique ID for this managed resource.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Service string
(String) The service type of the instance.
Status string
(String) The status of the CIS instance.
guid String
(String) The unique identifier of the CIS instance.
id String
The provider-assigned unique ID for this managed resource.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
service String
(String) The service type of the instance.
status String
(String) The status of the CIS instance.
guid string
(String) The unique identifier of the CIS instance.
id string
The provider-assigned unique ID for this managed resource.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resourceCrn string
The crn of the resource
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
service string
(String) The service type of the instance.
status string
(String) The status of the CIS instance.
guid str
(String) The unique identifier of the CIS instance.
id str
The provider-assigned unique ID for this managed resource.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resource_crn str
The crn of the resource
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
service str
(String) The service type of the instance.
status str
(String) The status of the CIS instance.
guid String
(String) The unique identifier of the CIS instance.
id String
The provider-assigned unique ID for this managed resource.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
service String
(String) The service type of the instance.
status String
(String) The status of the CIS instance.

Look up Existing Cis Resource

Get an existing Cis 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?: CisState, opts?: CustomResourceOptions): Cis
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cis_id: Optional[str] = None,
        guid: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        plan: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        service: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[CisTimeoutsArgs] = None) -> Cis
func GetCis(ctx *Context, name string, id IDInput, state *CisState, opts ...ResourceOption) (*Cis, error)
public static Cis Get(string name, Input<string> id, CisState? state, CustomResourceOptions? opts = null)
public static Cis get(String name, Output<String> id, CisState state, CustomResourceOptions options)
resources:  _:    type: ibm:Cis    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:
CisId string
(String) The CRN of the CIS instance.
Guid string
(String) The unique identifier of the CIS instance.
Location string
The target location where you want to create your instance.
Name string
A descriptive name for your IBM Cloud Internet Services instance.
Parameters Dictionary<string, string>
Arbitrary parameters to create instance. The value must be a JSON object.
Plan string
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
ResourceCrn string
The crn of the resource
ResourceGroupId string
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Service string
(String) The service type of the instance.
Status string
(String) The status of the CIS instance.
Tags List<string>
A list of tags that you want to associate with the instance.
Timeouts CisTimeouts
CisId string
(String) The CRN of the CIS instance.
Guid string
(String) The unique identifier of the CIS instance.
Location string
The target location where you want to create your instance.
Name string
A descriptive name for your IBM Cloud Internet Services instance.
Parameters map[string]string
Arbitrary parameters to create instance. The value must be a JSON object.
Plan string
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
ResourceCrn string
The crn of the resource
ResourceGroupId string
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Service string
(String) The service type of the instance.
Status string
(String) The status of the CIS instance.
Tags []string
A list of tags that you want to associate with the instance.
Timeouts CisTimeoutsArgs
cisId String
(String) The CRN of the CIS instance.
guid String
(String) The unique identifier of the CIS instance.
location String
The target location where you want to create your instance.
name String
A descriptive name for your IBM Cloud Internet Services instance.
parameters Map<String,String>
Arbitrary parameters to create instance. The value must be a JSON object.
plan String
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resourceCrn String
The crn of the resource
resourceGroupId String
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
service String
(String) The service type of the instance.
status String
(String) The status of the CIS instance.
tags List<String>
A list of tags that you want to associate with the instance.
timeouts CisTimeouts
cisId string
(String) The CRN of the CIS instance.
guid string
(String) The unique identifier of the CIS instance.
location string
The target location where you want to create your instance.
name string
A descriptive name for your IBM Cloud Internet Services instance.
parameters {[key: string]: string}
Arbitrary parameters to create instance. The value must be a JSON object.
plan string
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resourceCrn string
The crn of the resource
resourceGroupId string
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
service string
(String) The service type of the instance.
status string
(String) The status of the CIS instance.
tags string[]
A list of tags that you want to associate with the instance.
timeouts CisTimeouts
cis_id str
(String) The CRN of the CIS instance.
guid str
(String) The unique identifier of the CIS instance.
location str
The target location where you want to create your instance.
name str
A descriptive name for your IBM Cloud Internet Services instance.
parameters Mapping[str, str]
Arbitrary parameters to create instance. The value must be a JSON object.
plan str
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resource_crn str
The crn of the resource
resource_group_id str
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
service str
(String) The service type of the instance.
status str
(String) The status of the CIS instance.
tags Sequence[str]
A list of tags that you want to associate with the instance.
timeouts CisTimeoutsArgs
cisId String
(String) The CRN of the CIS instance.
guid String
(String) The unique identifier of the CIS instance.
location String
The target location where you want to create your instance.
name String
A descriptive name for your IBM Cloud Internet Services instance.
parameters Map<String>
Arbitrary parameters to create instance. The value must be a JSON object.
plan String
The name of the plan for your instance. To retrieve this value, run ibmcloud catalog service internet-svcs command in the IBM Cloud CLI.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
resourceCrn String
The crn of the resource
resourceGroupId String
The ID of the resource group where you want to create the service. To retrieve this value, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is specified, the default resource group is used.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
service String
(String) The service type of the instance.
status String
(String) The status of the CIS instance.
tags List<String>
A list of tags that you want to associate with the instance.
timeouts Property Map

Supporting Types

CisTimeouts
, CisTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Import

The ibm_cis resource can be imported by using the id. The ID is formed from the Cloud Resource Name (CRN) from the Overview page of the Internet Services instance. These will be located under the Domain heading.

  • CRN is unique ID of the form: crn:v1:bluemix:public:internet-svcs:global:a/{IBM-account}:{service-instance}::

Syntax

$ pulumi import ibm:index/cis:Cis myorg <crn>
Copy

Example

$ pulumi import ibm:index/cis:Cis myorg 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.