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 string
- The unique name of the resource.
- args OrganizationGroupArgs
- 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 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 string
- The unique name of the resource.
- args OrganizationGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
    },
});
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"),
},
})
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());
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",
    })
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",
    },
});
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
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 string
- CAST AI organization ID.
- Description string
- Description of the group.
- Members
List<OrganizationGroup Member> 
- Name string
- Name of the group.
- OrganizationGroup stringId 
- The ID of this resource.
- Timeouts
OrganizationGroup Timeouts 
- OrganizationId string
- CAST AI organization ID.
- Description string
- Description of the group.
- Members
[]OrganizationGroup Member Args 
- Name string
- Name of the group.
- OrganizationGroup stringId 
- The ID of this resource.
- Timeouts
OrganizationGroup Timeouts Args 
- organizationId String
- CAST AI organization ID.
- description String
- Description of the group.
- members
List<OrganizationGroup Member> 
- name String
- Name of the group.
- organizationGroup StringId 
- The ID of this resource.
- timeouts
OrganizationGroup Timeouts 
- organizationId string
- CAST AI organization ID.
- description string
- Description of the group.
- members
OrganizationGroup Member[] 
- name string
- Name of the group.
- organizationGroup stringId 
- The ID of this resource.
- timeouts
OrganizationGroup Timeouts 
- organization_id str
- CAST AI organization ID.
- description str
- Description of the group.
- members
Sequence[OrganizationGroup Member Args] 
- name str
- Name of the group.
- organization_group_ strid 
- The ID of this resource.
- timeouts
OrganizationGroup Timeouts Args 
- organizationId String
- CAST AI organization ID.
- description String
- Description of the group.
- members List<Property Map>
- name String
- Name of the group.
- organizationGroup StringId 
- 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) -> OrganizationGroupfunc 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
- 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.
- Description string
- Description of the group.
- Members
List<OrganizationGroup Member> 
- Name string
- Name of the group.
- OrganizationGroup stringId 
- The ID of this resource.
- OrganizationId string
- CAST AI organization ID.
- Timeouts
OrganizationGroup Timeouts 
- Description string
- Description of the group.
- Members
[]OrganizationGroup Member Args 
- Name string
- Name of the group.
- OrganizationGroup stringId 
- The ID of this resource.
- OrganizationId string
- CAST AI organization ID.
- Timeouts
OrganizationGroup Timeouts Args 
- description String
- Description of the group.
- members
List<OrganizationGroup Member> 
- name String
- Name of the group.
- organizationGroup StringId 
- The ID of this resource.
- organizationId String
- CAST AI organization ID.
- timeouts
OrganizationGroup Timeouts 
- description string
- Description of the group.
- members
OrganizationGroup Member[] 
- name string
- Name of the group.
- organizationGroup stringId 
- The ID of this resource.
- organizationId string
- CAST AI organization ID.
- timeouts
OrganizationGroup Timeouts 
- description str
- Description of the group.
- members
Sequence[OrganizationGroup Member Args] 
- name str
- Name of the group.
- organization_group_ strid 
- The ID of this resource.
- organization_id str
- CAST AI organization ID.
- timeouts
OrganizationGroup Timeouts Args 
- description String
- Description of the group.
- members List<Property Map>
- name String
- Name of the group.
- organizationGroup StringId 
- The ID of this resource.
- organizationId String
- CAST AI organization ID.
- timeouts Property Map
Supporting Types
OrganizationGroupMember, OrganizationGroupMemberArgs      
OrganizationGroupMemberMember, OrganizationGroupMemberMemberArgs        
OrganizationGroupTimeouts, OrganizationGroupTimeoutsArgs      
Package Details
- Repository
- castai castai/terraform-provider-castai
- License
- Notes
- This Pulumi package is based on the castaiTerraform Provider.