1. Packages
  2. Hsdp Provider
  3. API Docs
  4. IamOrg
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.IamOrg

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

    Provides a resource for managing HSDP IAM organizations.

    Example Usage

    The following example creates an org

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const testorg = new hsdp.IamOrg("testorg", {
        description: "Test Organization",
        parentOrgId: hsdp_iam_org.myorg.id,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    testorg = hsdp.IamOrg("testorg",
        description="Test Organization",
        parent_org_id=hsdp_iam_org["myorg"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hsdp.NewIamOrg(ctx, "testorg", &hsdp.IamOrgArgs{
    			Description: pulumi.String("Test Organization"),
    			ParentOrgId: pulumi.Any(hsdp_iam_org.Myorg.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var testorg = new Hsdp.IamOrg("testorg", new()
        {
            Description = "Test Organization",
            ParentOrgId = hsdp_iam_org.Myorg.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.IamOrg;
    import com.pulumi.hsdp.IamOrgArgs;
    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 testorg = new IamOrg("testorg", IamOrgArgs.builder()
                .description("Test Organization")
                .parentOrgId(hsdp_iam_org.myorg().id())
                .build());
    
        }
    }
    
    resources:
      testorg:
        type: hsdp:IamOrg
        properties:
          description: Test Organization
          parentOrgId: ${hsdp_iam_org.myorg.id}
    

    Assuming the following Org exists or has been imported

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const myorg = new hsdp.IamOrg("myorg", {
        description: "My IAM Organization",
        isRootOrg: true,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    myorg = hsdp.IamOrg("myorg",
        description="My IAM Organization",
        is_root_org=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hsdp.NewIamOrg(ctx, "myorg", &hsdp.IamOrgArgs{
    			Description: pulumi.String("My IAM Organization"),
    			IsRootOrg:   pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var myorg = new Hsdp.IamOrg("myorg", new()
        {
            Description = "My IAM Organization",
            IsRootOrg = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.IamOrg;
    import com.pulumi.hsdp.IamOrgArgs;
    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 myorg = new IamOrg("myorg", IamOrgArgs.builder()
                .description("My IAM Organization")
                .isRootOrg(true)
                .build());
    
        }
    }
    
    resources:
      myorg:
        type: hsdp:IamOrg
        properties:
          description: My IAM Organization
          isRootOrg: true
    

    Create IamOrg Resource

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

    Constructor syntax

    new IamOrg(name: string, args?: IamOrgArgs, opts?: CustomResourceOptions);
    @overload
    def IamOrg(resource_name: str,
               args: Optional[IamOrgArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def IamOrg(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               external_id: Optional[str] = None,
               iam_org_id: Optional[str] = None,
               is_root_org: Optional[bool] = None,
               name: Optional[str] = None,
               parent_org_id: Optional[str] = None,
               type: Optional[str] = None,
               wait_for_delete: Optional[bool] = None)
    func NewIamOrg(ctx *Context, name string, args *IamOrgArgs, opts ...ResourceOption) (*IamOrg, error)
    public IamOrg(string name, IamOrgArgs? args = null, CustomResourceOptions? opts = null)
    public IamOrg(String name, IamOrgArgs args)
    public IamOrg(String name, IamOrgArgs args, CustomResourceOptions options)
    
    type: hsdp:IamOrg
    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 IamOrgArgs
    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 IamOrgArgs
    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 IamOrgArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamOrgArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamOrgArgs
    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 iamOrgResource = new Hsdp.IamOrg("iamOrgResource", new()
    {
        Description = "string",
        DisplayName = "string",
        ExternalId = "string",
        IamOrgId = "string",
        Name = "string",
        ParentOrgId = "string",
        Type = "string",
        WaitForDelete = false,
    });
    
    example, err := hsdp.NewIamOrg(ctx, "iamOrgResource", &hsdp.IamOrgArgs{
    	Description:   pulumi.String("string"),
    	DisplayName:   pulumi.String("string"),
    	ExternalId:    pulumi.String("string"),
    	IamOrgId:      pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	ParentOrgId:   pulumi.String("string"),
    	Type:          pulumi.String("string"),
    	WaitForDelete: pulumi.Bool(false),
    })
    
    var iamOrgResource = new IamOrg("iamOrgResource", IamOrgArgs.builder()
        .description("string")
        .displayName("string")
        .externalId("string")
        .iamOrgId("string")
        .name("string")
        .parentOrgId("string")
        .type("string")
        .waitForDelete(false)
        .build());
    
    iam_org_resource = hsdp.IamOrg("iamOrgResource",
        description="string",
        display_name="string",
        external_id="string",
        iam_org_id="string",
        name="string",
        parent_org_id="string",
        type="string",
        wait_for_delete=False)
    
    const iamOrgResource = new hsdp.IamOrg("iamOrgResource", {
        description: "string",
        displayName: "string",
        externalId: "string",
        iamOrgId: "string",
        name: "string",
        parentOrgId: "string",
        type: "string",
        waitForDelete: false,
    });
    
    type: hsdp:IamOrg
    properties:
        description: string
        displayName: string
        externalId: string
        iamOrgId: string
        name: string
        parentOrgId: string
        type: string
        waitForDelete: false
    

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

    Description string
    The description of the Org
    DisplayName string
    The name of the organization suitable for display.
    ExternalId string
    Identifier defined by client which identifies the organization on the client side
    IamOrgId string
    The GUID of the organization
    IsRootOrg bool
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    Name string
    The name of the Org in IAM
    ParentOrgId string
    The parent Org ID (GUID)
    Type string
    The type of the organization e.g. Hospital
    WaitForDelete bool
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    Description string
    The description of the Org
    DisplayName string
    The name of the organization suitable for display.
    ExternalId string
    Identifier defined by client which identifies the organization on the client side
    IamOrgId string
    The GUID of the organization
    IsRootOrg bool
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    Name string
    The name of the Org in IAM
    ParentOrgId string
    The parent Org ID (GUID)
    Type string
    The type of the organization e.g. Hospital
    WaitForDelete bool
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    description String
    The description of the Org
    displayName String
    The name of the organization suitable for display.
    externalId String
    Identifier defined by client which identifies the organization on the client side
    iamOrgId String
    The GUID of the organization
    isRootOrg Boolean
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name String
    The name of the Org in IAM
    parentOrgId String
    The parent Org ID (GUID)
    type String
    The type of the organization e.g. Hospital
    waitForDelete Boolean
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    description string
    The description of the Org
    displayName string
    The name of the organization suitable for display.
    externalId string
    Identifier defined by client which identifies the organization on the client side
    iamOrgId string
    The GUID of the organization
    isRootOrg boolean
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name string
    The name of the Org in IAM
    parentOrgId string
    The parent Org ID (GUID)
    type string
    The type of the organization e.g. Hospital
    waitForDelete boolean
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    description str
    The description of the Org
    display_name str
    The name of the organization suitable for display.
    external_id str
    Identifier defined by client which identifies the organization on the client side
    iam_org_id str
    The GUID of the organization
    is_root_org bool
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name str
    The name of the Org in IAM
    parent_org_id str
    The parent Org ID (GUID)
    type str
    The type of the organization e.g. Hospital
    wait_for_delete bool
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    description String
    The description of the Org
    displayName String
    The name of the organization suitable for display.
    externalId String
    Identifier defined by client which identifies the organization on the client side
    iamOrgId String
    The GUID of the organization
    isRootOrg Boolean
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name String
    The name of the Org in IAM
    parentOrgId String
    The parent Org ID (GUID)
    type String
    The type of the organization e.g. Hospital
    waitForDelete Boolean
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.

    Outputs

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

    Active bool
    Boolean. Weather the organization is active or not.
    Id string
    The provider-assigned unique ID for this managed resource.
    Active bool
    Boolean. Weather the organization is active or not.
    Id string
    The provider-assigned unique ID for this managed resource.
    active Boolean
    Boolean. Weather the organization is active or not.
    id String
    The provider-assigned unique ID for this managed resource.
    active boolean
    Boolean. Weather the organization is active or not.
    id string
    The provider-assigned unique ID for this managed resource.
    active bool
    Boolean. Weather the organization is active or not.
    id str
    The provider-assigned unique ID for this managed resource.
    active Boolean
    Boolean. Weather the organization is active or not.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IamOrg Resource

    Get an existing IamOrg 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?: IamOrgState, opts?: CustomResourceOptions): IamOrg
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            external_id: Optional[str] = None,
            iam_org_id: Optional[str] = None,
            is_root_org: Optional[bool] = None,
            name: Optional[str] = None,
            parent_org_id: Optional[str] = None,
            type: Optional[str] = None,
            wait_for_delete: Optional[bool] = None) -> IamOrg
    func GetIamOrg(ctx *Context, name string, id IDInput, state *IamOrgState, opts ...ResourceOption) (*IamOrg, error)
    public static IamOrg Get(string name, Input<string> id, IamOrgState? state, CustomResourceOptions? opts = null)
    public static IamOrg get(String name, Output<String> id, IamOrgState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:IamOrg    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:
    Active bool
    Boolean. Weather the organization is active or not.
    Description string
    The description of the Org
    DisplayName string
    The name of the organization suitable for display.
    ExternalId string
    Identifier defined by client which identifies the organization on the client side
    IamOrgId string
    The GUID of the organization
    IsRootOrg bool
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    Name string
    The name of the Org in IAM
    ParentOrgId string
    The parent Org ID (GUID)
    Type string
    The type of the organization e.g. Hospital
    WaitForDelete bool
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    Active bool
    Boolean. Weather the organization is active or not.
    Description string
    The description of the Org
    DisplayName string
    The name of the organization suitable for display.
    ExternalId string
    Identifier defined by client which identifies the organization on the client side
    IamOrgId string
    The GUID of the organization
    IsRootOrg bool
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    Name string
    The name of the Org in IAM
    ParentOrgId string
    The parent Org ID (GUID)
    Type string
    The type of the organization e.g. Hospital
    WaitForDelete bool
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    active Boolean
    Boolean. Weather the organization is active or not.
    description String
    The description of the Org
    displayName String
    The name of the organization suitable for display.
    externalId String
    Identifier defined by client which identifies the organization on the client side
    iamOrgId String
    The GUID of the organization
    isRootOrg Boolean
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name String
    The name of the Org in IAM
    parentOrgId String
    The parent Org ID (GUID)
    type String
    The type of the organization e.g. Hospital
    waitForDelete Boolean
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    active boolean
    Boolean. Weather the organization is active or not.
    description string
    The description of the Org
    displayName string
    The name of the organization suitable for display.
    externalId string
    Identifier defined by client which identifies the organization on the client side
    iamOrgId string
    The GUID of the organization
    isRootOrg boolean
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name string
    The name of the Org in IAM
    parentOrgId string
    The parent Org ID (GUID)
    type string
    The type of the organization e.g. Hospital
    waitForDelete boolean
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    active bool
    Boolean. Weather the organization is active or not.
    description str
    The description of the Org
    display_name str
    The name of the organization suitable for display.
    external_id str
    Identifier defined by client which identifies the organization on the client side
    iam_org_id str
    The GUID of the organization
    is_root_org bool
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name str
    The name of the Org in IAM
    parent_org_id str
    The parent Org ID (GUID)
    type str
    The type of the organization e.g. Hospital
    wait_for_delete bool
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.
    active Boolean
    Boolean. Weather the organization is active or not.
    description String
    The description of the Org
    displayName String
    The name of the organization suitable for display.
    externalId String
    Identifier defined by client which identifies the organization on the client side
    iamOrgId String
    The GUID of the organization
    isRootOrg Boolean
    Marks the Org as a root organization (boolean)

    Deprecated: Deprecated

    name String
    The name of the Org in IAM
    parentOrgId String
    The parent Org ID (GUID)
    type String
    The type of the organization e.g. Hospital
    waitForDelete Boolean
    Blocks until the organization delete has completed. Default: false. The organization delete process can take some time as all its associated resources like users, groups, roles etc. are removed recursively. This option is useful for ephemeral environments where the same organization might be recreated shortly after a destroy operation.

    Import

    $ pulumi import hsdp:index/iamOrg:IamOrg An existing Organization can be imported using `hsdp_iam_org`, e.g.
    

    bash

    $ pulumi import hsdp:index/iamOrg:IamOrg myorg guid4-of-the-org-you-want-to-import-here
    

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

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software