@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
94 lines (93 loc) • 3.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource allows you to attach a role or databricks.InstanceProfile (AWS) to a databricks_service_principal.
*
* ## Example Usage
*
* Granting a service principal access to an instance profile
*
* ```typescript
* 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 _this = new databricks.ServicePrincipal("this", {displayName: "My Service Principal"});
* const myServicePrincipalInstanceProfile = new databricks.ServicePrincipalRole("my_service_principal_instance_profile", {
* servicePrincipalId: _this.id,
* role: instanceProfile.id,
* });
* ```
*
* ## Related Resources
*
* The following resources are often used in the same context:
*
* * End to end workspace management guide.
* * databricks.UserRole to attach role or databricks.InstanceProfile (AWS) to databricks_user.
* * databricks.GroupInstanceProfile to attach databricks.InstanceProfile (AWS) to databricks_group.
* * databricks.GroupMember to attach users and groups as group members.
* * databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
*
* ## Import
*
* !> Importing this resource is not currently supported.
*/
export declare class ServicePrincipalRole extends pulumi.CustomResource {
/**
* Get an existing ServicePrincipalRole resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServicePrincipalRoleState, opts?: pulumi.CustomResourceOptions): ServicePrincipalRole;
/**
* Returns true if the given object is an instance of ServicePrincipalRole. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ServicePrincipalRole;
/**
* This is the id of the role or instance profile resource.
*/
readonly role: pulumi.Output<string>;
/**
* This is the id of the service principal resource.
*/
readonly servicePrincipalId: pulumi.Output<string>;
/**
* Create a ServicePrincipalRole resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ServicePrincipalRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServicePrincipalRole resources.
*/
export interface ServicePrincipalRoleState {
/**
* This is the id of the role or instance profile resource.
*/
role?: pulumi.Input<string>;
/**
* This is the id of the service principal resource.
*/
servicePrincipalId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ServicePrincipalRole resource.
*/
export interface ServicePrincipalRoleArgs {
/**
* This is the id of the role or instance profile resource.
*/
role: pulumi.Input<string>;
/**
* This is the id of the service principal resource.
*/
servicePrincipalId: pulumi.Input<string>;
}