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

ibm.MqcloudUser

Explore with Pulumi AI

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

    Example Usage

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

const mqcloudUserInstance = new ibm.MqcloudUser("mqcloudUserInstance", {
    email: "testuser@ibm.com",
    serviceInstanceGuid: _var.service_instance_guid,
});

    import pulumi
import pulumi_ibm as ibm

mqcloud_user_instance = ibm.MqcloudUser("mqcloudUserInstance",
    email="testuser@ibm.com",
    service_instance_guid=var["service_instance_guid"])

    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.NewMqcloudUser(ctx, "mqcloudUserInstance", &ibm.MqcloudUserArgs{
			Email:               pulumi.String("testuser@ibm.com"),
			ServiceInstanceGuid: pulumi.Any(_var.Service_instance_guid),
		})
		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 mqcloudUserInstance = new Ibm.MqcloudUser("mqcloudUserInstance", new()
    {
        Email = "testuser@ibm.com",
        ServiceInstanceGuid = @var.Service_instance_guid,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.MqcloudUser;
import com.pulumi.ibm.MqcloudUserArgs;
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 mqcloudUserInstance = new MqcloudUser("mqcloudUserInstance", MqcloudUserArgs.builder()
            .email("testuser@ibm.com")
            .serviceInstanceGuid(var_.service_instance_guid())
            .build());

    }
}

    resources:
  mqcloudUserInstance:
    type: ibm:MqcloudUser
    properties:
      email: testuser@ibm.com
      serviceInstanceGuid: ${var.service_instance_guid}

    Create MqcloudUser Resource

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

    Constructor syntax

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

@overload
def MqcloudUser(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                email: Optional[str] = None,
                service_instance_guid: Optional[str] = None,
                mqcloud_user_id: Optional[str] = None,
                name: Optional[str] = None)
    func NewMqcloudUser(ctx *Context, name string, args MqcloudUserArgs, opts ...ResourceOption) (*MqcloudUser, error)
    public MqcloudUser(string name, MqcloudUserArgs args, CustomResourceOptions? opts = null)
    public MqcloudUser(String name, MqcloudUserArgs args)
public MqcloudUser(String name, MqcloudUserArgs args, CustomResourceOptions options)

    type: ibm:MqcloudUser
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 MqcloudUserArgs
    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 MqcloudUserArgs
    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 MqcloudUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MqcloudUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MqcloudUserArgs
    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 mqcloudUserResource = new Ibm.MqcloudUser("mqcloudUserResource", new()
{
    Email = "string",
    ServiceInstanceGuid = "string",
    MqcloudUserId = "string",
    Name = "string",
});

    example, err := ibm.NewMqcloudUser(ctx, "mqcloudUserResource", &ibm.MqcloudUserArgs{
	Email:               pulumi.String("string"),
	ServiceInstanceGuid: pulumi.String("string"),
	MqcloudUserId:       pulumi.String("string"),
	Name:                pulumi.String("string"),
})

    var mqcloudUserResource = new MqcloudUser("mqcloudUserResource", MqcloudUserArgs.builder()
    .email("string")
    .serviceInstanceGuid("string")
    .mqcloudUserId("string")
    .name("string")
    .build());

    mqcloud_user_resource = ibm.MqcloudUser("mqcloudUserResource",
    email="string",
    service_instance_guid="string",
    mqcloud_user_id="string",
    name="string")

    const mqcloudUserResource = new ibm.MqcloudUser("mqcloudUserResource", {
    email: "string",
    serviceInstanceGuid: "string",
    mqcloudUserId: "string",
    name: "string",
});

    type: ibm:MqcloudUser
properties:
    email: string
    mqcloudUserId: string
    name: string
    serviceInstanceGuid: string

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

    Email string
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    MqcloudUserId string
    The unique identifier of the mqcloud_user.
    Name string
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    Email string
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    MqcloudUserId string
    The unique identifier of the mqcloud_user.
    Name string
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    email String
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    mqcloudUserId String
    The unique identifier of the mqcloud_user.
    name String
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    email string
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    serviceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    mqcloudUserId string
    The unique identifier of the mqcloud_user.
    name string
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    email str
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    service_instance_guid str
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    mqcloud_user_id str
    The unique identifier of the mqcloud_user.
    name str
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    email String
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    mqcloudUserId String
    The unique identifier of the mqcloud_user.
    name String
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.

    Outputs

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

    Href string
    (String) The URL for the user details.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserId string
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    Href string
    (String) The URL for the user details.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserId string
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    href String
    (String) The URL for the user details.
    id String
    The provider-assigned unique ID for this managed resource.
    userId String
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    href string
    (String) The URL for the user details.
    id string
    The provider-assigned unique ID for this managed resource.
    userId string
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    href str
    (String) The URL for the user details.
    id str
    The provider-assigned unique ID for this managed resource.
    user_id str
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    href String
    (String) The URL for the user details.
    id String
    The provider-assigned unique ID for this managed resource.
    userId String
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.

    Look up Existing MqcloudUser Resource

    Get an existing MqcloudUser 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?: MqcloudUserState, opts?: CustomResourceOptions): MqcloudUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email: Optional[str] = None,
        href: Optional[str] = None,
        mqcloud_user_id: Optional[str] = None,
        name: Optional[str] = None,
        service_instance_guid: Optional[str] = None,
        user_id: Optional[str] = None) -> MqcloudUser
    func GetMqcloudUser(ctx *Context, name string, id IDInput, state *MqcloudUserState, opts ...ResourceOption) (*MqcloudUser, error)
    public static MqcloudUser Get(string name, Input<string> id, MqcloudUserState? state, CustomResourceOptions? opts = null)
    public static MqcloudUser get(String name, Output<String> id, MqcloudUserState state, CustomResourceOptions options)
    resources:  _:    type: ibm:MqcloudUser    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:
    Email string
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    Href string
    (String) The URL for the user details.
    MqcloudUserId string
    The unique identifier of the mqcloud_user.
    Name string
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    UserId string
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    Email string
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    Href string
    (String) The URL for the user details.
    MqcloudUserId string
    The unique identifier of the mqcloud_user.
    Name string
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    UserId string
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    email String
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    href String
    (String) The URL for the user details.
    mqcloudUserId String
    The unique identifier of the mqcloud_user.
    name String
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    userId String
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    email string
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    href string
    (String) The URL for the user details.
    mqcloudUserId string
    The unique identifier of the mqcloud_user.
    name string
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    serviceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    userId string
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    email str
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    href str
    (String) The URL for the user details.
    mqcloud_user_id str
    The unique identifier of the mqcloud_user.
    name str
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    service_instance_guid str
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    user_id str
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.
    email String
    The email of the user.

    • Constraints: The maximum length is 253 characters. The minimum length is 5 characters.
    href String
    (String) The URL for the user details.
    mqcloudUserId String
    The unique identifier of the mqcloud_user.
    name String
    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    • Constraints: The maximum length is 12 characters. The minimum length is 1 character. The value must match regular expression /^[a-z][-a-z0-9]*$/.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    userId String
    (String) The ID of the user which was allocated on creation, and can be used for delete calls.

    Import

    You can import the ibm_mqcloud_user resource by using id.

    The id property can be formed from service_instance_guid, and user_id in the following format:

    
<service_instance_guid>/<user_id>

    • service_instance_guid: A string in the format a2b4d4bc-dadb-4637-bcec-9b7d1e723af8. The GUID that uniquely identifies the MQaaS service instance.

    • user_id: A string. The ID of the user which was allocated on creation, and can be used for delete calls.

    Syntax

    
```sh
$ pulumi import ibm:index/mqcloudUser:MqcloudUser mqcloud_user <service_instance_guid>/<user_id>
```

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

    Package Details

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