1. Packages
  2. Castai Provider
  3. API Docs
  4. OrganizationGroup
castai 7.44.1 published on Monday, Mar 31, 2025 by castai

castai.OrganizationGroup

Explore with Pulumi AI

CAST AI organization group resource to manage organization groups

Create OrganizationGroup Resource

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

Constructor syntax

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

@overload
def OrganizationGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      organization_id: Optional[str] = None,
                      description: Optional[str] = None,
                      members: Optional[Sequence[OrganizationGroupMemberArgs]] = None,
                      name: Optional[str] = None,
                      organization_group_id: Optional[str] = None,
                      timeouts: Optional[OrganizationGroupTimeoutsArgs] = None)
func NewOrganizationGroup(ctx *Context, name string, args OrganizationGroupArgs, opts ...ResourceOption) (*OrganizationGroup, error)
public OrganizationGroup(string name, OrganizationGroupArgs args, CustomResourceOptions? opts = null)
public OrganizationGroup(String name, OrganizationGroupArgs args)
public OrganizationGroup(String name, OrganizationGroupArgs args, CustomResourceOptions options)
type: castai:OrganizationGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OrganizationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OrganizationGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OrganizationGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OrganizationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OrganizationGroupArgs
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 organizationGroupResource = new Castai.OrganizationGroup("organizationGroupResource", new()
{
    OrganizationId = "string",
    Description = "string",
    Members = new[]
    {
        new Castai.Inputs.OrganizationGroupMemberArgs
        {
            Members = new[]
            {
                new Castai.Inputs.OrganizationGroupMemberMemberArgs
                {
                    Email = "string",
                    Id = "string",
                    Kind = "string",
                },
            },
        },
    },
    Name = "string",
    OrganizationGroupId = "string",
    Timeouts = new Castai.Inputs.OrganizationGroupTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := castai.NewOrganizationGroup(ctx, "organizationGroupResource", &castai.OrganizationGroupArgs{
OrganizationId: pulumi.String("string"),
Description: pulumi.String("string"),
Members: .OrganizationGroupMemberArray{
&.OrganizationGroupMemberArgs{
Members: .OrganizationGroupMemberMemberArray{
&.OrganizationGroupMemberMemberArgs{
Email: pulumi.String("string"),
Id: pulumi.String("string"),
Kind: pulumi.String("string"),
},
},
},
},
Name: pulumi.String("string"),
OrganizationGroupId: pulumi.String("string"),
Timeouts: &.OrganizationGroupTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var organizationGroupResource = new OrganizationGroup("organizationGroupResource", OrganizationGroupArgs.builder()
    .organizationId("string")
    .description("string")
    .members(OrganizationGroupMemberArgs.builder()
        .members(OrganizationGroupMemberMemberArgs.builder()
            .email("string")
            .id("string")
            .kind("string")
            .build())
        .build())
    .name("string")
    .organizationGroupId("string")
    .timeouts(OrganizationGroupTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
organization_group_resource = castai.OrganizationGroup("organizationGroupResource",
    organization_id="string",
    description="string",
    members=[{
        "members": [{
            "email": "string",
            "id": "string",
            "kind": "string",
        }],
    }],
    name="string",
    organization_group_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const organizationGroupResource = new castai.OrganizationGroup("organizationGroupResource", {
    organizationId: "string",
    description: "string",
    members: [{
        members: [{
            email: "string",
            id: "string",
            kind: "string",
        }],
    }],
    name: "string",
    organizationGroupId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: castai:OrganizationGroup
properties:
    description: string
    members:
        - members:
            - email: string
              id: string
              kind: string
    name: string
    organizationGroupId: string
    organizationId: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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

OrganizationId This property is required. string
CAST AI organization ID.
Description string
Description of the group.
Members List<OrganizationGroupMember>
Name string
Name of the group.
OrganizationGroupId string
The ID of this resource.
Timeouts OrganizationGroupTimeouts
OrganizationId This property is required. string
CAST AI organization ID.
Description string
Description of the group.
Members []OrganizationGroupMemberArgs
Name string
Name of the group.
OrganizationGroupId string
The ID of this resource.
Timeouts OrganizationGroupTimeoutsArgs
organizationId This property is required. String
CAST AI organization ID.
description String
Description of the group.
members List<OrganizationGroupMember>
name String
Name of the group.
organizationGroupId String
The ID of this resource.
timeouts OrganizationGroupTimeouts
organizationId This property is required. string
CAST AI organization ID.
description string
Description of the group.
members OrganizationGroupMember[]
name string
Name of the group.
organizationGroupId string
The ID of this resource.
timeouts OrganizationGroupTimeouts
organization_id This property is required. str
CAST AI organization ID.
description str
Description of the group.
members Sequence[OrganizationGroupMemberArgs]
name str
Name of the group.
organization_group_id str
The ID of this resource.
timeouts OrganizationGroupTimeoutsArgs
organizationId This property is required. String
CAST AI organization ID.
description String
Description of the group.
members List<Property Map>
name String
Name of the group.
organizationGroupId String
The ID of this resource.
timeouts Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the OrganizationGroup 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 OrganizationGroup Resource

Get an existing OrganizationGroup 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?: OrganizationGroupState, opts?: CustomResourceOptions): OrganizationGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        members: Optional[Sequence[OrganizationGroupMemberArgs]] = None,
        name: Optional[str] = None,
        organization_group_id: Optional[str] = None,
        organization_id: Optional[str] = None,
        timeouts: Optional[OrganizationGroupTimeoutsArgs] = None) -> OrganizationGroup
func GetOrganizationGroup(ctx *Context, name string, id IDInput, state *OrganizationGroupState, opts ...ResourceOption) (*OrganizationGroup, error)
public static OrganizationGroup Get(string name, Input<string> id, OrganizationGroupState? state, CustomResourceOptions? opts = null)
public static OrganizationGroup get(String name, Output<String> id, OrganizationGroupState state, CustomResourceOptions options)
resources:  _:    type: castai:OrganizationGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Description of the group.
Members List<OrganizationGroupMember>
Name string
Name of the group.
OrganizationGroupId string
The ID of this resource.
OrganizationId string
CAST AI organization ID.
Timeouts OrganizationGroupTimeouts
Description string
Description of the group.
Members []OrganizationGroupMemberArgs
Name string
Name of the group.
OrganizationGroupId string
The ID of this resource.
OrganizationId string
CAST AI organization ID.
Timeouts OrganizationGroupTimeoutsArgs
description String
Description of the group.
members List<OrganizationGroupMember>
name String
Name of the group.
organizationGroupId String
The ID of this resource.
organizationId String
CAST AI organization ID.
timeouts OrganizationGroupTimeouts
description string
Description of the group.
members OrganizationGroupMember[]
name string
Name of the group.
organizationGroupId string
The ID of this resource.
organizationId string
CAST AI organization ID.
timeouts OrganizationGroupTimeouts
description str
Description of the group.
members Sequence[OrganizationGroupMemberArgs]
name str
Name of the group.
organization_group_id str
The ID of this resource.
organization_id str
CAST AI organization ID.
timeouts OrganizationGroupTimeoutsArgs
description String
Description of the group.
members List<Property Map>
name String
Name of the group.
organizationGroupId String
The ID of this resource.
organizationId String
CAST AI organization ID.
timeouts Property Map

Supporting Types

OrganizationGroupMember
, OrganizationGroupMemberArgs

OrganizationGroupMemberMember
, OrganizationGroupMemberMemberArgs

Email This property is required. string
Id This property is required. string
The ID of this resource.
Kind This property is required. string
Kind of the member. Supported values include: user, service_account.
Email This property is required. string
Id This property is required. string
The ID of this resource.
Kind This property is required. string
Kind of the member. Supported values include: user, service_account.
email This property is required. String
id This property is required. String
The ID of this resource.
kind This property is required. String
Kind of the member. Supported values include: user, service_account.
email This property is required. string
id This property is required. string
The ID of this resource.
kind This property is required. string
Kind of the member. Supported values include: user, service_account.
email This property is required. str
id This property is required. str
The ID of this resource.
kind This property is required. str
Kind of the member. Supported values include: user, service_account.
email This property is required. String
id This property is required. String
The ID of this resource.
kind This property is required. String
Kind of the member. Supported values include: user, service_account.

OrganizationGroupTimeouts
, OrganizationGroupTimeoutsArgs

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

Package Details

Repository
castai castai/terraform-provider-castai
License
Notes
This Pulumi package is based on the castai Terraform Provider.