ibm.getCisDomain

Explore with Pulumi AI

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

Retrieve information about an existing Internet Services domain resource. This allows new CIS sub-resources to be added to an existing CIS domain registration, specifically DNS records and Global Load Balancers. It is used in conjunction with the CIS data source. For more information, about CIS DNS domain, see setting up your Domain Name System for CIS.

Example Usage

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

const cisInstanceDomain = ibm.getCisDomain({
    domain: "example.com",
    cisId: ibm_cis.instance.id,
});
const cisInstance = ibm.getCis({
    name: "test",
});

import pulumi
import pulumi_ibm as ibm

cis_instance_domain = ibm.get_cis_domain(domain="example.com",
    cis_id=ibm_cis["instance"]["id"])
cis_instance = ibm.get_cis(name="test")

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.LookupCisDomain(ctx, &ibm.LookupCisDomainArgs{
			Domain: "example.com",
			CisId:  ibm_cis.Instance.Id,
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.LookupCis(ctx, &ibm.LookupCisArgs{
			Name: "test",
		}, 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 cisInstanceDomain = Ibm.GetCisDomain.Invoke(new()
    {
        Domain = "example.com",
        CisId = ibm_cis.Instance.Id,
    });

    var cisInstance = Ibm.GetCis.Invoke(new()
    {
        Name = "test",
    });

});

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.GetCisDomainArgs;
import com.pulumi.ibm.inputs.GetCisArgs;
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 cisInstanceDomain = IbmFunctions.getCisDomain(GetCisDomainArgs.builder()
            .domain("example.com")
            .cisId(ibm_cis.instance().id())
            .build());

        final var cisInstance = IbmFunctions.getCis(GetCisArgs.builder()
            .name("test")
            .build());

    }
}

variables:
  cisInstanceDomain:
    fn::invoke:
      function: ibm:getCisDomain
      arguments:
        domain: example.com
        cisId: ${ibm_cis.instance.id}
  cisInstance:
    fn::invoke:
      function: ibm:getCis
      arguments:
        name: test

Using getCisDomain

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 getCisDomain(args: GetCisDomainArgs, opts?: InvokeOptions): Promise<GetCisDomainResult>
function getCisDomainOutput(args: GetCisDomainOutputArgs, opts?: InvokeOptions): Output<GetCisDomainResult>

def get_cis_domain(cis_id: Optional[str] = None,
                   cname_suffix: Optional[str] = None,
                   domain: Optional[str] = None,
                   id: Optional[str] = None,
                   verification_key: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetCisDomainResult
def get_cis_domain_output(cis_id: Optional[pulumi.Input[str]] = None,
                   cname_suffix: Optional[pulumi.Input[str]] = None,
                   domain: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   verification_key: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetCisDomainResult]

func LookupCisDomain(ctx *Context, args *LookupCisDomainArgs, opts ...InvokeOption) (*LookupCisDomainResult, error)
func LookupCisDomainOutput(ctx *Context, args *LookupCisDomainOutputArgs, opts ...InvokeOption) LookupCisDomainResultOutput

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

public static class GetCisDomain 
{
    public static Task<GetCisDomainResult> InvokeAsync(GetCisDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetCisDomainResult> Invoke(GetCisDomainInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCisDomainResult> getCisDomain(GetCisDomainArgs args, InvokeOptions options)
public static Output<GetCisDomainResult> getCisDomain(GetCisDomainArgs args, InvokeOptions options)

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

The following arguments are supported:

CisId string: The ID of the IBM Cloud Internet Services instance.
Domain string: The DNS domain name that is added and managed for an IBM Cloud Internet Services instance.
CnameSuffix string
Id string: (String) The unique identifier of your domain.
VerificationKey string

CisId string: The ID of the IBM Cloud Internet Services instance.
Domain string: The DNS domain name that is added and managed for an IBM Cloud Internet Services instance.
CnameSuffix string
Id string: (String) The unique identifier of your domain.
VerificationKey string

cisId String: The ID of the IBM Cloud Internet Services instance.
domain String: The DNS domain name that is added and managed for an IBM Cloud Internet Services instance.
cnameSuffix String
id String: (String) The unique identifier of your domain.
verificationKey String

cisId string: The ID of the IBM Cloud Internet Services instance.
domain string: The DNS domain name that is added and managed for an IBM Cloud Internet Services instance.
cnameSuffix string
id string: (String) The unique identifier of your domain.
verificationKey string

cis_id str: The ID of the IBM Cloud Internet Services instance.
domain str: The DNS domain name that is added and managed for an IBM Cloud Internet Services instance.
cname_suffix str
id str: (String) The unique identifier of your domain.
verification_key str

cisId String: The ID of the IBM Cloud Internet Services instance.
domain String: The DNS domain name that is added and managed for an IBM Cloud Internet Services instance.
cnameSuffix String
id String: (String) The unique identifier of your domain.
verificationKey String

getCisDomain Result

The following output properties are available:

CisId string
CnameSuffix string
Domain string
DomainId string: (String) ID of the domain.
Id string: (String) The unique identifier of your domain.
NameServers List<string>: (String) The IBM Cloud Internet Services assigned name servers, to be passed by interpolation to the resource dns_domain_registration_nameservers.
OriginalNameServers List<string>: (String) The name servers from when the Domain was initially registered with the DNS Registrar.
Paused bool: (Bool) If set to true, network traffic to this domain is paused. If set to false, network traffic to this domain is permitted. The default value is false.
Status string: (String) The status of your domain. Valid values are active, pending, initializing, moved, deleted, and deactivated. After creation, the status remains pending until the DNS Registrar is updated with the CIS name servers, exported in the ‘name_servers’ variable.
Type string: (String) The type of domain created. full- for regular domains, & partial for partial domain for CNAME setup.
VerificationKey string

CisId string
CnameSuffix string
Domain string
DomainId string: (String) ID of the domain.
Id string: (String) The unique identifier of your domain.
NameServers []string: (String) The IBM Cloud Internet Services assigned name servers, to be passed by interpolation to the resource dns_domain_registration_nameservers.
OriginalNameServers []string: (String) The name servers from when the Domain was initially registered with the DNS Registrar.
Paused bool: (Bool) If set to true, network traffic to this domain is paused. If set to false, network traffic to this domain is permitted. The default value is false.
Status string: (String) The status of your domain. Valid values are active, pending, initializing, moved, deleted, and deactivated. After creation, the status remains pending until the DNS Registrar is updated with the CIS name servers, exported in the ‘name_servers’ variable.
Type string: (String) The type of domain created. full- for regular domains, & partial for partial domain for CNAME setup.
VerificationKey string

cisId String
cnameSuffix String
domain String
domainId String: (String) ID of the domain.
id String: (String) The unique identifier of your domain.
nameServers List<String>: (String) The IBM Cloud Internet Services assigned name servers, to be passed by interpolation to the resource dns_domain_registration_nameservers.
originalNameServers List<String>: (String) The name servers from when the Domain was initially registered with the DNS Registrar.
paused Boolean: (Bool) If set to true, network traffic to this domain is paused. If set to false, network traffic to this domain is permitted. The default value is false.
status String: (String) The status of your domain. Valid values are active, pending, initializing, moved, deleted, and deactivated. After creation, the status remains pending until the DNS Registrar is updated with the CIS name servers, exported in the ‘name_servers’ variable.
type String: (String) The type of domain created. full- for regular domains, & partial for partial domain for CNAME setup.
verificationKey String

cisId string
cnameSuffix string
domain string
domainId string: (String) ID of the domain.
id string: (String) The unique identifier of your domain.
nameServers string[]: (String) The IBM Cloud Internet Services assigned name servers, to be passed by interpolation to the resource dns_domain_registration_nameservers.
originalNameServers string[]: (String) The name servers from when the Domain was initially registered with the DNS Registrar.
paused boolean: (Bool) If set to true, network traffic to this domain is paused. If set to false, network traffic to this domain is permitted. The default value is false.
status string: (String) The status of your domain. Valid values are active, pending, initializing, moved, deleted, and deactivated. After creation, the status remains pending until the DNS Registrar is updated with the CIS name servers, exported in the ‘name_servers’ variable.
type string: (String) The type of domain created. full- for regular domains, & partial for partial domain for CNAME setup.
verificationKey string

cis_id str
cname_suffix str
domain str
domain_id str: (String) ID of the domain.
id str: (String) The unique identifier of your domain.
name_servers Sequence[str]: (String) The IBM Cloud Internet Services assigned name servers, to be passed by interpolation to the resource dns_domain_registration_nameservers.
original_name_servers Sequence[str]: (String) The name servers from when the Domain was initially registered with the DNS Registrar.
paused bool: (Bool) If set to true, network traffic to this domain is paused. If set to false, network traffic to this domain is permitted. The default value is false.
status str: (String) The status of your domain. Valid values are active, pending, initializing, moved, deleted, and deactivated. After creation, the status remains pending until the DNS Registrar is updated with the CIS name servers, exported in the ‘name_servers’ variable.
type str: (String) The type of domain created. full- for regular domains, & partial for partial domain for CNAME setup.
verification_key str

cisId String
cnameSuffix String
domain String
domainId String: (String) ID of the domain.
id String: (String) The unique identifier of your domain.
nameServers List<String>: (String) The IBM Cloud Internet Services assigned name servers, to be passed by interpolation to the resource dns_domain_registration_nameservers.
originalNameServers List<String>: (String) The name servers from when the Domain was initially registered with the DNS Registrar.
paused Boolean: (Bool) If set to true, network traffic to this domain is paused. If set to false, network traffic to this domain is permitted. The default value is false.
status String: (String) The status of your domain. Valid values are active, pending, initializing, moved, deleted, and deactivated. After creation, the status remains pending until the DNS Registrar is updated with the CIS name servers, exported in the ‘name_servers’ variable.
type String: (String) The type of domain created. full- for regular domains, & partial for partial domain for CNAME setup.
verificationKey String

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

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

ibm-cloud/terraform-provider-ibm

ibm.getCisDomain

On this page

On this page

Example Usage

Using getCisDomain

getCisDomain Result

Package Details

On this page

On this page