Cloudant

ibm 2.5.0, Aug 5 26

Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Example Usage

Gen 1

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

const cloudant = new ibm.Cloudant("cloudant", {
    name: "cloudant-service-name",
    location: "us-south",
    plan: "standard",
    legacyCredentials: true,
    includeDataEvents: false,
    capacity: 1,
    enableCors: true,
    corsConfig: {
        allowCredentials: false,
        origins: ["https://example.com"],
    },
});

import pulumi
import pulumi_ibm as ibm

cloudant = ibm.Cloudant("cloudant",
    name="cloudant-service-name",
    location="us-south",
    plan="standard",
    legacy_credentials=True,
    include_data_events=False,
    capacity=1,
    enable_cors=True,
    cors_config={
        "allow_credentials": False,
        "origins": ["https://example.com"],
    })

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewCloudant(ctx, "cloudant", &ibm.CloudantArgs{
			Name:              pulumi.String("cloudant-service-name"),
			Location:          pulumi.String("us-south"),
			Plan:              pulumi.String("standard"),
			LegacyCredentials: pulumi.Bool(true),
			IncludeDataEvents: pulumi.Bool(false),
			Capacity:          pulumi.Float64(1),
			EnableCors:        pulumi.Bool(true),
			CorsConfig: &ibm.CloudantCorsConfigArgs{
				AllowCredentials: pulumi.Bool(false),
				Origins: pulumi.StringArray{
					pulumi.String("https://example.com"),
				},
			},
		})
		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 cloudant = new Ibm.Cloudant("cloudant", new()
    {
        Name = "cloudant-service-name",
        Location = "us-south",
        Plan = "standard",
        LegacyCredentials = true,
        IncludeDataEvents = false,
        Capacity = 1,
        EnableCors = true,
        CorsConfig = new Ibm.Inputs.CloudantCorsConfigArgs
        {
            AllowCredentials = false,
            Origins = new[]
            {
                "https://example.com",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.Cloudant;
import com.pulumi.ibm.CloudantArgs;
import com.pulumi.ibm.inputs.CloudantCorsConfigArgs;
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) {
        var cloudant = new Cloudant("cloudant", CloudantArgs.builder()
            .name("cloudant-service-name")
            .location("us-south")
            .plan("standard")
            .legacyCredentials(true)
            .includeDataEvents(false)
            .capacity(1.0)
            .enableCors(true)
            .corsConfig(CloudantCorsConfigArgs.builder()
                .allowCredentials(false)
                .origins("https://example.com")
                .build())
            .build());

    }
}

resources:
  cloudant:
    type: ibm:Cloudant
    properties:
      name: cloudant-service-name
      location: us-south
      plan: standard
      legacyCredentials: true
      includeDataEvents: false
      capacity: 1
      enableCors: true
      corsConfig:
        allowCredentials: false
        origins:
          - https://example.com

Example coming soon!

Gen 2

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

const cloudantGen2 = new ibm.Cloudant("cloudant_gen2", {
    name: "cloudant-gen2-name",
    location: "us-south",
    plan: "standard-gen2",
    includeDataEvents: true,
    capacity: 1,
    enableCors: true,
    corsConfig: {
        allowCredentials: false,
        origins: ["https://example.com"],
    },
});

import pulumi
import pulumi_ibm as ibm

cloudant_gen2 = ibm.Cloudant("cloudant_gen2",
    name="cloudant-gen2-name",
    location="us-south",
    plan="standard-gen2",
    include_data_events=True,
    capacity=1,
    enable_cors=True,
    cors_config={
        "allow_credentials": False,
        "origins": ["https://example.com"],
    })

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewCloudant(ctx, "cloudant_gen2", &ibm.CloudantArgs{
			Name:              pulumi.String("cloudant-gen2-name"),
			Location:          pulumi.String("us-south"),
			Plan:              pulumi.String("standard-gen2"),
			IncludeDataEvents: pulumi.Bool(true),
			Capacity:          pulumi.Float64(1),
			EnableCors:        pulumi.Bool(true),
			CorsConfig: &ibm.CloudantCorsConfigArgs{
				AllowCredentials: pulumi.Bool(false),
				Origins: pulumi.StringArray{
					pulumi.String("https://example.com"),
				},
			},
		})
		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 cloudantGen2 = new Ibm.Cloudant("cloudant_gen2", new()
    {
        Name = "cloudant-gen2-name",
        Location = "us-south",
        Plan = "standard-gen2",
        IncludeDataEvents = true,
        Capacity = 1,
        EnableCors = true,
        CorsConfig = new Ibm.Inputs.CloudantCorsConfigArgs
        {
            AllowCredentials = false,
            Origins = new[]
            {
                "https://example.com",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.Cloudant;
import com.pulumi.ibm.CloudantArgs;
import com.pulumi.ibm.inputs.CloudantCorsConfigArgs;
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) {
        var cloudantGen2 = new Cloudant("cloudantGen2", CloudantArgs.builder()
            .name("cloudant-gen2-name")
            .location("us-south")
            .plan("standard-gen2")
            .includeDataEvents(true)
            .capacity(1.0)
            .enableCors(true)
            .corsConfig(CloudantCorsConfigArgs.builder()
                .allowCredentials(false)
                .origins("https://example.com")
                .build())
            .build());

    }
}

resources:
  cloudantGen2:
    type: ibm:Cloudant
    name: cloudant_gen2
    properties:
      name: cloudant-gen2-name
      location: us-south
      plan: standard-gen2
      includeDataEvents: true
      capacity: 1
      enableCors: true
      corsConfig:
        allowCredentials: false
        origins:
          - https://example.com

Example coming soon!

Create Cloudant Resource

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

Constructor syntax

new Cloudant(name: string, args: CloudantArgs, opts?: CustomResourceOptions);

@overload
def Cloudant(resource_name: str,
             args: CloudantArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Cloudant(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             location: Optional[str] = None,
             plan: Optional[str] = None,
             legacy_credentials: Optional[bool] = None,
             enable_cors: Optional[bool] = None,
             environment_crn: Optional[str] = None,
             include_data_events: Optional[bool] = None,
             capacity: Optional[float] = None,
             cors_config: Optional[CloudantCorsConfigArgs] = None,
             name: Optional[str] = None,
             parameters: Optional[Mapping[str, str]] = None,
             cloudant_id: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             service_endpoints: Optional[str] = None,
             tags: Optional[Sequence[str]] = None,
             timeouts: Optional[CloudantTimeoutsArgs] = None)

func NewCloudant(ctx *Context, name string, args CloudantArgs, opts ...ResourceOption) (*Cloudant, error)

public Cloudant(string name, CloudantArgs args, CustomResourceOptions? opts = null)

public Cloudant(String name, CloudantArgs args)
public Cloudant(String name, CloudantArgs args, CustomResourceOptions options)

type: ibm:Cloudant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "ibm_cloudant" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args CloudantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CloudantArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CloudantArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CloudantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CloudantArgs: 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 cloudantResource = new Ibm.Cloudant("cloudantResource", new()
{
    Location = "string",
    Plan = "string",
    LegacyCredentials = false,
    EnableCors = false,
    EnvironmentCrn = "string",
    IncludeDataEvents = false,
    Capacity = 0,
    CorsConfig = new Ibm.Inputs.CloudantCorsConfigArgs
    {
        Origins = new[]
        {
            "string",
        },
        AllowCredentials = false,
    },
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    CloudantId = "string",
    ResourceGroupId = "string",
    ServiceEndpoints = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.CloudantTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

example, err := ibm.NewCloudant(ctx, "cloudantResource", &ibm.CloudantArgs{
	Location:          pulumi.String("string"),
	Plan:              pulumi.String("string"),
	LegacyCredentials: pulumi.Bool(false),
	EnableCors:        pulumi.Bool(false),
	EnvironmentCrn:    pulumi.String("string"),
	IncludeDataEvents: pulumi.Bool(false),
	Capacity:          pulumi.Float64(0),
	CorsConfig: &ibm.CloudantCorsConfigArgs{
		Origins: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowCredentials: pulumi.Bool(false),
	},
	Name: pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CloudantId:       pulumi.String("string"),
	ResourceGroupId:  pulumi.String("string"),
	ServiceEndpoints: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.CloudantTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

resource "ibm_cloudant" "cloudantResource" {
  lifecycle {
    create_before_destroy = true
  }
  location            = "string"
  plan                = "string"
  legacy_credentials  = false
  enable_cors         = false
  environment_crn     = "string"
  include_data_events = false
  capacity            = 0
  cors_config = {
    origins           = ["string"]
    allow_credentials = false
  }
  name = "string"
  parameters = {
    "string" = "string"
  }
  cloudant_id       = "string"
  resource_group_id = "string"
  service_endpoints = "string"
  tags              = ["string"]
  timeouts = {
    create = "string"
    delete = "string"
    update = "string"
  }
}

var cloudantResource = new Cloudant("cloudantResource", CloudantArgs.builder()
    .location("string")
    .plan("string")
    .legacyCredentials(false)
    .enableCors(false)
    .environmentCrn("string")
    .includeDataEvents(false)
    .capacity(0.0)
    .corsConfig(CloudantCorsConfigArgs.builder()
        .origins("string")
        .allowCredentials(false)
        .build())
    .name("string")
    .parameters(Map.of("string", "string"))
    .cloudantId("string")
    .resourceGroupId("string")
    .serviceEndpoints("string")
    .tags("string")
    .timeouts(CloudantTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

cloudant_resource = ibm.Cloudant("cloudantResource",
    location="string",
    plan="string",
    legacy_credentials=False,
    enable_cors=False,
    environment_crn="string",
    include_data_events=False,
    capacity=float(0),
    cors_config={
        "origins": ["string"],
        "allow_credentials": False,
    },
    name="string",
    parameters={
        "string": "string",
    },
    cloudant_id="string",
    resource_group_id="string",
    service_endpoints="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

const cloudantResource = new ibm.Cloudant("cloudantResource", {
    location: "string",
    plan: "string",
    legacyCredentials: false,
    enableCors: false,
    environmentCrn: "string",
    includeDataEvents: false,
    capacity: 0,
    corsConfig: {
        origins: ["string"],
        allowCredentials: false,
    },
    name: "string",
    parameters: {
        string: "string",
    },
    cloudantId: "string",
    resourceGroupId: "string",
    serviceEndpoints: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

type: ibm:Cloudant
properties:
    capacity: 0
    cloudantId: string
    corsConfig:
        allowCredentials: false
        origins:
            - string
    enableCors: false
    environmentCrn: string
    includeDataEvents: false
    legacyCredentials: false
    location: string
    name: string
    parameters:
        string: string
    plan: string
    resourceGroupId: string
    serviceEndpoints: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string

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

Location string

Target location or environment to create the resource instance.

Plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

Capacity double

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

Capacity changes are applied asynchronously. For Gen 1 plans the new blocks value is reflected immediately, but the capacity change may take some time. For Gen 2 the capacity change will be reflected when the change is complete. For more information, see Gen 1 blocks or Gen 2 capacity units.

CloudantId string

CorsConfig CloudantCorsConfig

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

EnableCors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

EnvironmentCrn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

IncludeDataEvents bool

Include data event types in events sent to IBM Cloud Activity Tracker Event Routing for the IBM Cloudant instance. The default value is false and emitted events are only of the management type. For Gen 1 instances this is applied via the Activity Tracker API. For Gen 2 instances this maps to the broker parameter dataservices.cloudant.configuration.audit.data_events.

LegacyCredentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

Name string

A name for the resource instance.

Parameters Dictionary<string, string>

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

ResourceGroupId string

The resource group ID.

ServiceEndpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

Tags List<string>

Tags associated with the instance.

Timeouts CloudantTimeouts

Location string

Target location or environment to create the resource instance.

Plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

Capacity float64

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

CloudantId string

CorsConfig CloudantCorsConfigArgs

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

EnableCors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

EnvironmentCrn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

IncludeDataEvents bool

LegacyCredentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

Name string

A name for the resource instance.

Parameters map[string]string

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

ResourceGroupId string

The resource group ID.

ServiceEndpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

Tags []string

Tags associated with the instance.

Timeouts CloudantTimeoutsArgs

location string

Target location or environment to create the resource instance.

plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

capacity number

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudant_id string

cors_config object

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

enable_cors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environment_crn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

include_data_events bool

legacy_credentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

name string

A name for the resource instance.

parameters map(string)

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

resource_group_id string

The resource group ID.

service_endpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

tags list(string)

Tags associated with the instance.

timeouts object

location String

Target location or environment to create the resource instance.

plan String

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

capacity Double

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudantId String

corsConfig CloudantCorsConfig

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

enableCors Boolean

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environmentCrn String

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

includeDataEvents Boolean

legacyCredentials Boolean

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

name String

A name for the resource instance.

parameters Map<String,String>

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

resourceGroupId String

The resource group ID.

serviceEndpoints String

Types of the service endpoints. Possible values are public, private, public-and-private.

tags List<String>

Tags associated with the instance.

timeouts CloudantTimeouts

location string

Target location or environment to create the resource instance.

plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

capacity number

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudantId string

corsConfig CloudantCorsConfig

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

enableCors boolean

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environmentCrn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

includeDataEvents boolean

legacyCredentials boolean

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

name string

A name for the resource instance.

parameters {[key: string]: string}

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

resourceGroupId string

The resource group ID.

serviceEndpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

tags string[]

Tags associated with the instance.

timeouts CloudantTimeouts

location str

Target location or environment to create the resource instance.

plan str

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

capacity float

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudant_id str

cors_config CloudantCorsConfigArgs

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

enable_cors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environment_crn str

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

include_data_events bool

legacy_credentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

name str

A name for the resource instance.

parameters Mapping[str, str]

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

resource_group_id str

The resource group ID.

service_endpoints str

Types of the service endpoints. Possible values are public, private, public-and-private.

tags Sequence[str]

Tags associated with the instance.

timeouts CloudantTimeoutsArgs

location String

Target location or environment to create the resource instance.

plan String

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

capacity Number

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudantId String

corsConfig Property Map

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

enableCors Boolean

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environmentCrn String

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

includeDataEvents Boolean

legacyCredentials Boolean

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

name String

A name for the resource instance.

parameters Map<String>

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

resourceGroupId String

The resource group ID.

serviceEndpoints String

Types of the service endpoints. Possible values are public, private, public-and-private.

tags List<String>

Tags associated with the instance.

timeouts Property Map

Outputs

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

AccountId string: (String) An alpha-numeric value identifying the account ID.
AllowCleanup bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
CreatedAt string: (String) The date when the instance was created.
CreatedBy string: (String) The subject who created the instance.
Crn string: (String) CRN of the resource instance.
DashboardUrl string: (String) The dashboard URL to access resource.
DeletedAt string: (String) The date when the instance was deleted.
DeletedBy string: (String) The subject who deleted the instance.
Extensions Dictionary<string, string>: (Map) The extended metadata as a map associated with the resource instance.
Guid string: (String) The GUID of resource instance.
Id string: The provider-assigned unique ID for this managed resource.
LastOperation Dictionary<string, string>: (Map) The status of the last operation requested on the instance.
Locked bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
OnetimeCredentials bool: A boolean that dictates if the onetime_credentials is true or false.
ParametersJson string: Arbitrary parameters to pass in Json string format
PlanHistories List<CloudantPlanHistory>: (List of Object) The plan history of the instance.
ResourceAliasesUrl string: (String) The relative path to the resource aliases for the instance.
Deprecated: Deprecated
ResourceBindingsUrl string: (String) The relative path to the resource bindings for the instance.
Deprecated: Deprecated
ResourceControllerUrl string: (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.
ResourceCrn string: (String) The CRN of the resource.
ResourceGroupCrn string: (String) The long ID (full CRN) of the resource group.
ResourceGroupName string: (String) The resource group name in which resource is provisioned.
ResourceId string: (String) The unique ID of the offering.
ResourceKeysUrl string: (String) The relative path to the resource keys for the instance.
ResourceName string: (String) The name of the resource.
ResourcePlanId string: (String) The unique ID of the plan associated with the offering.
ResourceStatus string: (String) The status of the resource.
RestoredAt string: (String) The date when the instance under reclamation was restored.
RestoredBy string: (String) The subject who restored the instance back from reclamation.
ScheduledReclaimAt string: (String) The date when the instance was scheduled for reclamation.
ScheduledReclaimBy string: (String) The subject who initiated the instance reclamation.
Service string: (String) The service type of the instance. Always cloudantnosqldb.
State string: (String) The current state of the instance.
Status string: (String) Status of the resource instance.
SubType string: (String) The sub-type of an instance. For example, cfaas.
TargetCrn string: (String) The full deployment CRN as defined in the global catalog.
Throughput Dictionary<string, double>: (Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.
Type string: (String) The type of the instance. For example, service_instance.
UpdateAt string: (String) The date when the instance was last updated.
UpdateBy string: (String) The subject who updated the instance.

AccountId string: (String) An alpha-numeric value identifying the account ID.
AllowCleanup bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
CreatedAt string: (String) The date when the instance was created.
CreatedBy string: (String) The subject who created the instance.
Crn string: (String) CRN of the resource instance.
DashboardUrl string: (String) The dashboard URL to access resource.
DeletedAt string: (String) The date when the instance was deleted.
DeletedBy string: (String) The subject who deleted the instance.
Extensions map[string]string: (Map) The extended metadata as a map associated with the resource instance.
Guid string: (String) The GUID of resource instance.
Id string: The provider-assigned unique ID for this managed resource.
LastOperation map[string]string: (Map) The status of the last operation requested on the instance.
Locked bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
OnetimeCredentials bool: A boolean that dictates if the onetime_credentials is true or false.
ParametersJson string: Arbitrary parameters to pass in Json string format
PlanHistories []CloudantPlanHistory: (List of Object) The plan history of the instance.
ResourceAliasesUrl string: (String) The relative path to the resource aliases for the instance.
Deprecated: Deprecated
ResourceBindingsUrl string: (String) The relative path to the resource bindings for the instance.
Deprecated: Deprecated
ResourceControllerUrl string: (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.
ResourceCrn string: (String) The CRN of the resource.
ResourceGroupCrn string: (String) The long ID (full CRN) of the resource group.
ResourceGroupName string: (String) The resource group name in which resource is provisioned.
ResourceId string: (String) The unique ID of the offering.
ResourceKeysUrl string: (String) The relative path to the resource keys for the instance.
ResourceName string: (String) The name of the resource.
ResourcePlanId string: (String) The unique ID of the plan associated with the offering.
ResourceStatus string: (String) The status of the resource.
RestoredAt string: (String) The date when the instance under reclamation was restored.
RestoredBy string: (String) The subject who restored the instance back from reclamation.
ScheduledReclaimAt string: (String) The date when the instance was scheduled for reclamation.
ScheduledReclaimBy string: (String) The subject who initiated the instance reclamation.
Service string: (String) The service type of the instance. Always cloudantnosqldb.
State string: (String) The current state of the instance.
Status string: (String) Status of the resource instance.
SubType string: (String) The sub-type of an instance. For example, cfaas.
TargetCrn string: (String) The full deployment CRN as defined in the global catalog.
Throughput map[string]float64: (Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.
Type string: (String) The type of the instance. For example, service_instance.
UpdateAt string: (String) The date when the instance was last updated.
UpdateBy string: (String) The subject who updated the instance.

account_id string: (String) An alpha-numeric value identifying the account ID.
allow_cleanup bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
created_at string: (String) The date when the instance was created.
created_by string: (String) The subject who created the instance.
crn string: (String) CRN of the resource instance.
dashboard_url string: (String) The dashboard URL to access resource.
deleted_at string: (String) The date when the instance was deleted.
deleted_by string: (String) The subject who deleted the instance.
extensions map(string): (Map) The extended metadata as a map associated with the resource instance.
guid string: (String) The GUID of resource instance.
id string: The provider-assigned unique ID for this managed resource.
last_operation map(string): (Map) The status of the last operation requested on the instance.
locked bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
onetime_credentials bool: A boolean that dictates if the onetime_credentials is true or false.
parameters_json string: Arbitrary parameters to pass in Json string format
plan_histories list(object): (List of Object) The plan history of the instance.
resource_aliases_url string: (String) The relative path to the resource aliases for the instance.
Deprecated: Deprecated
resource_bindings_url string: (String) The relative path to the resource bindings for the instance.
Deprecated: Deprecated
resource_controller_url string: (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.
resource_crn string: (String) The CRN of the resource.
resource_group_crn string: (String) The long ID (full CRN) of the resource group.
resource_group_name string: (String) The resource group name in which resource is provisioned.
resource_id string: (String) The unique ID of the offering.
resource_keys_url string: (String) The relative path to the resource keys for the instance.
resource_name string: (String) The name of the resource.
resource_plan_id string: (String) The unique ID of the plan associated with the offering.
resource_status string: (String) The status of the resource.
restored_at string: (String) The date when the instance under reclamation was restored.
restored_by string: (String) The subject who restored the instance back from reclamation.
scheduled_reclaim_at string: (String) The date when the instance was scheduled for reclamation.
scheduled_reclaim_by string: (String) The subject who initiated the instance reclamation.
service string: (String) The service type of the instance. Always cloudantnosqldb.
state string: (String) The current state of the instance.
status string: (String) Status of the resource instance.
sub_type string: (String) The sub-type of an instance. For example, cfaas.
target_crn string: (String) The full deployment CRN as defined in the global catalog.
throughput map(number): (Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.
type string: (String) The type of the instance. For example, service_instance.
update_at string: (String) The date when the instance was last updated.
update_by string: (String) The subject who updated the instance.

accountId String: (String) An alpha-numeric value identifying the account ID.
allowCleanup Boolean: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
createdAt String: (String) The date when the instance was created.
createdBy String: (String) The subject who created the instance.
crn String: (String) CRN of the resource instance.
dashboardUrl String: (String) The dashboard URL to access resource.
deletedAt String: (String) The date when the instance was deleted.
deletedBy String: (String) The subject who deleted the instance.
extensions Map<String,String>: (Map) The extended metadata as a map associated with the resource instance.
guid String: (String) The GUID of resource instance.
id String: The provider-assigned unique ID for this managed resource.
lastOperation Map<String,String>: (Map) The status of the last operation requested on the instance.
locked Boolean: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
onetimeCredentials Boolean: A boolean that dictates if the onetime_credentials is true or false.
parametersJson String: Arbitrary parameters to pass in Json string format
planHistories List<CloudantPlanHistory>: (List of Object) The plan history of the instance.
resourceAliasesUrl String: (String) The relative path to the resource aliases for the instance.
Deprecated: Deprecated
resourceBindingsUrl String: (String) The relative path to the resource bindings for the instance.
Deprecated: Deprecated
resourceControllerUrl String: (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.
resourceCrn String: (String) The CRN of the resource.
resourceGroupCrn String: (String) The long ID (full CRN) of the resource group.
resourceGroupName String: (String) The resource group name in which resource is provisioned.
resourceId String: (String) The unique ID of the offering.
resourceKeysUrl String: (String) The relative path to the resource keys for the instance.
resourceName String: (String) The name of the resource.
resourcePlanId String: (String) The unique ID of the plan associated with the offering.
resourceStatus String: (String) The status of the resource.
restoredAt String: (String) The date when the instance under reclamation was restored.
restoredBy String: (String) The subject who restored the instance back from reclamation.
scheduledReclaimAt String: (String) The date when the instance was scheduled for reclamation.
scheduledReclaimBy String: (String) The subject who initiated the instance reclamation.
service String: (String) The service type of the instance. Always cloudantnosqldb.
state String: (String) The current state of the instance.
status String: (String) Status of the resource instance.
subType String: (String) The sub-type of an instance. For example, cfaas.
targetCrn String: (String) The full deployment CRN as defined in the global catalog.
throughput Map<String,Double>: (Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.
type String: (String) The type of the instance. For example, service_instance.
updateAt String: (String) The date when the instance was last updated.
updateBy String: (String) The subject who updated the instance.

accountId string: (String) An alpha-numeric value identifying the account ID.
allowCleanup boolean: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
createdAt string: (String) The date when the instance was created.
createdBy string: (String) The subject who created the instance.
crn string: (String) CRN of the resource instance.
dashboardUrl string: (String) The dashboard URL to access resource.
deletedAt string: (String) The date when the instance was deleted.
deletedBy string: (String) The subject who deleted the instance.
extensions {[key: string]: string}: (Map) The extended metadata as a map associated with the resource instance.
guid string: (String) The GUID of resource instance.
id string: The provider-assigned unique ID for this managed resource.
lastOperation {[key: string]: string}: (Map) The status of the last operation requested on the instance.
locked boolean: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
onetimeCredentials boolean: A boolean that dictates if the onetime_credentials is true or false.
parametersJson string: Arbitrary parameters to pass in Json string format
planHistories CloudantPlanHistory[]: (List of Object) The plan history of the instance.
resourceAliasesUrl string: (String) The relative path to the resource aliases for the instance.
Deprecated: Deprecated
resourceBindingsUrl string: (String) The relative path to the resource bindings for the instance.
Deprecated: Deprecated
resourceControllerUrl string: (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.
resourceCrn string: (String) The CRN of the resource.
resourceGroupCrn string: (String) The long ID (full CRN) of the resource group.
resourceGroupName string: (String) The resource group name in which resource is provisioned.
resourceId string: (String) The unique ID of the offering.
resourceKeysUrl string: (String) The relative path to the resource keys for the instance.
resourceName string: (String) The name of the resource.
resourcePlanId string: (String) The unique ID of the plan associated with the offering.
resourceStatus string: (String) The status of the resource.
restoredAt string: (String) The date when the instance under reclamation was restored.
restoredBy string: (String) The subject who restored the instance back from reclamation.
scheduledReclaimAt string: (String) The date when the instance was scheduled for reclamation.
scheduledReclaimBy string: (String) The subject who initiated the instance reclamation.
service string: (String) The service type of the instance. Always cloudantnosqldb.
state string: (String) The current state of the instance.
status string: (String) Status of the resource instance.
subType string: (String) The sub-type of an instance. For example, cfaas.
targetCrn string: (String) The full deployment CRN as defined in the global catalog.
throughput {[key: string]: number}: (Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.
type string: (String) The type of the instance. For example, service_instance.
updateAt string: (String) The date when the instance was last updated.
updateBy string: (String) The subject who updated the instance.

account_id str: (String) An alpha-numeric value identifying the account ID.
allow_cleanup bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
created_at str: (String) The date when the instance was created.
created_by str: (String) The subject who created the instance.
crn str: (String) CRN of the resource instance.
dashboard_url str: (String) The dashboard URL to access resource.
deleted_at str: (String) The date when the instance was deleted.
deleted_by str: (String) The subject who deleted the instance.
extensions Mapping[str, str]: (Map) The extended metadata as a map associated with the resource instance.
guid str: (String) The GUID of resource instance.
id str: The provider-assigned unique ID for this managed resource.
last_operation Mapping[str, str]: (Map) The status of the last operation requested on the instance.
locked bool: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
onetime_credentials bool: A boolean that dictates if the onetime_credentials is true or false.
parameters_json str: Arbitrary parameters to pass in Json string format
plan_histories Sequence[CloudantPlanHistory]: (List of Object) The plan history of the instance.
resource_aliases_url str: (String) The relative path to the resource aliases for the instance.
Deprecated: Deprecated
resource_bindings_url str: (String) The relative path to the resource bindings for the instance.
Deprecated: Deprecated
resource_controller_url str: (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.
resource_crn str: (String) The CRN of the resource.
resource_group_crn str: (String) The long ID (full CRN) of the resource group.
resource_group_name str: (String) The resource group name in which resource is provisioned.
resource_id str: (String) The unique ID of the offering.
resource_keys_url str: (String) The relative path to the resource keys for the instance.
resource_name str: (String) The name of the resource.
resource_plan_id str: (String) The unique ID of the plan associated with the offering.
resource_status str: (String) The status of the resource.
restored_at str: (String) The date when the instance under reclamation was restored.
restored_by str: (String) The subject who restored the instance back from reclamation.
scheduled_reclaim_at str: (String) The date when the instance was scheduled for reclamation.
scheduled_reclaim_by str: (String) The subject who initiated the instance reclamation.
service str: (String) The service type of the instance. Always cloudantnosqldb.
state str: (String) The current state of the instance.
status str: (String) Status of the resource instance.
sub_type str: (String) The sub-type of an instance. For example, cfaas.
target_crn str: (String) The full deployment CRN as defined in the global catalog.
throughput Mapping[str, float]: (Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.
type str: (String) The type of the instance. For example, service_instance.
update_at str: (String) The date when the instance was last updated.
update_by str: (String) The subject who updated the instance.

accountId String: (String) An alpha-numeric value identifying the account ID.
allowCleanup Boolean: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
createdAt String: (String) The date when the instance was created.
createdBy String: (String) The subject who created the instance.
crn String: (String) CRN of the resource instance.
dashboardUrl String: (String) The dashboard URL to access resource.
deletedAt String: (String) The date when the instance was deleted.
deletedBy String: (String) The subject who deleted the instance.
extensions Map<String>: (Map) The extended metadata as a map associated with the resource instance.
guid String: (String) The GUID of resource instance.
id String: The provider-assigned unique ID for this managed resource.
lastOperation Map<String>: (Map) The status of the last operation requested on the instance.
locked Boolean: (Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
onetimeCredentials Boolean: A boolean that dictates if the onetime_credentials is true or false.
parametersJson String: Arbitrary parameters to pass in Json string format
planHistories List<Property Map>: (List of Object) The plan history of the instance.
resourceAliasesUrl String: (String) The relative path to the resource aliases for the instance.
Deprecated: Deprecated
resourceBindingsUrl String: (String) The relative path to the resource bindings for the instance.
Deprecated: Deprecated
resourceControllerUrl String: (String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.
resourceCrn String: (String) The CRN of the resource.
resourceGroupCrn String: (String) The long ID (full CRN) of the resource group.
resourceGroupName String: (String) The resource group name in which resource is provisioned.
resourceId String: (String) The unique ID of the offering.
resourceKeysUrl String: (String) The relative path to the resource keys for the instance.
resourceName String: (String) The name of the resource.
resourcePlanId String: (String) The unique ID of the plan associated with the offering.
resourceStatus String: (String) The status of the resource.
restoredAt String: (String) The date when the instance under reclamation was restored.
restoredBy String: (String) The subject who restored the instance back from reclamation.
scheduledReclaimAt String: (String) The date when the instance was scheduled for reclamation.
scheduledReclaimBy String: (String) The subject who initiated the instance reclamation.
service String: (String) The service type of the instance. Always cloudantnosqldb.
state String: (String) The current state of the instance.
status String: (String) Status of the resource instance.
subType String: (String) The sub-type of an instance. For example, cfaas.
targetCrn String: (String) The full deployment CRN as defined in the global catalog.
throughput Map<Number>: (Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.
type String: (String) The type of the instance. For example, service_instance.
updateAt String: (String) The date when the instance was last updated.
updateBy String: (String) The subject who updated the instance.

Look up Existing Cloudant Resource

Get an existing Cloudant 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?: CloudantState, opts?: CustomResourceOptions): Cloudant

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        allow_cleanup: Optional[bool] = None,
        capacity: Optional[float] = None,
        cloudant_id: Optional[str] = None,
        cors_config: Optional[CloudantCorsConfigArgs] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        dashboard_url: Optional[str] = None,
        deleted_at: Optional[str] = None,
        deleted_by: Optional[str] = None,
        enable_cors: Optional[bool] = None,
        environment_crn: Optional[str] = None,
        extensions: Optional[Mapping[str, str]] = None,
        guid: Optional[str] = None,
        include_data_events: Optional[bool] = None,
        last_operation: Optional[Mapping[str, str]] = None,
        legacy_credentials: Optional[bool] = None,
        location: Optional[str] = None,
        locked: Optional[bool] = None,
        name: Optional[str] = None,
        onetime_credentials: Optional[bool] = None,
        parameters: Optional[Mapping[str, str]] = None,
        parameters_json: Optional[str] = None,
        plan: Optional[str] = None,
        plan_histories: Optional[Sequence[CloudantPlanHistoryArgs]] = None,
        resource_aliases_url: Optional[str] = None,
        resource_bindings_url: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group_crn: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_id: Optional[str] = None,
        resource_keys_url: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_plan_id: Optional[str] = None,
        resource_status: Optional[str] = None,
        restored_at: Optional[str] = None,
        restored_by: Optional[str] = None,
        scheduled_reclaim_at: Optional[str] = None,
        scheduled_reclaim_by: Optional[str] = None,
        service: Optional[str] = None,
        service_endpoints: Optional[str] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        sub_type: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target_crn: Optional[str] = None,
        throughput: Optional[Mapping[str, float]] = None,
        timeouts: Optional[CloudantTimeoutsArgs] = None,
        type: Optional[str] = None,
        update_at: Optional[str] = None,
        update_by: Optional[str] = None) -> Cloudant

func GetCloudant(ctx *Context, name string, id IDInput, state *CloudantState, opts ...ResourceOption) (*Cloudant, error)

public static Cloudant Get(string name, Input<string> id, CloudantState? state, CustomResourceOptions? opts = null)

public static Cloudant get(String name, Output<String> id, CloudantState state, CustomResourceOptions options)

resources:  _:    type: ibm:Cloudant    get:      id: ${id}

import {
  to = ibm_cloudant.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

AccountId string

(String) An alpha-numeric value identifying the account ID.

AllowCleanup bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

Capacity double

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

CloudantId string

CorsConfig CloudantCorsConfig

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

CreatedAt string

(String) The date when the instance was created.

CreatedBy string

(String) The subject who created the instance.

Crn string

(String) CRN of the resource instance.

DashboardUrl string

(String) The dashboard URL to access resource.

DeletedAt string

(String) The date when the instance was deleted.

DeletedBy string

(String) The subject who deleted the instance.

EnableCors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

EnvironmentCrn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

Extensions Dictionary<string, string>

(Map) The extended metadata as a map associated with the resource instance.

Guid string

(String) The GUID of resource instance.

IncludeDataEvents bool

LastOperation Dictionary<string, string>

(Map) The status of the last operation requested on the instance.

LegacyCredentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

Location string

Target location or environment to create the resource instance.

Locked bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

Name string

A name for the resource instance.

OnetimeCredentials bool

A boolean that dictates if the onetime_credentials is true or false.

Parameters Dictionary<string, string>

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

ParametersJson string

Arbitrary parameters to pass in Json string format

Plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

PlanHistories List<CloudantPlanHistory>

(List of Object) The plan history of the instance.

ResourceAliasesUrl string

(String) The relative path to the resource aliases for the instance.

Deprecated: Deprecated

ResourceBindingsUrl string

(String) The relative path to the resource bindings for the instance.

Deprecated: Deprecated

ResourceControllerUrl string

(String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.

ResourceCrn string

(String) The CRN of the resource.

ResourceGroupCrn string

(String) The long ID (full CRN) of the resource group.

ResourceGroupId string

The resource group ID.

ResourceGroupName string

(String) The resource group name in which resource is provisioned.

ResourceId string

(String) The unique ID of the offering.

ResourceKeysUrl string

(String) The relative path to the resource keys for the instance.

ResourceName string

(String) The name of the resource.

ResourcePlanId string

(String) The unique ID of the plan associated with the offering.

ResourceStatus string

(String) The status of the resource.

RestoredAt string

(String) The date when the instance under reclamation was restored.

RestoredBy string

(String) The subject who restored the instance back from reclamation.

ScheduledReclaimAt string

(String) The date when the instance was scheduled for reclamation.

ScheduledReclaimBy string

(String) The subject who initiated the instance reclamation.

Service string

(String) The service type of the instance. Always cloudantnosqldb.

ServiceEndpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

State string

(String) The current state of the instance.

Status string

(String) Status of the resource instance.

SubType string

(String) The sub-type of an instance. For example, cfaas.

Tags List<string>

Tags associated with the instance.

TargetCrn string

(String) The full deployment CRN as defined in the global catalog.

Throughput Dictionary<string, double>

(Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.

Timeouts CloudantTimeouts

Type string

(String) The type of the instance. For example, service_instance.

UpdateAt string

(String) The date when the instance was last updated.

UpdateBy string

(String) The subject who updated the instance.

AccountId string

(String) An alpha-numeric value identifying the account ID.

AllowCleanup bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

Capacity float64

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

CloudantId string

CorsConfig CloudantCorsConfigArgs

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

CreatedAt string

(String) The date when the instance was created.

CreatedBy string

(String) The subject who created the instance.

Crn string

(String) CRN of the resource instance.

DashboardUrl string

(String) The dashboard URL to access resource.

DeletedAt string

(String) The date when the instance was deleted.

DeletedBy string

(String) The subject who deleted the instance.

EnableCors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

EnvironmentCrn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

Extensions map[string]string

(Map) The extended metadata as a map associated with the resource instance.

Guid string

(String) The GUID of resource instance.

IncludeDataEvents bool

LastOperation map[string]string

(Map) The status of the last operation requested on the instance.

LegacyCredentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

Location string

Target location or environment to create the resource instance.

Locked bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

Name string

A name for the resource instance.

OnetimeCredentials bool

A boolean that dictates if the onetime_credentials is true or false.

Parameters map[string]string

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

ParametersJson string

Arbitrary parameters to pass in Json string format

Plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

PlanHistories []CloudantPlanHistoryArgs

(List of Object) The plan history of the instance.

ResourceAliasesUrl string

(String) The relative path to the resource aliases for the instance.

Deprecated: Deprecated

ResourceBindingsUrl string

(String) The relative path to the resource bindings for the instance.

Deprecated: Deprecated

ResourceControllerUrl string

(String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.

ResourceCrn string

(String) The CRN of the resource.

ResourceGroupCrn string

(String) The long ID (full CRN) of the resource group.

ResourceGroupId string

The resource group ID.

ResourceGroupName string

(String) The resource group name in which resource is provisioned.

ResourceId string

(String) The unique ID of the offering.

ResourceKeysUrl string

(String) The relative path to the resource keys for the instance.

ResourceName string

(String) The name of the resource.

ResourcePlanId string

(String) The unique ID of the plan associated with the offering.

ResourceStatus string

(String) The status of the resource.

RestoredAt string

(String) The date when the instance under reclamation was restored.

RestoredBy string

(String) The subject who restored the instance back from reclamation.

ScheduledReclaimAt string

(String) The date when the instance was scheduled for reclamation.

ScheduledReclaimBy string

(String) The subject who initiated the instance reclamation.

Service string

(String) The service type of the instance. Always cloudantnosqldb.

ServiceEndpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

State string

(String) The current state of the instance.

Status string

(String) Status of the resource instance.

SubType string

(String) The sub-type of an instance. For example, cfaas.

Tags []string

Tags associated with the instance.

TargetCrn string

(String) The full deployment CRN as defined in the global catalog.

Throughput map[string]float64

(Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.

Timeouts CloudantTimeoutsArgs

Type string

(String) The type of the instance. For example, service_instance.

UpdateAt string

(String) The date when the instance was last updated.

UpdateBy string

(String) The subject who updated the instance.

account_id string

(String) An alpha-numeric value identifying the account ID.

allow_cleanup bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

capacity number

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudant_id string

cors_config object

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

created_at string

(String) The date when the instance was created.

created_by string

(String) The subject who created the instance.

crn string

(String) CRN of the resource instance.

dashboard_url string

(String) The dashboard URL to access resource.

deleted_at string

(String) The date when the instance was deleted.

deleted_by string

(String) The subject who deleted the instance.

enable_cors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environment_crn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

extensions map(string)

(Map) The extended metadata as a map associated with the resource instance.

guid string

(String) The GUID of resource instance.

include_data_events bool

last_operation map(string)

(Map) The status of the last operation requested on the instance.

legacy_credentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

location string

Target location or environment to create the resource instance.

locked bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

name string

A name for the resource instance.

onetime_credentials bool

A boolean that dictates if the onetime_credentials is true or false.

parameters map(string)

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

parameters_json string

Arbitrary parameters to pass in Json string format

plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

plan_histories list(object)

(List of Object) The plan history of the instance.

resource_aliases_url string

(String) The relative path to the resource aliases for the instance.

Deprecated: Deprecated

resource_bindings_url string

(String) The relative path to the resource bindings for the instance.

Deprecated: Deprecated

resource_controller_url string

(String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.

resource_crn string

(String) The CRN of the resource.

resource_group_crn string

(String) The long ID (full CRN) of the resource group.

resource_group_id string

The resource group ID.

resource_group_name string

(String) The resource group name in which resource is provisioned.

resource_id string

(String) The unique ID of the offering.

resource_keys_url string

(String) The relative path to the resource keys for the instance.

resource_name string

(String) The name of the resource.

resource_plan_id string

(String) The unique ID of the plan associated with the offering.

resource_status string

(String) The status of the resource.

restored_at string

(String) The date when the instance under reclamation was restored.

restored_by string

(String) The subject who restored the instance back from reclamation.

scheduled_reclaim_at string

(String) The date when the instance was scheduled for reclamation.

scheduled_reclaim_by string

(String) The subject who initiated the instance reclamation.

service string

(String) The service type of the instance. Always cloudantnosqldb.

service_endpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

state string

(String) The current state of the instance.

status string

(String) Status of the resource instance.

sub_type string

(String) The sub-type of an instance. For example, cfaas.

tags list(string)

Tags associated with the instance.

target_crn string

(String) The full deployment CRN as defined in the global catalog.

throughput map(number)

(Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.

timeouts object

type string

(String) The type of the instance. For example, service_instance.

update_at string

(String) The date when the instance was last updated.

update_by string

(String) The subject who updated the instance.

accountId String

(String) An alpha-numeric value identifying the account ID.

allowCleanup Boolean

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

capacity Double

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudantId String

corsConfig CloudantCorsConfig

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

createdAt String

(String) The date when the instance was created.

createdBy String

(String) The subject who created the instance.

crn String

(String) CRN of the resource instance.

dashboardUrl String

(String) The dashboard URL to access resource.

deletedAt String

(String) The date when the instance was deleted.

deletedBy String

(String) The subject who deleted the instance.

enableCors Boolean

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environmentCrn String

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

extensions Map<String,String>

(Map) The extended metadata as a map associated with the resource instance.

guid String

(String) The GUID of resource instance.

includeDataEvents Boolean

lastOperation Map<String,String>

(Map) The status of the last operation requested on the instance.

legacyCredentials Boolean

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

location String

Target location or environment to create the resource instance.

locked Boolean

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

name String

A name for the resource instance.

onetimeCredentials Boolean

A boolean that dictates if the onetime_credentials is true or false.

parameters Map<String,String>

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

parametersJson String

Arbitrary parameters to pass in Json string format

plan String

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

planHistories List<CloudantPlanHistory>

(List of Object) The plan history of the instance.

resourceAliasesUrl String

(String) The relative path to the resource aliases for the instance.

Deprecated: Deprecated

resourceBindingsUrl String

(String) The relative path to the resource bindings for the instance.

Deprecated: Deprecated

resourceControllerUrl String

(String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.

resourceCrn String

(String) The CRN of the resource.

resourceGroupCrn String

(String) The long ID (full CRN) of the resource group.

resourceGroupId String

The resource group ID.

resourceGroupName String

(String) The resource group name in which resource is provisioned.

resourceId String

(String) The unique ID of the offering.

resourceKeysUrl String

(String) The relative path to the resource keys for the instance.

resourceName String

(String) The name of the resource.

resourcePlanId String

(String) The unique ID of the plan associated with the offering.

resourceStatus String

(String) The status of the resource.

restoredAt String

(String) The date when the instance under reclamation was restored.

restoredBy String

(String) The subject who restored the instance back from reclamation.

scheduledReclaimAt String

(String) The date when the instance was scheduled for reclamation.

scheduledReclaimBy String

(String) The subject who initiated the instance reclamation.

service String

(String) The service type of the instance. Always cloudantnosqldb.

serviceEndpoints String

Types of the service endpoints. Possible values are public, private, public-and-private.

state String

(String) The current state of the instance.

status String

(String) Status of the resource instance.

subType String

(String) The sub-type of an instance. For example, cfaas.

tags List<String>

Tags associated with the instance.

targetCrn String

(String) The full deployment CRN as defined in the global catalog.

throughput Map<String,Double>

(Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.

timeouts CloudantTimeouts

type String

(String) The type of the instance. For example, service_instance.

updateAt String

(String) The date when the instance was last updated.

updateBy String

(String) The subject who updated the instance.

accountId string

(String) An alpha-numeric value identifying the account ID.

allowCleanup boolean

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

capacity number

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudantId string

corsConfig CloudantCorsConfig

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

createdAt string

(String) The date when the instance was created.

createdBy string

(String) The subject who created the instance.

crn string

(String) CRN of the resource instance.

dashboardUrl string

(String) The dashboard URL to access resource.

deletedAt string

(String) The date when the instance was deleted.

deletedBy string

(String) The subject who deleted the instance.

enableCors boolean

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environmentCrn string

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

extensions {[key: string]: string}

(Map) The extended metadata as a map associated with the resource instance.

guid string

(String) The GUID of resource instance.

includeDataEvents boolean

lastOperation {[key: string]: string}

(Map) The status of the last operation requested on the instance.

legacyCredentials boolean

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

location string

Target location or environment to create the resource instance.

locked boolean

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

name string

A name for the resource instance.

onetimeCredentials boolean

A boolean that dictates if the onetime_credentials is true or false.

parameters {[key: string]: string}

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

parametersJson string

Arbitrary parameters to pass in Json string format

plan string

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

planHistories CloudantPlanHistory[]

(List of Object) The plan history of the instance.

resourceAliasesUrl string

(String) The relative path to the resource aliases for the instance.

Deprecated: Deprecated

resourceBindingsUrl string

(String) The relative path to the resource bindings for the instance.

Deprecated: Deprecated

resourceControllerUrl string

(String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.

resourceCrn string

(String) The CRN of the resource.

resourceGroupCrn string

(String) The long ID (full CRN) of the resource group.

resourceGroupId string

The resource group ID.

resourceGroupName string

(String) The resource group name in which resource is provisioned.

resourceId string

(String) The unique ID of the offering.

resourceKeysUrl string

(String) The relative path to the resource keys for the instance.

resourceName string

(String) The name of the resource.

resourcePlanId string

(String) The unique ID of the plan associated with the offering.

resourceStatus string

(String) The status of the resource.

restoredAt string

(String) The date when the instance under reclamation was restored.

restoredBy string

(String) The subject who restored the instance back from reclamation.

scheduledReclaimAt string

(String) The date when the instance was scheduled for reclamation.

scheduledReclaimBy string

(String) The subject who initiated the instance reclamation.

service string

(String) The service type of the instance. Always cloudantnosqldb.

serviceEndpoints string

Types of the service endpoints. Possible values are public, private, public-and-private.

state string

(String) The current state of the instance.

status string

(String) Status of the resource instance.

subType string

(String) The sub-type of an instance. For example, cfaas.

tags string[]

Tags associated with the instance.

targetCrn string

(String) The full deployment CRN as defined in the global catalog.

throughput {[key: string]: number}

(Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.

timeouts CloudantTimeouts

type string

(String) The type of the instance. For example, service_instance.

updateAt string

(String) The date when the instance was last updated.

updateBy string

(String) The subject who updated the instance.

account_id str

(String) An alpha-numeric value identifying the account ID.

allow_cleanup bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

capacity float

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudant_id str

cors_config CloudantCorsConfigArgs

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

created_at str

(String) The date when the instance was created.

created_by str

(String) The subject who created the instance.

crn str

(String) CRN of the resource instance.

dashboard_url str

(String) The dashboard URL to access resource.

deleted_at str

(String) The date when the instance was deleted.

deleted_by str

(String) The subject who deleted the instance.

enable_cors bool

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environment_crn str

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

extensions Mapping[str, str]

(Map) The extended metadata as a map associated with the resource instance.

guid str

(String) The GUID of resource instance.

include_data_events bool

last_operation Mapping[str, str]

(Map) The status of the last operation requested on the instance.

legacy_credentials bool

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

location str

Target location or environment to create the resource instance.

locked bool

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

name str

A name for the resource instance.

onetime_credentials bool

A boolean that dictates if the onetime_credentials is true or false.

parameters Mapping[str, str]

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

parameters_json str

Arbitrary parameters to pass in Json string format

plan str

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

plan_histories Sequence[CloudantPlanHistoryArgs]

(List of Object) The plan history of the instance.

resource_aliases_url str

(String) The relative path to the resource aliases for the instance.

Deprecated: Deprecated

resource_bindings_url str

(String) The relative path to the resource bindings for the instance.

Deprecated: Deprecated

resource_controller_url str

(String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.

resource_crn str

(String) The CRN of the resource.

resource_group_crn str

(String) The long ID (full CRN) of the resource group.

resource_group_id str

The resource group ID.

resource_group_name str

(String) The resource group name in which resource is provisioned.

resource_id str

(String) The unique ID of the offering.

resource_keys_url str

(String) The relative path to the resource keys for the instance.

resource_name str

(String) The name of the resource.

resource_plan_id str

(String) The unique ID of the plan associated with the offering.

resource_status str

(String) The status of the resource.

restored_at str

(String) The date when the instance under reclamation was restored.

restored_by str

(String) The subject who restored the instance back from reclamation.

scheduled_reclaim_at str

(String) The date when the instance was scheduled for reclamation.

scheduled_reclaim_by str

(String) The subject who initiated the instance reclamation.

service str

(String) The service type of the instance. Always cloudantnosqldb.

service_endpoints str

Types of the service endpoints. Possible values are public, private, public-and-private.

state str

(String) The current state of the instance.

status str

(String) Status of the resource instance.

sub_type str

(String) The sub-type of an instance. For example, cfaas.

tags Sequence[str]

Tags associated with the instance.

target_crn str

(String) The full deployment CRN as defined in the global catalog.

throughput Mapping[str, float]

(Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.

timeouts CloudantTimeoutsArgs

type str

(String) The type of the instance. For example, service_instance.

update_at str

(String) The date when the instance was last updated.

update_by str

(String) The subject who updated the instance.

accountId String

(String) An alpha-numeric value identifying the account ID.

allowCleanup Boolean

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

capacity Number

A number of blocks of throughput units.The default value is 1. Capacity modification is not supported for the lite plan.

cloudantId String

corsConfig Property Map

Configuration for CORS. Requires enable_cors to be true.

Nested scheme for cors_config:

Constraints: The minimum length is 1 item.

createdAt String

(String) The date when the instance was created.

createdBy String

(String) The subject who created the instance.

crn String

(String) CRN of the resource instance.

dashboardUrl String

(String) The dashboard URL to access resource.

deletedAt String

(String) The date when the instance was deleted.

deletedBy String

(String) The subject who deleted the instance.

enableCors Boolean

Boolean value to enable CORS. The default value is true. If it is set to false, then customizing cors_config is not allowed.

environmentCrn String

Gen 1 dedicated hardware plan only. CRN of the IBM Cloudant Dedicated Hardware plan instance.

extensions Map<String>

(Map) The extended metadata as a map associated with the resource instance.

guid String

(String) The GUID of resource instance.

includeDataEvents Boolean

lastOperation Map<String>

(Map) The status of the last operation requested on the instance.

legacyCredentials Boolean

Gen 1 only. Use both legacy credentials and IAM for authentication. The default value is false.

location String

Target location or environment to create the resource instance.

locked Boolean

(Boolean) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

name String

A name for the resource instance.

onetimeCredentials Boolean

A boolean that dictates if the onetime_credentials is true or false.

parameters Map<String>

Arbitrary parameters to pass. Must be a JSON object. Typed schema attributes always take precedence over any conflicting values supplied here.

parametersJson String

Arbitrary parameters to pass in Json string format

plan String

The plan type of the service. Plan transitions between Gen 1 and Gen 2, or between dedicated and non-dedicated plans, are not supported.

planHistories List<Property Map>

(List of Object) The plan history of the instance.

resourceAliasesUrl String

(String) The relative path to the resource aliases for the instance.

Deprecated: Deprecated

resourceBindingsUrl String

(String) The relative path to the resource bindings for the instance.

Deprecated: Deprecated

resourceControllerUrl String

(String) The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource.

resourceCrn String

(String) The CRN of the resource.

resourceGroupCrn String

(String) The long ID (full CRN) of the resource group.

resourceGroupId String

The resource group ID.

resourceGroupName String

(String) The resource group name in which resource is provisioned.

resourceId String

(String) The unique ID of the offering.

resourceKeysUrl String

(String) The relative path to the resource keys for the instance.

resourceName String

(String) The name of the resource.

resourcePlanId String

(String) The unique ID of the plan associated with the offering.

resourceStatus String

(String) The status of the resource.

restoredAt String

(String) The date when the instance under reclamation was restored.

restoredBy String

(String) The subject who restored the instance back from reclamation.

scheduledReclaimAt String

(String) The date when the instance was scheduled for reclamation.

scheduledReclaimBy String

(String) The subject who initiated the instance reclamation.

service String

(String) The service type of the instance. Always cloudantnosqldb.

serviceEndpoints String

Types of the service endpoints. Possible values are public, private, public-and-private.

state String

(String) The current state of the instance.

status String

(String) Status of the resource instance.

subType String

(String) The sub-type of an instance. For example, cfaas.

tags List<String>

Tags associated with the instance.

targetCrn String

(String) The full deployment CRN as defined in the global catalog.

throughput Map<Number>

(Map of Number) Gen 1 only. Detailed information about throughput capacity with breakdown by specific throughput requests classes. Not populated for Gen 2 instances.

timeouts Property Map

type String

(String) The type of the instance. For example, service_instance.

updateAt String

(String) The date when the instance was last updated.

updateBy String

(String) The subject who updated the instance.

Supporting Types

CloudantCorsConfig, CloudantCorsConfigArgs

Origins List<string>: An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.
AllowCredentials bool: Boolean value to allow authentication credentials. If set to true, browser requests must be done by setting XmlHttpRequest.withCredentials = true on the request object. The default value is true.

Origins []string: An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.
AllowCredentials bool: Boolean value to allow authentication credentials. If set to true, browser requests must be done by setting XmlHttpRequest.withCredentials = true on the request object. The default value is true.

origins list(string): An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.
allow_credentials bool: Boolean value to allow authentication credentials. If set to true, browser requests must be done by setting XmlHttpRequest.withCredentials = true on the request object. The default value is true.

origins List<String>: An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.
allowCredentials Boolean: Boolean value to allow authentication credentials. If set to true, browser requests must be done by setting XmlHttpRequest.withCredentials = true on the request object. The default value is true.

origins string[]: An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.
allowCredentials boolean: Boolean value to allow authentication credentials. If set to true, browser requests must be done by setting XmlHttpRequest.withCredentials = true on the request object. The default value is true.

origins Sequence[str]: An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.
allow_credentials bool: Boolean value to allow authentication credentials. If set to true, browser requests must be done by setting XmlHttpRequest.withCredentials = true on the request object. The default value is true.

origins List<String>: An array of strings that contain allowed origin domains. You have to specify the full URL including the protocol. It is recommended that only the HTTPS protocol is used. Subdomains count as separate domains, so you have to specify all subdomains used.
allowCredentials Boolean: Boolean value to allow authentication credentials. If set to true, browser requests must be done by setting XmlHttpRequest.withCredentials = true on the request object. The default value is true.

CloudantPlanHistory, CloudantPlanHistoryArgs

ResourcePlanId string: (String) The unique ID of the plan associated with the offering.
StartDate string

ResourcePlanId string: (String) The unique ID of the plan associated with the offering.
StartDate string

resource_plan_id string: (String) The unique ID of the plan associated with the offering.
start_date string

resourcePlanId String: (String) The unique ID of the plan associated with the offering.
startDate String

resourcePlanId string: (String) The unique ID of the plan associated with the offering.
startDate string

resource_plan_id str: (String) The unique ID of the plan associated with the offering.
start_date str

resourcePlanId String: (String) The unique ID of the plan associated with the offering.
startDate String

CloudantTimeouts, CloudantTimeoutsArgs

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 string
delete string
update string

create str
delete str
update str

create String
delete String
update String

Import

Example

$ pulumi import ibm:index/cloudant:Cloudant mycloudant "crn:v1:bluemix:public:cloudantnosqldb:us-south:a/abc123abc123abc123abc1:abc123ab-1234-1234-abc1-abc123abc123::"

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.

Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

ibm.Cloudant

On this page

On this page

Example Usage

Gen 1

Gen 2

Create Cloudant Resource

Constructor syntax

Parameters

Constructor example

Cloudant Resource Properties

Inputs

Outputs

Look up Existing Cloudant Resource

Supporting Types

CloudantCorsConfig, CloudantCorsConfigArgs

CloudantPlanHistory, CloudantPlanHistoryArgs

CloudantTimeouts, CloudantTimeoutsArgs

Import

Example

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

ibm.Cloudant

On this page

On this page

Example Usage

Gen 1

Gen 2

Create Cloudant Resource

Constructor syntax

Parameters

Constructor example

Cloudant Resource Properties

Inputs

Outputs

Look up Existing Cloudant Resource

Supporting Types

CloudantCorsConfig, CloudantCorsConfigArgs

CloudantPlanHistory, CloudantPlanHistoryArgs

CloudantTimeouts, CloudantTimeoutsArgs

Import

Example

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.