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

ibm.ResourceInstance

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

    Create, update, or delete an IAM enabled service instance. For more information, about resource instance, see assigning access to resources.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetResourceGroupArgs;
    import com.pulumi.ibm.ResourceInstance;
    import com.pulumi.ibm.ResourceInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var group = IbmFunctions.getResourceGroup(GetResourceGroupArgs.builder()
                .name("test")
                .build());
    
            var resourceInstance = new ResourceInstance("resourceInstance", ResourceInstanceArgs.builder()
                .service("cloud-object-storage")
                .plan("standard")
                .location("global")
                .resourceGroupId(group.applyValue(getResourceGroupResult -> getResourceGroupResult.id()))
                .tags(            
                    "tag1",
                    "tag2")
                .timeouts(ResourceInstanceTimeoutsArgs.builder()
                    .create("15m")
                    .update("15m")
                    .delete("15m")
                    .build())
                .build());
    
        }
    }
    
    resources:
      resourceInstance:
        type: ibm:ResourceInstance
        properties:
          service: cloud-object-storage
          plan: standard
          location: global
          resourceGroupId: ${group.id}
          tags:
            - tag1
            - tag2
          # User can increase timeouts
          timeouts:
            - create: 15m
              update: 15m
              delete: 15m
    variables:
      group:
        fn::invoke:
          function: ibm:getResourceGroup
          arguments:
            name: test
    

    Example to provision a Cloud Logs instance

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const logsInstance = new ibm.ResourceInstance("logsInstance", {
        location: "eu-de",
        parameters: {
            logs_bucket_crn: "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:logs-bucket",
            logs_bucket_endpoint: "s3.direct.eu-de.cloud-object-storage.appdomain.cloud",
            metrics_bucket_crn: "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:metrics-bucket",
            metrics_bucket_endpoint: "s3.direct.eu-de.cloud-object-storage.appdomain.cloud",
            retention_period: "14",
        },
        plan: "standard",
        service: "logs",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    logs_instance = ibm.ResourceInstance("logsInstance",
        location="eu-de",
        parameters={
            "logs_bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:logs-bucket",
            "logs_bucket_endpoint": "s3.direct.eu-de.cloud-object-storage.appdomain.cloud",
            "metrics_bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:metrics-bucket",
            "metrics_bucket_endpoint": "s3.direct.eu-de.cloud-object-storage.appdomain.cloud",
            "retention_period": "14",
        },
        plan="standard",
        service="logs")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.NewResourceInstance(ctx, "logsInstance", &ibm.ResourceInstanceArgs{
    			Location: pulumi.String("eu-de"),
    			Parameters: pulumi.StringMap{
    				"logs_bucket_crn":         pulumi.String("crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:logs-bucket"),
    				"logs_bucket_endpoint":    pulumi.String("s3.direct.eu-de.cloud-object-storage.appdomain.cloud"),
    				"metrics_bucket_crn":      pulumi.String("crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:metrics-bucket"),
    				"metrics_bucket_endpoint": pulumi.String("s3.direct.eu-de.cloud-object-storage.appdomain.cloud"),
    				"retention_period":        pulumi.String("14"),
    			},
    			Plan:    pulumi.String("standard"),
    			Service: pulumi.String("logs"),
    		})
    		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 logsInstance = new Ibm.ResourceInstance("logsInstance", new()
        {
            Location = "eu-de",
            Parameters = 
            {
                { "logs_bucket_crn", "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:logs-bucket" },
                { "logs_bucket_endpoint", "s3.direct.eu-de.cloud-object-storage.appdomain.cloud" },
                { "metrics_bucket_crn", "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:metrics-bucket" },
                { "metrics_bucket_endpoint", "s3.direct.eu-de.cloud-object-storage.appdomain.cloud" },
                { "retention_period", "14" },
            },
            Plan = "standard",
            Service = "logs",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.ResourceInstance;
    import com.pulumi.ibm.ResourceInstanceArgs;
    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 logsInstance = new ResourceInstance("logsInstance", ResourceInstanceArgs.builder()
                .location("eu-de")
                .parameters(Map.ofEntries(
                    Map.entry("logs_bucket_crn", "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:logs-bucket"),
                    Map.entry("logs_bucket_endpoint", "s3.direct.eu-de.cloud-object-storage.appdomain.cloud"),
                    Map.entry("metrics_bucket_crn", "crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:metrics-bucket"),
                    Map.entry("metrics_bucket_endpoint", "s3.direct.eu-de.cloud-object-storage.appdomain.cloud"),
                    Map.entry("retention_period", "14")
                ))
                .plan("standard")
                .service("logs")
                .build());
    
        }
    }
    
    resources:
      logsInstance:
        type: ibm:ResourceInstance
        properties:
          location: eu-de
          parameters:
            logs_bucket_crn: crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:logs-bucket
            logs_bucket_endpoint: s3.direct.eu-de.cloud-object-storage.appdomain.cloud
            metrics_bucket_crn: crn:v1:bluemix:public:cloud-object-storage:global:a/4448261269a14562b839e0a3019ed980:f8b3176e-af8e-4e14-a2f9-7f82634e7f0b:bucket:metrics-bucket
            metrics_bucket_endpoint: s3.direct.eu-de.cloud-object-storage.appdomain.cloud
            retention_period: '14'
          plan: standard
          service: logs
    

    Example to provision a Hyper Protect DBaaS service instance

    The following example enables you to create a service instance of IBM Cloud Hyper Protect DBaaS for MongoDB. For detailed argument reference, see the tables in the Hyper Protect DBaaS for MongoDB documentation, or the Hyper Protect DBaaS for PostgreSQL documentation to create PostgreSQL service instances.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetResourceGroupArgs;
    import com.pulumi.ibm.ResourceInstance;
    import com.pulumi.ibm.ResourceInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var group = IbmFunctions.getResourceGroup(GetResourceGroupArgs.builder()
                .name("default")
                .build());
    
            var myhpdbcluster = new ResourceInstance("myhpdbcluster", ResourceInstanceArgs.builder()
                .service("hyperp-dbaas-mongodb")
                .plan("mongodb-flexible")
                .location("us-south")
                .resourceGroupId(group.applyValue(getResourceGroupResult -> getResourceGroupResult.id()))
                .timeouts(ResourceInstanceTimeoutsArgs.builder()
                    .create("15m")
                    .update("15m")
                    .delete("15m")
                    .build())
                .parameters(Map.ofEntries(
                    Map.entry("name", "cluster01"),
                    Map.entry("admin_name", "admin"),
                    Map.entry("password", "Hyperprotectdbaas0001"),
                    Map.entry("confirm_password", "Hyperprotectdbaas0001"),
                    Map.entry("db_version", "4.4"),
                    Map.entry("cpu", "1"),
                    Map.entry("kms_instance", "crn:v1:staging:public:kms:us-south:a/23a24a3e3fe7a115473f07be1c44bdb5:9eeb285a-88e4-4378-b7cf-dbdcd97b5e4e::"),
                    Map.entry("kms_key", "ee742940-d87c-48de-abc9-d26a6184ba5a"),
                    Map.entry("memory", "2gib"),
                    Map.entry("private_endpoint_type", "vpe"),
                    Map.entry("service-endpoints", "public-and-private"),
                    Map.entry("storage", "5gib")
                ))
                .build());
    
        }
    }
    
    resources:
      myhpdbcluster:
        type: ibm:ResourceInstance
        properties:
          service: hyperp-dbaas-mongodb
          plan: mongodb-flexible
          location: us-south
          resourceGroupId: ${group.id}
          # User can increase timeouts
          timeouts:
            - create: 15m
              update: 15m
              delete: 15m
          parameters:
            name: cluster01
            admin_name: admin
            password: Hyperprotectdbaas0001
            confirm_password: Hyperprotectdbaas0001
            db_version: '4.4'
            cpu: '1'
            kms_instance: 'crn:v1:staging:public:kms:us-south:a/23a24a3e3fe7a115473f07be1c44bdb5:9eeb285a-88e4-4378-b7cf-dbdcd97b5e4e::'
            kms_key: ee742940-d87c-48de-abc9-d26a6184ba5a
            memory: 2gib
            private_endpoint_type: vpe
            service-endpoints: public-and-private
            storage: 5gib
    variables:
      group:
        fn::invoke:
          function: ibm:getResourceGroup
          arguments:
            name: default
    

    Example to provision a Watson Query service instance

    The following example enables you to create a service instance of IBM Watson Query. For detailed argument reference, see the tables in the Watson Query documentation.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetResourceGroupArgs;
    import com.pulumi.ibm.ResourceInstance;
    import com.pulumi.ibm.ResourceInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var group = IbmFunctions.getResourceGroup(GetResourceGroupArgs.builder()
                .name("default")
                .build());
    
            var wqInstance1 = new ResourceInstance("wqInstance1", ResourceInstanceArgs.builder()
                .service("data-virtualization")
                .plan("data-virtualization-enterprise")
                .location("us-south")
                .resourceGroupId(group.applyValue(getResourceGroupResult -> getResourceGroupResult.id()))
                .timeouts(ResourceInstanceTimeoutsArgs.builder()
                    .create("15m")
                    .update("15m")
                    .delete("15m")
                    .build())
                .build());
    
        }
    }
    
    resources:
      wqInstance1:
        type: ibm:ResourceInstance
        properties:
          service: data-virtualization
          plan: data-virtualization-enterprise
          # "data-virtualization-enterprise-dev","data-virtualization-enterprise-preprod","data-virtualization-enterprise-dev-stable"
          location: us-south
          # "eu-gb", "eu-de", "jp-tok"
          resourceGroupId: ${group.id}
          timeouts:
            - create: 15m
              update: 15m
              delete: 15m
    variables:
      group:
        fn::invoke:
          function: ibm:getResourceGroup
          arguments:
            name: default
    

    Example to provision a Analytics Engine using parameters_json argument

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.ResourceInstance;
    import com.pulumi.ibm.ResourceInstanceArgs;
    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 instance = new ResourceInstance("instance", ResourceInstanceArgs.builder()
                .plan("standard-hourly")
                .location("us-south")
                .service("ibmanalyticsengine")
                .parametersJson("""
        {
          "num_compute_nodes": "1",
          "hardware_config": "default",
          "software_package": "ae-1.2-hadoop-spark",
          "autoscale_policy": {
          "task_nodes": {
            "num_min_nodes": 1,
            "num_max_nodes": 10,
            "scaleup_rule": {
              "sustained_demand_period_minutes": "10",
              "percentage_of_demand": "50"
            },
            "scaledown_rule": {
              "sustained_excess_period_minutes": "20",
              "percentage_of_excess": "25"
            }
          }
        }
      }
                """)
                .tags("my-tag")
                .timeouts(ResourceInstanceTimeoutsArgs.builder()
                    .create("30m")
                    .update("15m")
                    .delete("15m")
                    .build())
                .build());
    
        }
    }
    
    resources:
      instance:
        type: ibm:ResourceInstance
        properties:
          plan: standard-hourly
          location: us-south
          service: ibmanalyticsengine
          parametersJson: |2
                {
                  "num_compute_nodes": "1",
                  "hardware_config": "default",
                  "software_package": "ae-1.2-hadoop-spark",
                  "autoscale_policy": {
                  "task_nodes": {
                    "num_min_nodes": 1,
                    "num_max_nodes": 10,
                    "scaleup_rule": {
                      "sustained_demand_period_minutes": "10",
                      "percentage_of_demand": "50"
                    },
                    "scaledown_rule": {
                      "sustained_excess_period_minutes": "20",
                      "percentage_of_excess": "25"
                    }
                  }
                }
              }
          tags:
            - my-tag
          timeouts:
            - create: 30m
              update: 15m
              delete: 15m
    

    Example to provision an OpenPages service instance

    The following example enables you to create a service instance of OpenPages.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetResourceGroupArgs;
    import com.pulumi.ibm.ResourceInstance;
    import com.pulumi.ibm.ResourceInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var group = IbmFunctions.getResourceGroup(GetResourceGroupArgs.builder()
                .name("default")
                .build());
    
            var openpagesInstance = new ResourceInstance("openpagesInstance", ResourceInstanceArgs.builder()
                .service("openpages")
                .plan("essentials")
                .location("global")
                .resourceGroupId(data.ibm_resource_group().default_group().id())
                .parametersJson("""
        {
          "aws_region": "us-east-1",
          "baseCurrency": "USD",
          "selectedSolutions": ["ORM"]
        }
                """)
                .timeouts(ResourceInstanceTimeoutsArgs.builder()
                    .create("200m")
                    .build())
                .build());
    
        }
    }
    
    resources:
      openpagesInstance:
        type: ibm:ResourceInstance
        properties:
          service: openpages
          plan: essentials
          location: global
          resourceGroupId: ${data.ibm_resource_group.default_group.id}
          parametersJson: |2
                {
                  "aws_region": "us-east-1",
                  "baseCurrency": "USD",
                  "selectedSolutions": ["ORM"]
                }
          timeouts:
            - create: 200m
    variables:
      group:
        fn::invoke:
          function: ibm:getResourceGroup
          arguments:
            name: default
    

    Create ResourceInstance Resource

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

    Constructor syntax

    new ResourceInstance(name: string, args: ResourceInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def ResourceInstance(resource_name: str,
                         args: ResourceInstanceArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ResourceInstance(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         location: Optional[str] = None,
                         plan: Optional[str] = None,
                         service: Optional[str] = None,
                         name: Optional[str] = None,
                         parameters: Optional[Mapping[str, str]] = None,
                         parameters_json: Optional[str] = None,
                         resource_group_id: Optional[str] = None,
                         resource_instance_id: Optional[str] = None,
                         service_endpoints: Optional[str] = None,
                         tags: Optional[Sequence[str]] = None,
                         timeouts: Optional[ResourceInstanceTimeoutsArgs] = None)
    func NewResourceInstance(ctx *Context, name string, args ResourceInstanceArgs, opts ...ResourceOption) (*ResourceInstance, error)
    public ResourceInstance(string name, ResourceInstanceArgs args, CustomResourceOptions? opts = null)
    public ResourceInstance(String name, ResourceInstanceArgs args)
    public ResourceInstance(String name, ResourceInstanceArgs args, CustomResourceOptions options)
    
    type: ibm:ResourceInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ResourceInstanceArgs
    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 ResourceInstanceArgs
    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 ResourceInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceInstanceArgs
    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 resourceInstanceResource = new Ibm.ResourceInstance("resourceInstanceResource", new()
    {
        Location = "string",
        Plan = "string",
        Service = "string",
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
        ParametersJson = "string",
        ResourceGroupId = "string",
        ResourceInstanceId = "string",
        ServiceEndpoints = "string",
        Tags = new[]
        {
            "string",
        },
        Timeouts = new Ibm.Inputs.ResourceInstanceTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := ibm.NewResourceInstance(ctx, "resourceInstanceResource", &ibm.ResourceInstanceArgs{
    	Location: pulumi.String("string"),
    	Plan:     pulumi.String("string"),
    	Service:  pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ParametersJson:     pulumi.String("string"),
    	ResourceGroupId:    pulumi.String("string"),
    	ResourceInstanceId: pulumi.String("string"),
    	ServiceEndpoints:   pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Timeouts: &ibm.ResourceInstanceTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var resourceInstanceResource = new ResourceInstance("resourceInstanceResource", ResourceInstanceArgs.builder()
        .location("string")
        .plan("string")
        .service("string")
        .name("string")
        .parameters(Map.of("string", "string"))
        .parametersJson("string")
        .resourceGroupId("string")
        .resourceInstanceId("string")
        .serviceEndpoints("string")
        .tags("string")
        .timeouts(ResourceInstanceTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    resource_instance_resource = ibm.ResourceInstance("resourceInstanceResource",
        location="string",
        plan="string",
        service="string",
        name="string",
        parameters={
            "string": "string",
        },
        parameters_json="string",
        resource_group_id="string",
        resource_instance_id="string",
        service_endpoints="string",
        tags=["string"],
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const resourceInstanceResource = new ibm.ResourceInstance("resourceInstanceResource", {
        location: "string",
        plan: "string",
        service: "string",
        name: "string",
        parameters: {
            string: "string",
        },
        parametersJson: "string",
        resourceGroupId: "string",
        resourceInstanceId: "string",
        serviceEndpoints: "string",
        tags: ["string"],
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: ibm:ResourceInstance
    properties:
        location: string
        name: string
        parameters:
            string: string
        parametersJson: string
        plan: string
        resourceGroupId: string
        resourceInstanceId: string
        service: string
        serviceEndpoints: string
        tags:
            - string
        timeouts:
            create: string
            delete: string
            update: string
    

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

    Location string
    Target location or environment to create the resource instance.
    Plan string
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    Service string
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    Name string
    A descriptive name used to identify the resource instance.
    Parameters Dictionary<string, string>
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    ParametersJson string
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    ResourceGroupId string
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    ResourceInstanceId string
    (String) The unique identifier of the new resource instance.
    ServiceEndpoints string
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    Tags List<string>
    Tags associated with the instance.
    Timeouts ResourceInstanceTimeouts
    Location string
    Target location or environment to create the resource instance.
    Plan string
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    Service string
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    Name string
    A descriptive name used to identify the resource instance.
    Parameters map[string]string
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    ParametersJson string
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    ResourceGroupId string
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    ResourceInstanceId string
    (String) The unique identifier of the new resource instance.
    ServiceEndpoints string
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    Tags []string
    Tags associated with the instance.
    Timeouts ResourceInstanceTimeoutsArgs
    location String
    Target location or environment to create the resource instance.
    plan String
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    service String
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    name String
    A descriptive name used to identify the resource instance.
    parameters Map<String,String>
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parametersJson String
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    resourceGroupId String
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resourceInstanceId String
    (String) The unique identifier of the new resource instance.
    serviceEndpoints String
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    tags List<String>
    Tags associated with the instance.
    timeouts ResourceInstanceTimeouts
    location string
    Target location or environment to create the resource instance.
    plan string
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    service string
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    name string
    A descriptive name used to identify the resource instance.
    parameters {[key: string]: string}
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parametersJson string
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    resourceGroupId string
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resourceInstanceId string
    (String) The unique identifier of the new resource instance.
    serviceEndpoints string
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    tags string[]
    Tags associated with the instance.
    timeouts ResourceInstanceTimeouts
    location str
    Target location or environment to create the resource instance.
    plan str
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    service str
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    name str
    A descriptive name used to identify the resource instance.
    parameters Mapping[str, str]
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parameters_json str
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    resource_group_id str
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resource_instance_id str
    (String) The unique identifier of the new resource instance.
    service_endpoints str
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    tags Sequence[str]
    Tags associated with the instance.
    timeouts ResourceInstanceTimeoutsArgs
    location String
    Target location or environment to create the resource instance.
    plan String
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    service String
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    name String
    A descriptive name used to identify the resource instance.
    parameters Map<String>
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parametersJson String
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    resourceGroupId String
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resourceInstanceId String
    (String) The unique identifier of the new resource instance.
    serviceEndpoints String
    Types of the service endpoints that can be set to a resource instance. 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 ResourceInstance resource produces the following output properties:

    AccountId string
    (String) An alpha-numeric value identifying the account ID.
    AllowCleanup bool
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    CreatedAt string
    (Timestamp) The date when the instance created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    CRN of resource instance
    DashboardUrl string
    (String) The dashboard URL of the new resource instance.
    DeletedAt string
    (Timestamp) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions Dictionary<string, string>
    (String) The extended metadata as a map associated with the resource instance.
    Guid string
    (String) The GUID of the resource instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperation Dictionary<string, string>
    (String) The status of the last operation requested on the instance.
    Locked bool
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    OnetimeCredentials bool
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    PlanHistories List<ResourceInstancePlanHistory>
    (String) The plan history of the instance.
    ResourceAliasesUrl string
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    ResourceBindingsUrl string
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    ResourceCrn string
    The crn of the resource
    ResourceGroupCrn string
    (String) The long ID (full CRN) of the resource group.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceId string
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    ResourceName string
    The name of the resource
    ResourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    ResourceStatus string
    The status of the resource
    RestoredAt string
    (Timestamp) The date when the instance under reclamation restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    ScheduledReclaimAt string
    (Timestamp) The date when the instance scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) The status of resource instance.
    SubType string
    (String) The sub-type of instance, for example, cfaas.
    TargetCrn string
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    Type string
    (String) The type of the instance. For example, service_instance.
    UpdateAt string
    (Timestamp) The date when the instance last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    AccountId string
    (String) An alpha-numeric value identifying the account ID.
    AllowCleanup bool
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    CreatedAt string
    (Timestamp) The date when the instance created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    CRN of resource instance
    DashboardUrl string
    (String) The dashboard URL of the new resource instance.
    DeletedAt string
    (Timestamp) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions map[string]string
    (String) The extended metadata as a map associated with the resource instance.
    Guid string
    (String) The GUID of the resource instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperation map[string]string
    (String) The status of the last operation requested on the instance.
    Locked bool
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    OnetimeCredentials bool
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    PlanHistories []ResourceInstancePlanHistory
    (String) The plan history of the instance.
    ResourceAliasesUrl string
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    ResourceBindingsUrl string
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    ResourceCrn string
    The crn of the resource
    ResourceGroupCrn string
    (String) The long ID (full CRN) of the resource group.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceId string
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    ResourceName string
    The name of the resource
    ResourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    ResourceStatus string
    The status of the resource
    RestoredAt string
    (Timestamp) The date when the instance under reclamation restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    ScheduledReclaimAt string
    (Timestamp) The date when the instance scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) The status of resource instance.
    SubType string
    (String) The sub-type of instance, for example, cfaas.
    TargetCrn string
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    Type string
    (String) The type of the instance. For example, service_instance.
    UpdateAt string
    (Timestamp) The date when the instance last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    accountId String
    (String) An alpha-numeric value identifying the account ID.
    allowCleanup Boolean
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    createdAt String
    (Timestamp) The date when the instance created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    CRN of resource instance
    dashboardUrl String
    (String) The dashboard URL of the new resource instance.
    deletedAt String
    (Timestamp) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String,String>
    (String) The extended metadata as a map associated with the resource instance.
    guid String
    (String) The GUID of the resource instance.
    id String
    The provider-assigned unique ID for this managed resource.
    lastOperation Map<String,String>
    (String) The status of the last operation requested on the instance.
    locked Boolean
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    onetimeCredentials Boolean
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    planHistories List<ResourceInstancePlanHistory>
    (String) The plan history of the instance.
    resourceAliasesUrl String
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

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

    Deprecated: Deprecated

    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resourceCrn String
    The crn of the resource
    resourceGroupCrn String
    (String) The long ID (full CRN) of the resource group.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceId String
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    resourceName String
    The name of the resource
    resourcePlanId String
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resourceStatus String
    The status of the resource
    restoredAt String
    (Timestamp) The date when the instance under reclamation restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt String
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) The status of resource instance.
    subType String
    (String) The sub-type of instance, for example, cfaas.
    targetCrn String
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    type String
    (String) The type of the instance. For example, service_instance.
    updateAt String
    (Timestamp) The date when the instance last updated.
    updateBy String
    (String) The subject who updated the instance.
    accountId string
    (String) An alpha-numeric value identifying the account ID.
    allowCleanup boolean
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    createdAt string
    (Timestamp) The date when the instance created.
    createdBy string
    (String) The subject who created the instance.
    crn string
    CRN of resource instance
    dashboardUrl string
    (String) The dashboard URL of the new resource instance.
    deletedAt string
    (Timestamp) The date when the instance was deleted.
    deletedBy string
    (String) The subject who deleted the instance.
    extensions {[key: string]: string}
    (String) The extended metadata as a map associated with the resource instance.
    guid string
    (String) The GUID of the resource instance.
    id string
    The provider-assigned unique ID for this managed resource.
    lastOperation {[key: string]: string}
    (String) The status of the last operation requested on the instance.
    locked boolean
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    onetimeCredentials boolean
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    planHistories ResourceInstancePlanHistory[]
    (String) The plan history of the instance.
    resourceAliasesUrl string
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    resourceBindingsUrl string
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resourceCrn string
    The crn of the resource
    resourceGroupCrn string
    (String) The long ID (full CRN) of the resource group.
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceId string
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    resourceName string
    The name of the resource
    resourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resourceStatus string
    The status of the resource
    restoredAt string
    (Timestamp) The date when the instance under reclamation restored.
    restoredBy string
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt string
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    state string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status string
    (String) The status of resource instance.
    subType string
    (String) The sub-type of instance, for example, cfaas.
    targetCrn string
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    type string
    (String) The type of the instance. For example, service_instance.
    updateAt string
    (Timestamp) The date when the instance 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
    (String) 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
    (Timestamp) The date when the instance created.
    created_by str
    (String) The subject who created the instance.
    crn str
    CRN of resource instance
    dashboard_url str
    (String) The dashboard URL of the new resource instance.
    deleted_at str
    (Timestamp) The date when the instance was deleted.
    deleted_by str
    (String) The subject who deleted the instance.
    extensions Mapping[str, str]
    (String) The extended metadata as a map associated with the resource instance.
    guid str
    (String) The GUID of the resource instance.
    id str
    The provider-assigned unique ID for this managed resource.
    last_operation Mapping[str, str]
    (String) The status of the last operation requested on the instance.
    locked bool
    (String) 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
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    plan_histories Sequence[ResourceInstancePlanHistory]
    (String) The plan history of the instance.
    resource_aliases_url str
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    resource_bindings_url str
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resource_crn str
    The crn of the resource
    resource_group_crn str
    (String) The long ID (full CRN) of the resource group.
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_id str
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resource_keys_url str
    (String) The relative path to the resource keys for the instance.
    resource_name str
    The name of the resource
    resource_plan_id str
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resource_status str
    The status of the resource
    restored_at str
    (Timestamp) The date when the instance under reclamation restored.
    restored_by str
    (String) The subject who restored the instance back from reclamation.
    scheduled_reclaim_at str
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduled_reclaim_by str
    (String) The subject who initiated the instance reclamation.
    state str
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status str
    (String) The status of resource instance.
    sub_type str
    (String) The sub-type of instance, for example, cfaas.
    target_crn str
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    type str
    (String) The type of the instance. For example, service_instance.
    update_at str
    (Timestamp) The date when the instance 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
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    createdAt String
    (Timestamp) The date when the instance created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    CRN of resource instance
    dashboardUrl String
    (String) The dashboard URL of the new resource instance.
    deletedAt String
    (Timestamp) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String>
    (String) The extended metadata as a map associated with the resource instance.
    guid String
    (String) The GUID of the resource instance.
    id String
    The provider-assigned unique ID for this managed resource.
    lastOperation Map<String>
    (String) The status of the last operation requested on the instance.
    locked Boolean
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    onetimeCredentials Boolean
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    planHistories List<Property Map>
    (String) The plan history of the instance.
    resourceAliasesUrl String
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

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

    Deprecated: Deprecated

    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resourceCrn String
    The crn of the resource
    resourceGroupCrn String
    (String) The long ID (full CRN) of the resource group.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceId String
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    resourceName String
    The name of the resource
    resourcePlanId String
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resourceStatus String
    The status of the resource
    restoredAt String
    (Timestamp) The date when the instance under reclamation restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt String
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) The status of resource instance.
    subType String
    (String) The sub-type of instance, for example, cfaas.
    targetCrn String
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    type String
    (String) The type of the instance. For example, service_instance.
    updateAt String
    (Timestamp) The date when the instance last updated.
    updateBy String
    (String) The subject who updated the instance.

    Look up Existing ResourceInstance Resource

    Get an existing ResourceInstance 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?: ResourceInstanceState, opts?: CustomResourceOptions): ResourceInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            allow_cleanup: Optional[bool] = 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,
            extensions: Optional[Mapping[str, str]] = None,
            guid: Optional[str] = None,
            last_operation: Optional[Mapping[str, str]] = 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[ResourceInstancePlanHistoryArgs]] = 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_instance_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,
            timeouts: Optional[ResourceInstanceTimeoutsArgs] = None,
            type: Optional[str] = None,
            update_at: Optional[str] = None,
            update_by: Optional[str] = None) -> ResourceInstance
    func GetResourceInstance(ctx *Context, name string, id IDInput, state *ResourceInstanceState, opts ...ResourceOption) (*ResourceInstance, error)
    public static ResourceInstance Get(string name, Input<string> id, ResourceInstanceState? state, CustomResourceOptions? opts = null)
    public static ResourceInstance get(String name, Output<String> id, ResourceInstanceState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ResourceInstance    get:      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
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    CreatedAt string
    (Timestamp) The date when the instance created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    CRN of resource instance
    DashboardUrl string
    (String) The dashboard URL of the new resource instance.
    DeletedAt string
    (Timestamp) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions Dictionary<string, string>
    (String) The extended metadata as a map associated with the resource instance.
    Guid string
    (String) The GUID of the resource instance.
    LastOperation Dictionary<string, string>
    (String) The status of the last operation requested on the instance.
    Location string
    Target location or environment to create the resource instance.
    Locked bool
    (String) 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 descriptive name used to identify the resource instance.
    OnetimeCredentials bool
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    Parameters Dictionary<string, string>
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    ParametersJson string
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    Plan string
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    PlanHistories List<ResourceInstancePlanHistory>
    (String) The plan history of the instance.
    ResourceAliasesUrl string
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    ResourceBindingsUrl string
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    ResourceCrn string
    The crn of the resource
    ResourceGroupCrn string
    (String) The long ID (full CRN) of the resource group.
    ResourceGroupId string
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceId string
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    ResourceInstanceId string
    (String) The unique identifier of the new resource instance.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    ResourceName string
    The name of the resource
    ResourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    ResourceStatus string
    The status of the resource
    RestoredAt string
    (Timestamp) The date when the instance under reclamation restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    ScheduledReclaimAt string
    (Timestamp) The date when the instance scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    Service string
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    ServiceEndpoints string
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) The status of resource instance.
    SubType string
    (String) The sub-type of 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. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    Timeouts ResourceInstanceTimeouts
    Type string
    (String) The type of the instance. For example, service_instance.
    UpdateAt string
    (Timestamp) The date when the instance last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    AccountId string
    (String) An alpha-numeric value identifying the account ID.
    AllowCleanup bool
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    CreatedAt string
    (Timestamp) The date when the instance created.
    CreatedBy string
    (String) The subject who created the instance.
    Crn string
    CRN of resource instance
    DashboardUrl string
    (String) The dashboard URL of the new resource instance.
    DeletedAt string
    (Timestamp) The date when the instance was deleted.
    DeletedBy string
    (String) The subject who deleted the instance.
    Extensions map[string]string
    (String) The extended metadata as a map associated with the resource instance.
    Guid string
    (String) The GUID of the resource instance.
    LastOperation map[string]string
    (String) The status of the last operation requested on the instance.
    Location string
    Target location or environment to create the resource instance.
    Locked bool
    (String) 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 descriptive name used to identify the resource instance.
    OnetimeCredentials bool
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    Parameters map[string]string
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    ParametersJson string
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    Plan string
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    PlanHistories []ResourceInstancePlanHistoryArgs
    (String) The plan history of the instance.
    ResourceAliasesUrl string
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    ResourceBindingsUrl string
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    ResourceCrn string
    The crn of the resource
    ResourceGroupCrn string
    (String) The long ID (full CRN) of the resource group.
    ResourceGroupId string
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceId string
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    ResourceInstanceId string
    (String) The unique identifier of the new resource instance.
    ResourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    ResourceName string
    The name of the resource
    ResourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    ResourceStatus string
    The status of the resource
    RestoredAt string
    (Timestamp) The date when the instance under reclamation restored.
    RestoredBy string
    (String) The subject who restored the instance back from reclamation.
    ScheduledReclaimAt string
    (Timestamp) The date when the instance scheduled for reclamation.
    ScheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    Service string
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    ServiceEndpoints string
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    State string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    Status string
    (String) The status of resource instance.
    SubType string
    (String) The sub-type of instance, for example, cfaas.
    Tags []string
    Tags associated with the instance.
    TargetCrn string
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    Timeouts ResourceInstanceTimeoutsArgs
    Type string
    (String) The type of the instance. For example, service_instance.
    UpdateAt string
    (Timestamp) The date when the instance last updated.
    UpdateBy string
    (String) The subject who updated the instance.
    accountId String
    (String) An alpha-numeric value identifying the account ID.
    allowCleanup Boolean
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    createdAt String
    (Timestamp) The date when the instance created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    CRN of resource instance
    dashboardUrl String
    (String) The dashboard URL of the new resource instance.
    deletedAt String
    (Timestamp) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String,String>
    (String) The extended metadata as a map associated with the resource instance.
    guid String
    (String) The GUID of the resource instance.
    lastOperation Map<String,String>
    (String) The status of the last operation requested on the instance.
    location String
    Target location or environment to create the resource instance.
    locked Boolean
    (String) 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 descriptive name used to identify the resource instance.
    onetimeCredentials Boolean
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    parameters Map<String,String>
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parametersJson String
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    plan String
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    planHistories List<ResourceInstancePlanHistory>
    (String) The plan history of the instance.
    resourceAliasesUrl String
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

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

    Deprecated: Deprecated

    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resourceCrn String
    The crn of the resource
    resourceGroupCrn String
    (String) The long ID (full CRN) of the resource group.
    resourceGroupId String
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceId String
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resourceInstanceId String
    (String) The unique identifier of the new resource instance.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    resourceName String
    The name of the resource
    resourcePlanId String
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resourceStatus String
    The status of the resource
    restoredAt String
    (Timestamp) The date when the instance under reclamation restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt String
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    service String
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    serviceEndpoints String
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) The status of resource instance.
    subType String
    (String) The sub-type of 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. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    timeouts ResourceInstanceTimeouts
    type String
    (String) The type of the instance. For example, service_instance.
    updateAt String
    (Timestamp) The date when the instance last updated.
    updateBy String
    (String) The subject who updated the instance.
    accountId string
    (String) An alpha-numeric value identifying the account ID.
    allowCleanup boolean
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    createdAt string
    (Timestamp) The date when the instance created.
    createdBy string
    (String) The subject who created the instance.
    crn string
    CRN of resource instance
    dashboardUrl string
    (String) The dashboard URL of the new resource instance.
    deletedAt string
    (Timestamp) The date when the instance was deleted.
    deletedBy string
    (String) The subject who deleted the instance.
    extensions {[key: string]: string}
    (String) The extended metadata as a map associated with the resource instance.
    guid string
    (String) The GUID of the resource instance.
    lastOperation {[key: string]: string}
    (String) The status of the last operation requested on the instance.
    location string
    Target location or environment to create the resource instance.
    locked boolean
    (String) 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 descriptive name used to identify the resource instance.
    onetimeCredentials boolean
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    parameters {[key: string]: string}
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parametersJson string
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    plan string
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    planHistories ResourceInstancePlanHistory[]
    (String) The plan history of the instance.
    resourceAliasesUrl string
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    resourceBindingsUrl string
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resourceCrn string
    The crn of the resource
    resourceGroupCrn string
    (String) The long ID (full CRN) of the resource group.
    resourceGroupId string
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceId string
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resourceInstanceId string
    (String) The unique identifier of the new resource instance.
    resourceKeysUrl string
    (String) The relative path to the resource keys for the instance.
    resourceName string
    The name of the resource
    resourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resourceStatus string
    The status of the resource
    restoredAt string
    (Timestamp) The date when the instance under reclamation restored.
    restoredBy string
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt string
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduledReclaimBy string
    (String) The subject who initiated the instance reclamation.
    service string
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    serviceEndpoints string
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    state string
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status string
    (String) The status of resource instance.
    subType string
    (String) The sub-type of instance, for example, cfaas.
    tags string[]
    Tags associated with the instance.
    targetCrn string
    (String) The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    timeouts ResourceInstanceTimeouts
    type string
    (String) The type of the instance. For example, service_instance.
    updateAt string
    (Timestamp) The date when the instance 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
    (String) 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
    (Timestamp) The date when the instance created.
    created_by str
    (String) The subject who created the instance.
    crn str
    CRN of resource instance
    dashboard_url str
    (String) The dashboard URL of the new resource instance.
    deleted_at str
    (Timestamp) The date when the instance was deleted.
    deleted_by str
    (String) The subject who deleted the instance.
    extensions Mapping[str, str]
    (String) The extended metadata as a map associated with the resource instance.
    guid str
    (String) The GUID of the resource instance.
    last_operation Mapping[str, str]
    (String) The status of the last operation requested on the instance.
    location str
    Target location or environment to create the resource instance.
    locked bool
    (String) 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 descriptive name used to identify the resource instance.
    onetime_credentials bool
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    parameters Mapping[str, str]
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parameters_json str
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    plan str
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    plan_histories Sequence[ResourceInstancePlanHistoryArgs]
    (String) The plan history of the instance.
    resource_aliases_url str
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

    resource_bindings_url str
    (String, Deprecated) The relative path to the resource bindings for the instance.

    Deprecated: Deprecated

    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resource_crn str
    The crn of the resource
    resource_group_crn str
    (String) The long ID (full CRN) of the resource group.
    resource_group_id str
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_id str
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resource_instance_id str
    (String) The unique identifier of the new resource instance.
    resource_keys_url str
    (String) The relative path to the resource keys for the instance.
    resource_name str
    The name of the resource
    resource_plan_id str
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resource_status str
    The status of the resource
    restored_at str
    (Timestamp) The date when the instance under reclamation restored.
    restored_by str
    (String) The subject who restored the instance back from reclamation.
    scheduled_reclaim_at str
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduled_reclaim_by str
    (String) The subject who initiated the instance reclamation.
    service str
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    service_endpoints str
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    state str
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status str
    (String) The status of resource instance.
    sub_type str
    (String) The sub-type of 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. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    timeouts ResourceInstanceTimeoutsArgs
    type str
    (String) The type of the instance. For example, service_instance.
    update_at str
    (Timestamp) The date when the instance 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
    (String) A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.
    createdAt String
    (Timestamp) The date when the instance created.
    createdBy String
    (String) The subject who created the instance.
    crn String
    CRN of resource instance
    dashboardUrl String
    (String) The dashboard URL of the new resource instance.
    deletedAt String
    (Timestamp) The date when the instance was deleted.
    deletedBy String
    (String) The subject who deleted the instance.
    extensions Map<String>
    (String) The extended metadata as a map associated with the resource instance.
    guid String
    (String) The GUID of the resource instance.
    lastOperation Map<String>
    (String) The status of the last operation requested on the instance.
    location String
    Target location or environment to create the resource instance.
    locked Boolean
    (String) 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 descriptive name used to identify the resource instance.
    onetimeCredentials Boolean
    (Bool) A boolean that dictates if the onetime_credentials is true or false.
    parameters Map<String>
    Arbitrary parameters to create instance. The value must be a JSON object. Conflicts with parameters_json.
    parametersJson String
    Arbitrary parameters to create instance. The value must be a JSON string. Conflicts with parameters.
    plan String
    The name of the plan type supported by service. You can retrieve the value by running the ibmcloud catalog service <servicename> command.
    planHistories List<Property Map>
    (String) The plan history of the instance.
    resourceAliasesUrl String
    (String, Deprecated) The relative path to the resource aliases for the instance.

    Deprecated: Deprecated

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

    Deprecated: Deprecated

    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about the resource
    resourceCrn String
    The crn of the resource
    resourceGroupCrn String
    (String) The long ID (full CRN) of the resource group.
    resourceGroupId String
    The ID of the resource group where you want to create the service. You can retrieve the value from data source ibm.ResourceGroup. If not provided creates the service in default resource group.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceId String
    (String) The unique ID of the offering. This value is provided by and stored in the global catalog.
    resourceInstanceId String
    (String) The unique identifier of the new resource instance.
    resourceKeysUrl String
    (String) The relative path to the resource keys for the instance.
    resourceName String
    The name of the resource
    resourcePlanId String
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    resourceStatus String
    The status of the resource
    restoredAt String
    (Timestamp) The date when the instance under reclamation restored.
    restoredBy String
    (String) The subject who restored the instance back from reclamation.
    scheduledReclaimAt String
    (Timestamp) The date when the instance scheduled for reclamation.
    scheduledReclaimBy String
    (String) The subject who initiated the instance reclamation.
    service String
    The name of the service offering. You can retrieve the value by installing the catalogs-management command line plug-in and running the ibmcloud catalog service-marketplace or ibmcloud catalog search command. For more information, about IBM Cloud catalog service marketplace, refer IBM Cloud catalog service marketplace.
    serviceEndpoints String
    Types of the service endpoints that can be set to a resource instance. Possible values are public, private, public-and-private.
    state String
    (String) The current state of the instance. For example, if the instance is deleted, it will return removed.
    status String
    (String) The status of resource instance.
    subType String
    (String) The sub-type of 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. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.
    timeouts Property Map
    type String
    (String) The type of the instance. For example, service_instance.
    updateAt String
    (Timestamp) The date when the instance last updated.
    updateBy String
    (String) The subject who updated the instance.

    Supporting Types

    ResourceInstancePlanHistory, ResourceInstancePlanHistoryArgs

    ResourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    StartDate string
    ResourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    StartDate string
    resourcePlanId String
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    startDate String
    resourcePlanId string
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    startDate string
    resource_plan_id str
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    start_date str
    resourcePlanId String
    (String) The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
    startDate String

    ResourceInstanceTimeouts, ResourceInstanceTimeoutsArgs

    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

    Package Details

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