Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. ServiceInstance
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.ServiceInstance

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    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,
                    plan: Optional[str] = None,
                    service: Optional[str] = None,
                    space_guid: Optional[str] = None,
                    name: Optional[str] = None,
                    parameters: Optional[Mapping[str, str]] = None,
                    service_instance_id: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None,
                    wait_time_minutes: Optional[float] = 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: ibm: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 Ibm.ServiceInstance("serviceInstanceResource", new()
{
    Plan = "string",
    Service = "string",
    SpaceGuid = "string",
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    ServiceInstanceId = "string",
    Tags = new[]
    {
        "string",
    },
    WaitTimeMinutes = 0,
});

    example, err := ibm.NewServiceInstance(ctx, "serviceInstanceResource", &ibm.ServiceInstanceArgs{
	Plan:      pulumi.String("string"),
	Service:   pulumi.String("string"),
	SpaceGuid: pulumi.String("string"),
	Name:      pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ServiceInstanceId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	WaitTimeMinutes: pulumi.Float64(0),
})

    var serviceInstanceResource = new ServiceInstance("serviceInstanceResource", ServiceInstanceArgs.builder()
    .plan("string")
    .service("string")
    .spaceGuid("string")
    .name("string")
    .parameters(Map.of("string", "string"))
    .serviceInstanceId("string")
    .tags("string")
    .waitTimeMinutes(0)
    .build());

    service_instance_resource = ibm.ServiceInstance("serviceInstanceResource",
    plan="string",
    service="string",
    space_guid="string",
    name="string",
    parameters={
        "string": "string",
    },
    service_instance_id="string",
    tags=["string"],
    wait_time_minutes=0)

    const serviceInstanceResource = new ibm.ServiceInstance("serviceInstanceResource", {
    plan: "string",
    service: "string",
    spaceGuid: "string",
    name: "string",
    parameters: {
        string: "string",
    },
    serviceInstanceId: "string",
    tags: ["string"],
    waitTimeMinutes: 0,
});

    type: ibm:ServiceInstance
properties:
    name: string
    parameters:
        string: string
    plan: string
    service: string
    serviceInstanceId: string
    spaceGuid: string
    tags:
        - string
    waitTimeMinutes: 0

    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:

    Plan string
    The plan type of the service
    Service string
    The name of the service offering like speech_to_text, text_to_speech etc
    SpaceGuid string
    The guid of the space in which the instance will be created
    Name string
    A name for the service instance
    Parameters Dictionary<string, string>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    ServiceInstanceId string
    Tags List<string>
    WaitTimeMinutes double
    Define timeout to wait for the service instances to succeeded/deleted etc.
    Plan string
    The plan type of the service
    Service string
    The name of the service offering like speech_to_text, text_to_speech etc
    SpaceGuid string
    The guid of the space in which the instance will be created
    Name string
    A name for the service instance
    Parameters map[string]string
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    ServiceInstanceId string
    Tags []string
    WaitTimeMinutes float64
    Define timeout to wait for the service instances to succeeded/deleted etc.
    plan String
    The plan type of the service
    service String
    The name of the service offering like speech_to_text, text_to_speech etc
    spaceGuid String
    The guid of the space in which the instance will be created
    name String
    A name for the service instance
    parameters Map<String,String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceInstanceId String
    tags List<String>
    waitTimeMinutes Double
    Define timeout to wait for the service instances to succeeded/deleted etc.
    plan string
    The plan type of the service
    service string
    The name of the service offering like speech_to_text, text_to_speech etc
    spaceGuid string
    The guid of the space in which the instance will be created
    name string
    A name for the service instance
    parameters {[key: string]: string}
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceInstanceId string
    tags string[]
    waitTimeMinutes number
    Define timeout to wait for the service instances to succeeded/deleted etc.
    plan str
    The plan type of the service
    service str
    The name of the service offering like speech_to_text, text_to_speech etc
    space_guid str
    The guid of the space in which the instance will be created
    name str
    A name for the service instance
    parameters Mapping[str, str]
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    service_instance_id str
    tags Sequence[str]
    wait_time_minutes float
    Define timeout to wait for the service instances to succeeded/deleted etc.
    plan String
    The plan type of the service
    service String
    The name of the service offering like speech_to_text, text_to_speech etc
    spaceGuid String
    The guid of the space in which the instance will be created
    name String
    A name for the service instance
    parameters Map<String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceInstanceId String
    tags List<String>
    waitTimeMinutes Number
    Define timeout to wait for the service instances to succeeded/deleted etc.

    Outputs

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

    Credentials Dictionary<string, string>
    The service broker-provided credentials to use this service.
    DashboardUrl string
    Dashboard URL to access resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceKeys List<ServiceInstanceServiceKey>
    The service keys asociated with the service instance
    ServicePlanGuid string
    The uniquie identifier of the service offering plan type
    Credentials map[string]string
    The service broker-provided credentials to use this service.
    DashboardUrl string
    Dashboard URL to access resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceKeys []ServiceInstanceServiceKey
    The service keys asociated with the service instance
    ServicePlanGuid string
    The uniquie identifier of the service offering plan type
    credentials Map<String,String>
    The service broker-provided credentials to use this service.
    dashboardUrl String
    Dashboard URL to access resource.
    id String
    The provider-assigned unique ID for this managed resource.
    serviceKeys List<ServiceInstanceServiceKey>
    The service keys asociated with the service instance
    servicePlanGuid String
    The uniquie identifier of the service offering plan type
    credentials {[key: string]: string}
    The service broker-provided credentials to use this service.
    dashboardUrl string
    Dashboard URL to access resource.
    id string
    The provider-assigned unique ID for this managed resource.
    serviceKeys ServiceInstanceServiceKey[]
    The service keys asociated with the service instance
    servicePlanGuid string
    The uniquie identifier of the service offering plan type
    credentials Mapping[str, str]
    The service broker-provided credentials to use this service.
    dashboard_url str
    Dashboard URL to access resource.
    id str
    The provider-assigned unique ID for this managed resource.
    service_keys Sequence[ServiceInstanceServiceKey]
    The service keys asociated with the service instance
    service_plan_guid str
    The uniquie identifier of the service offering plan type
    credentials Map<String>
    The service broker-provided credentials to use this service.
    dashboardUrl String
    Dashboard URL to access resource.
    id String
    The provider-assigned unique ID for this managed resource.
    serviceKeys List<Property Map>
    The service keys asociated with the service instance
    servicePlanGuid String
    The uniquie identifier of the service offering plan type

    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,
        credentials: Optional[Mapping[str, str]] = None,
        dashboard_url: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        plan: Optional[str] = None,
        service: Optional[str] = None,
        service_instance_id: Optional[str] = None,
        service_keys: Optional[Sequence[ServiceInstanceServiceKeyArgs]] = None,
        service_plan_guid: Optional[str] = None,
        space_guid: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        wait_time_minutes: Optional[float] = 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: ibm: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:
    Credentials Dictionary<string, string>
    The service broker-provided credentials to use this service.
    DashboardUrl string
    Dashboard URL to access resource.
    Name string
    A name for the service instance
    Parameters Dictionary<string, string>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    Plan string
    The plan type of the service
    Service string
    The name of the service offering like speech_to_text, text_to_speech etc
    ServiceInstanceId string
    ServiceKeys List<ServiceInstanceServiceKey>
    The service keys asociated with the service instance
    ServicePlanGuid string
    The uniquie identifier of the service offering plan type
    SpaceGuid string
    The guid of the space in which the instance will be created
    Tags List<string>
    WaitTimeMinutes double
    Define timeout to wait for the service instances to succeeded/deleted etc.
    Credentials map[string]string
    The service broker-provided credentials to use this service.
    DashboardUrl string
    Dashboard URL to access resource.
    Name string
    A name for the service instance
    Parameters map[string]string
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    Plan string
    The plan type of the service
    Service string
    The name of the service offering like speech_to_text, text_to_speech etc
    ServiceInstanceId string
    ServiceKeys []ServiceInstanceServiceKeyArgs
    The service keys asociated with the service instance
    ServicePlanGuid string
    The uniquie identifier of the service offering plan type
    SpaceGuid string
    The guid of the space in which the instance will be created
    Tags []string
    WaitTimeMinutes float64
    Define timeout to wait for the service instances to succeeded/deleted etc.
    credentials Map<String,String>
    The service broker-provided credentials to use this service.
    dashboardUrl String
    Dashboard URL to access resource.
    name String
    A name for the service instance
    parameters Map<String,String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    plan String
    The plan type of the service
    service String
    The name of the service offering like speech_to_text, text_to_speech etc
    serviceInstanceId String
    serviceKeys List<ServiceInstanceServiceKey>
    The service keys asociated with the service instance
    servicePlanGuid String
    The uniquie identifier of the service offering plan type
    spaceGuid String
    The guid of the space in which the instance will be created
    tags List<String>
    waitTimeMinutes Double
    Define timeout to wait for the service instances to succeeded/deleted etc.
    credentials {[key: string]: string}
    The service broker-provided credentials to use this service.
    dashboardUrl string
    Dashboard URL to access resource.
    name string
    A name for the service instance
    parameters {[key: string]: string}
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    plan string
    The plan type of the service
    service string
    The name of the service offering like speech_to_text, text_to_speech etc
    serviceInstanceId string
    serviceKeys ServiceInstanceServiceKey[]
    The service keys asociated with the service instance
    servicePlanGuid string
    The uniquie identifier of the service offering plan type
    spaceGuid string
    The guid of the space in which the instance will be created
    tags string[]
    waitTimeMinutes number
    Define timeout to wait for the service instances to succeeded/deleted etc.
    credentials Mapping[str, str]
    The service broker-provided credentials to use this service.
    dashboard_url str
    Dashboard URL to access resource.
    name str
    A name for the service instance
    parameters Mapping[str, str]
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    plan str
    The plan type of the service
    service str
    The name of the service offering like speech_to_text, text_to_speech etc
    service_instance_id str
    service_keys Sequence[ServiceInstanceServiceKeyArgs]
    The service keys asociated with the service instance
    service_plan_guid str
    The uniquie identifier of the service offering plan type
    space_guid str
    The guid of the space in which the instance will be created
    tags Sequence[str]
    wait_time_minutes float
    Define timeout to wait for the service instances to succeeded/deleted etc.
    credentials Map<String>
    The service broker-provided credentials to use this service.
    dashboardUrl String
    Dashboard URL to access resource.
    name String
    A name for the service instance
    parameters Map<String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    plan String
    The plan type of the service
    service String
    The name of the service offering like speech_to_text, text_to_speech etc
    serviceInstanceId String
    serviceKeys List<Property Map>
    The service keys asociated with the service instance
    servicePlanGuid String
    The uniquie identifier of the service offering plan type
    spaceGuid String
    The guid of the space in which the instance will be created
    tags List<String>
    waitTimeMinutes Number
    Define timeout to wait for the service instances to succeeded/deleted etc.

    Supporting Types

    ServiceInstanceServiceKey, ServiceInstanceServiceKeyArgs

    Credentials Dictionary<string, string>
    Name string
    Credentials map[string]string
    Name string
    credentials Map<String,String>
    name String
    credentials {[key: string]: string}
    name string
    credentials Mapping[str, str]
    name str
    credentials Map<String>
    name 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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm