Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks
  3. API Docs
  4. GroupRole
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

databricks.GroupRole

Explore with Pulumi AI

databricks logo
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

    This resource allows you to attach a role to databricks_group. This role could be a pre-defined role such as account admin, or an instance profile ARN.

    Example Usage

    Attach an instance profile to a group

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

const instanceProfile = new databricks.InstanceProfile("instance_profile", {instanceProfileArn: "my_instance_profile_arn"});
const myGroup = new databricks.Group("my_group", {displayName: "my_group_name"});
const myGroupInstanceProfile = new databricks.GroupRole("my_group_instance_profile", {
    groupId: myGroup.id,
    role: instanceProfile.id,
});

    import pulumi
import pulumi_databricks as databricks

instance_profile = databricks.InstanceProfile("instance_profile", instance_profile_arn="my_instance_profile_arn")
my_group = databricks.Group("my_group", display_name="my_group_name")
my_group_instance_profile = databricks.GroupRole("my_group_instance_profile",
    group_id=my_group.id,
    role=instance_profile.id)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instanceProfile, err := databricks.NewInstanceProfile(ctx, "instance_profile", &databricks.InstanceProfileArgs{
			InstanceProfileArn: pulumi.String("my_instance_profile_arn"),
		})
		if err != nil {
			return err
		}
		myGroup, err := databricks.NewGroup(ctx, "my_group", &databricks.GroupArgs{
			DisplayName: pulumi.String("my_group_name"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewGroupRole(ctx, "my_group_instance_profile", &databricks.GroupRoleArgs{
			GroupId: myGroup.ID(),
			Role:    instanceProfile.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var instanceProfile = new Databricks.InstanceProfile("instance_profile", new()
    {
        InstanceProfileArn = "my_instance_profile_arn",
    });

    var myGroup = new Databricks.Group("my_group", new()
    {
        DisplayName = "my_group_name",
    });

    var myGroupInstanceProfile = new Databricks.GroupRole("my_group_instance_profile", new()
    {
        GroupId = myGroup.Id,
        Role = instanceProfile.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.InstanceProfile;
import com.pulumi.databricks.InstanceProfileArgs;
import com.pulumi.databricks.Group;
import com.pulumi.databricks.GroupArgs;
import com.pulumi.databricks.GroupRole;
import com.pulumi.databricks.GroupRoleArgs;
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 instanceProfile = new InstanceProfile("instanceProfile", InstanceProfileArgs.builder()
            .instanceProfileArn("my_instance_profile_arn")
            .build());

        var myGroup = new Group("myGroup", GroupArgs.builder()
            .displayName("my_group_name")
            .build());

        var myGroupInstanceProfile = new GroupRole("myGroupInstanceProfile", GroupRoleArgs.builder()
            .groupId(myGroup.id())
            .role(instanceProfile.id())
            .build());

    }
}

    resources:
  instanceProfile:
    type: databricks:InstanceProfile
    name: instance_profile
    properties:
      instanceProfileArn: my_instance_profile_arn
  myGroup:
    type: databricks:Group
    name: my_group
    properties:
      displayName: my_group_name
  myGroupInstanceProfile:
    type: databricks:GroupRole
    name: my_group_instance_profile
    properties:
      groupId: ${myGroup.id}
      role: ${instanceProfile.id}

    Attach account admin role to an account-level group

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

const myGroup = new databricks.Group("my_group", {displayName: "my_group_name"});
const myGroupAccountAdmin = new databricks.GroupRole("my_group_account_admin", {
    groupId: myGroup.id,
    role: "account_admin",
});

    import pulumi
import pulumi_databricks as databricks

my_group = databricks.Group("my_group", display_name="my_group_name")
my_group_account_admin = databricks.GroupRole("my_group_account_admin",
    group_id=my_group.id,
    role="account_admin")

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myGroup, err := databricks.NewGroup(ctx, "my_group", &databricks.GroupArgs{
			DisplayName: pulumi.String("my_group_name"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewGroupRole(ctx, "my_group_account_admin", &databricks.GroupRoleArgs{
			GroupId: myGroup.ID(),
			Role:    pulumi.String("account_admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var myGroup = new Databricks.Group("my_group", new()
    {
        DisplayName = "my_group_name",
    });

    var myGroupAccountAdmin = new Databricks.GroupRole("my_group_account_admin", new()
    {
        GroupId = myGroup.Id,
        Role = "account_admin",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Group;
import com.pulumi.databricks.GroupArgs;
import com.pulumi.databricks.GroupRole;
import com.pulumi.databricks.GroupRoleArgs;
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 myGroup = new Group("myGroup", GroupArgs.builder()
            .displayName("my_group_name")
            .build());

        var myGroupAccountAdmin = new GroupRole("myGroupAccountAdmin", GroupRoleArgs.builder()
            .groupId(myGroup.id())
            .role("account_admin")
            .build());

    }
}

    resources:
  myGroup:
    type: databricks:Group
    name: my_group
    properties:
      displayName: my_group_name
  myGroupAccountAdmin:
    type: databricks:GroupRole
    name: my_group_account_admin
    properties:
      groupId: ${myGroup.id}
      role: account_admin

    The following resources are often used in the same context:

    • End to end workspace management guide.
    • databricks.getAwsBucketPolicy data to configure a simple access policy for AWS S3 buckets, so that Databricks can access data in it.
    • databricks.ClusterPolicy to create a databricks.Cluster policy, which limits the ability to create clusters based on a set of rules.
    • databricks.Group to manage groups in Databricks Workspace or Account Console (for AWS deployments).
    • databricks.Group data to retrieve information about databricks.Group members, entitlements and instance profiles.
    • databricks.GroupMember to attach users and groups as group members.
    • databricks.InstancePool to manage instance pools to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances.
    • databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
    • databricks.UserInstanceProfile to attach databricks.InstanceProfile (AWS) to databricks_user.

    Create GroupRole Resource

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

    Constructor syntax

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

@overload
def GroupRole(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              group_id: Optional[str] = None,
              role: Optional[str] = None)
    func NewGroupRole(ctx *Context, name string, args GroupRoleArgs, opts ...ResourceOption) (*GroupRole, error)
    public GroupRole(string name, GroupRoleArgs args, CustomResourceOptions? opts = null)
    public GroupRole(String name, GroupRoleArgs args)
public GroupRole(String name, GroupRoleArgs args, CustomResourceOptions options)

    type: databricks:GroupRole
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 GroupRoleArgs
    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 GroupRoleArgs
    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 GroupRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupRoleArgs
    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 groupRoleResource = new Databricks.GroupRole("groupRoleResource", new()
{
    GroupId = "string",
    Role = "string",
});

    example, err := databricks.NewGroupRole(ctx, "groupRoleResource", &databricks.GroupRoleArgs{
	GroupId: pulumi.String("string"),
	Role:    pulumi.String("string"),
})

    var groupRoleResource = new GroupRole("groupRoleResource", GroupRoleArgs.builder()
    .groupId("string")
    .role("string")
    .build());

    group_role_resource = databricks.GroupRole("groupRoleResource",
    group_id="string",
    role="string")

    const groupRoleResource = new databricks.GroupRole("groupRoleResource", {
    groupId: "string",
    role: "string",
});

    type: databricks:GroupRole
properties:
    groupId: string
    role: string

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

    GroupId string
    This is the id of the group resource.
    Role string
    Either a role name or the ARN/ID of the instance profile resource.
    GroupId string
    This is the id of the group resource.
    Role string
    Either a role name or the ARN/ID of the instance profile resource.
    groupId String
    This is the id of the group resource.
    role String
    Either a role name or the ARN/ID of the instance profile resource.
    groupId string
    This is the id of the group resource.
    role string
    Either a role name or the ARN/ID of the instance profile resource.
    group_id str
    This is the id of the group resource.
    role str
    Either a role name or the ARN/ID of the instance profile resource.
    groupId String
    This is the id of the group resource.
    role String
    Either a role name or the ARN/ID of the instance profile resource.

    Outputs

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

    Get an existing GroupRole 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?: GroupRoleState, opts?: CustomResourceOptions): GroupRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_id: Optional[str] = None,
        role: Optional[str] = None) -> GroupRole
    func GetGroupRole(ctx *Context, name string, id IDInput, state *GroupRoleState, opts ...ResourceOption) (*GroupRole, error)
    public static GroupRole Get(string name, Input<string> id, GroupRoleState? state, CustomResourceOptions? opts = null)
    public static GroupRole get(String name, Output<String> id, GroupRoleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    GroupId string
    This is the id of the group resource.
    Role string
    Either a role name or the ARN/ID of the instance profile resource.
    GroupId string
    This is the id of the group resource.
    Role string
    Either a role name or the ARN/ID of the instance profile resource.
    groupId String
    This is the id of the group resource.
    role String
    Either a role name or the ARN/ID of the instance profile resource.
    groupId string
    This is the id of the group resource.
    role string
    Either a role name or the ARN/ID of the instance profile resource.
    group_id str
    This is the id of the group resource.
    role str
    Either a role name or the ARN/ID of the instance profile resource.
    groupId String
    This is the id of the group resource.
    role String
    Either a role name or the ARN/ID of the instance profile resource.

    Import

    !> Importing this resource is not currently supported.

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

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-databricks