Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudfoundry Provider
  3. API Docs
  4. ServiceInstance
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

cloudfoundry.ServiceInstance

Explore with Pulumi AI

cloudfoundry logo
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

    Provides a Cloud Foundry resource for managing Cloud Foundry Service Instances within spaces.

    Example Usage

    The following is a Service Instance created in the referenced space with the specified service plan.

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

const redis = cloudfoundry.getService({
    name: "p-redis",
});
const redis1 = new cloudfoundry.ServiceInstance("redis1", {
    space: cloudfoundry_space.dev.id,
    servicePlan: redis.then(redis => redis.servicePlans?.["shared-vm"]),
});

    import pulumi
import pulumi_cloudfoundry as cloudfoundry

redis = cloudfoundry.get_service(name="p-redis")
redis1 = cloudfoundry.ServiceInstance("redis1",
    space=cloudfoundry_space["dev"]["id"],
    service_plan=redis.service_plans["shared-vm"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		redis, err := cloudfoundry.GetService(ctx, &cloudfoundry.GetServiceArgs{
			Name: "p-redis",
		}, nil)
		if err != nil {
			return err
		}
		_, err = cloudfoundry.NewServiceInstance(ctx, "redis1", &cloudfoundry.ServiceInstanceArgs{
			Space:       pulumi.Any(cloudfoundry_space.Dev.Id),
			ServicePlan: pulumi.String(redis.ServicePlans.SharedVm),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudfoundry = Pulumi.Cloudfoundry;

return await Deployment.RunAsync(() => 
{
    var redis = Cloudfoundry.GetService.Invoke(new()
    {
        Name = "p-redis",
    });

    var redis1 = new Cloudfoundry.ServiceInstance("redis1", new()
    {
        Space = cloudfoundry_space.Dev.Id,
        ServicePlan = redis.Apply(getServiceResult => getServiceResult.ServicePlans?.Shared_vm),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.CloudfoundryFunctions;
import com.pulumi.cloudfoundry.inputs.GetServiceArgs;
import com.pulumi.cloudfoundry.ServiceInstance;
import com.pulumi.cloudfoundry.ServiceInstanceArgs;
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 redis = CloudfoundryFunctions.getService(GetServiceArgs.builder()
            .name("p-redis")
            .build());

        var redis1 = new ServiceInstance("redis1", ServiceInstanceArgs.builder()
            .space(cloudfoundry_space.dev().id())
            .servicePlan(redis.applyValue(getServiceResult -> getServiceResult.servicePlans().shared-vm()))
            .build());

    }
}

    resources:
  redis1:
    type: cloudfoundry:ServiceInstance
    properties:
      space: ${cloudfoundry_space.dev.id}
      servicePlan: ${redis.servicePlans"shared-vm"[%!s(MISSING)]}
variables:
  redis:
    fn::invoke:
      function: cloudfoundry:getService
      arguments:
        name: p-redis

    Create ServiceInstance Resource

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

    Constructor syntax

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

@overload
def ServiceInstance(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    service_plan: Optional[str] = None,
                    space: Optional[str] = None,
                    annotations: Optional[Mapping[str, str]] = None,
                    json_params: Optional[str] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    name: Optional[str] = None,
                    recursive_delete: Optional[bool] = None,
                    replace_on_params_change: Optional[bool] = None,
                    replace_on_service_plan_change: Optional[bool] = None,
                    service_instance_id: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None,
                    timeouts: Optional[ServiceInstanceTimeoutsArgs] = None)
    func NewServiceInstance(ctx *Context, name string, args ServiceInstanceArgs, opts ...ResourceOption) (*ServiceInstance, error)
    public ServiceInstance(string name, ServiceInstanceArgs args, CustomResourceOptions? opts = null)
    public ServiceInstance(String name, ServiceInstanceArgs args)
public ServiceInstance(String name, ServiceInstanceArgs args, CustomResourceOptions options)

    type: cloudfoundry:ServiceInstance
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 ServiceInstanceArgs
    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 ServiceInstanceArgs
    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 ServiceInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceInstanceArgs
    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 serviceInstanceResource = new Cloudfoundry.ServiceInstance("serviceInstanceResource", new()
{
    ServicePlan = "string",
    Space = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    JsonParams = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    ReplaceOnParamsChange = false,
    ReplaceOnServicePlanChange = false,
    ServiceInstanceId = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Cloudfoundry.Inputs.ServiceInstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := cloudfoundry.NewServiceInstance(ctx, "serviceInstanceResource", &cloudfoundry.ServiceInstanceArgs{
	ServicePlan: pulumi.String("string"),
	Space:       pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	JsonParams: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:                       pulumi.String("string"),
	ReplaceOnParamsChange:      pulumi.Bool(false),
	ReplaceOnServicePlanChange: pulumi.Bool(false),
	ServiceInstanceId:          pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &cloudfoundry.ServiceInstanceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var serviceInstanceResource = new ServiceInstance("serviceInstanceResource", ServiceInstanceArgs.builder()
    .servicePlan("string")
    .space("string")
    .annotations(Map.of("string", "string"))
    .jsonParams("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .replaceOnParamsChange(false)
    .replaceOnServicePlanChange(false)
    .serviceInstanceId("string")
    .tags("string")
    .timeouts(ServiceInstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    service_instance_resource = cloudfoundry.ServiceInstance("serviceInstanceResource",
    service_plan="string",
    space="string",
    annotations={
        "string": "string",
    },
    json_params="string",
    labels={
        "string": "string",
    },
    name="string",
    replace_on_params_change=False,
    replace_on_service_plan_change=False,
    service_instance_id="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const serviceInstanceResource = new cloudfoundry.ServiceInstance("serviceInstanceResource", {
    servicePlan: "string",
    space: "string",
    annotations: {
        string: "string",
    },
    jsonParams: "string",
    labels: {
        string: "string",
    },
    name: "string",
    replaceOnParamsChange: false,
    replaceOnServicePlanChange: false,
    serviceInstanceId: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: cloudfoundry:ServiceInstance
properties:
    annotations:
        string: string
    jsonParams: string
    labels:
        string: string
    name: string
    replaceOnParamsChange: false
    replaceOnServicePlanChange: false
    serviceInstanceId: string
    servicePlan: string
    space: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string

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

    ServicePlan string
    The ID of the service plan
    Space string
    The ID of the space
    Annotations Dictionary<string, string>
    JsonParams string
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    Labels Dictionary<string, string>
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    Name string
    The name of the Service Instance in Cloud Foundry
    RecursiveDelete bool
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    ReplaceOnParamsChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    ReplaceOnServicePlanChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    ServiceInstanceId string
    The GUID of the service instance
    Tags List<string>
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    Timeouts ServiceInstanceTimeouts
    ServicePlan string
    The ID of the service plan
    Space string
    The ID of the space
    Annotations map[string]string
    JsonParams string
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    Labels map[string]string
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    Name string
    The name of the Service Instance in Cloud Foundry
    RecursiveDelete bool
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    ReplaceOnParamsChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    ReplaceOnServicePlanChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    ServiceInstanceId string
    The GUID of the service instance
    Tags []string
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    Timeouts ServiceInstanceTimeoutsArgs
    servicePlan String
    The ID of the service plan
    space String
    The ID of the space
    annotations Map<String,String>
    jsonParams String
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels Map<String,String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name String
    The name of the Service Instance in Cloud Foundry
    recursiveDelete Boolean
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replaceOnParamsChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replaceOnServicePlanChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    serviceInstanceId String
    The GUID of the service instance
    tags List<String>
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts ServiceInstanceTimeouts
    servicePlan string
    The ID of the service plan
    space string
    The ID of the space
    annotations {[key: string]: string}
    jsonParams string
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels {[key: string]: string}
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name string
    The name of the Service Instance in Cloud Foundry
    recursiveDelete boolean
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replaceOnParamsChange boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replaceOnServicePlanChange boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    serviceInstanceId string
    The GUID of the service instance
    tags string[]
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts ServiceInstanceTimeouts
    service_plan str
    The ID of the service plan
    space str
    The ID of the space
    annotations Mapping[str, str]
    json_params str
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels Mapping[str, str]
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name str
    The name of the Service Instance in Cloud Foundry
    recursive_delete bool
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replace_on_params_change bool
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replace_on_service_plan_change bool
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    service_instance_id str
    The GUID of the service instance
    tags Sequence[str]
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts ServiceInstanceTimeoutsArgs
    servicePlan String
    The ID of the service plan
    space String
    The ID of the space
    annotations Map<String>
    jsonParams String
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels Map<String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name String
    The name of the Service Instance in Cloud Foundry
    recursiveDelete Boolean
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replaceOnParamsChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replaceOnServicePlanChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    serviceInstanceId String
    The GUID of the service instance
    tags List<String>
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServiceInstance Resource

    Get an existing ServiceInstance 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?: ServiceInstanceState, opts?: CustomResourceOptions): ServiceInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        json_params: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        recursive_delete: Optional[bool] = None,
        replace_on_params_change: Optional[bool] = None,
        replace_on_service_plan_change: Optional[bool] = None,
        service_instance_id: Optional[str] = None,
        service_plan: Optional[str] = None,
        space: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[ServiceInstanceTimeoutsArgs] = None) -> ServiceInstance
    func GetServiceInstance(ctx *Context, name string, id IDInput, state *ServiceInstanceState, opts ...ResourceOption) (*ServiceInstance, error)
    public static ServiceInstance Get(string name, Input<string> id, ServiceInstanceState? state, CustomResourceOptions? opts = null)
    public static ServiceInstance get(String name, Output<String> id, ServiceInstanceState state, CustomResourceOptions options)
    resources:  _:    type: cloudfoundry:ServiceInstance    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:
    Annotations Dictionary<string, string>
    JsonParams string
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    Labels Dictionary<string, string>
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    Name string
    The name of the Service Instance in Cloud Foundry
    RecursiveDelete bool
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    ReplaceOnParamsChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    ReplaceOnServicePlanChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    ServiceInstanceId string
    The GUID of the service instance
    ServicePlan string
    The ID of the service plan
    Space string
    The ID of the space
    Tags List<string>
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    Timeouts ServiceInstanceTimeouts
    Annotations map[string]string
    JsonParams string
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    Labels map[string]string
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    Name string
    The name of the Service Instance in Cloud Foundry
    RecursiveDelete bool
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    ReplaceOnParamsChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    ReplaceOnServicePlanChange bool
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    ServiceInstanceId string
    The GUID of the service instance
    ServicePlan string
    The ID of the service plan
    Space string
    The ID of the space
    Tags []string
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    Timeouts ServiceInstanceTimeoutsArgs
    annotations Map<String,String>
    jsonParams String
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels Map<String,String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name String
    The name of the Service Instance in Cloud Foundry
    recursiveDelete Boolean
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replaceOnParamsChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replaceOnServicePlanChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    serviceInstanceId String
    The GUID of the service instance
    servicePlan String
    The ID of the service plan
    space String
    The ID of the space
    tags List<String>
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts ServiceInstanceTimeouts
    annotations {[key: string]: string}
    jsonParams string
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels {[key: string]: string}
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name string
    The name of the Service Instance in Cloud Foundry
    recursiveDelete boolean
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replaceOnParamsChange boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replaceOnServicePlanChange boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    serviceInstanceId string
    The GUID of the service instance
    servicePlan string
    The ID of the service plan
    space string
    The ID of the space
    tags string[]
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts ServiceInstanceTimeouts
    annotations Mapping[str, str]
    json_params str
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels Mapping[str, str]
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name str
    The name of the Service Instance in Cloud Foundry
    recursive_delete bool
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replace_on_params_change bool
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replace_on_service_plan_change bool
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    service_instance_id str
    The GUID of the service instance
    service_plan str
    The ID of the service plan
    space str
    The ID of the space
    tags Sequence[str]
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts ServiceInstanceTimeoutsArgs
    annotations Map<String>
    jsonParams String
    Json string of arbitrary parameters. Some services support providing additional configuration parameters within the provision request. By default, no params are provided.
    labels Map<String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63. Below is an example usage.
    name String
    The name of the Service Instance in Cloud Foundry
    recursiveDelete Boolean
    DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.

    Deprecated: Deprecated

    replaceOnParamsChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
    replaceOnServicePlanChange Boolean
    Default: false. If set true, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
    serviceInstanceId String
    The GUID of the service instance
    servicePlan String
    The ID of the service plan
    space String
    The ID of the space
    tags List<String>
    List of instance tags. Some services provide a list of tags that Cloud Foundry delivers in VCAP_SERVICES Env variables. By default, no tags are assigned.
    timeouts Property Map

    Supporting Types

    ServiceInstanceTimeouts, ServiceInstanceTimeoutsArgs

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

    Import

    Timeouts

    cloudfoundry_service_instance provides the following

    Timeouts configuration options:

    • create - (Default 15 minutes) Used for Creating Instance.

    • update - (Default 15 minutes) Used for Updating Instance.

    • delete - (Default 15 minutes) Used for Destroying Instance.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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