Databricks v1.46.1, Jun 28 24

Databricks v1.46.1 published on Friday, Jun 28, 2024 by Pulumi

databricks.Grants

Explore with Pulumi AI

Databricks v1.46.1 published on Friday, Jun 28, 2024 by Pulumi

Import

The resource can be imported using combination of securable type (table, catalog, foreign_connection, …) and it’s name:

bash

$ pulumi import databricks:index/grants:Grants this catalog/abc

Create Grants Resource

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

Constructor syntax

new Grants(name: string, args: GrantsArgs, opts?: CustomResourceOptions);

@overload
def Grants(resource_name: str,
           args: GrantsArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Grants(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           grants: Optional[Sequence[GrantsGrantArgs]] = None,
           model: Optional[str] = None,
           foreign_connection: Optional[str] = None,
           function: Optional[str] = None,
           external_location: Optional[str] = None,
           metastore: Optional[str] = None,
           catalog: Optional[str] = None,
           pipeline: Optional[str] = None,
           recipient: Optional[str] = None,
           schema: Optional[str] = None,
           share: Optional[str] = None,
           storage_credential: Optional[str] = None,
           table: Optional[str] = None,
           volume: Optional[str] = None)

func NewGrants(ctx *Context, name string, args GrantsArgs, opts ...ResourceOption) (*Grants, error)

public Grants(string name, GrantsArgs args, CustomResourceOptions? opts = null)

public Grants(String name, GrantsArgs args)
public Grants(String name, GrantsArgs args, CustomResourceOptions options)

type: databricks:Grants
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 GrantsArgs: 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 GrantsArgs: 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 GrantsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GrantsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GrantsArgs: 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 grantsResource = new Databricks.Grants("grantsResource", new()
{
    GrantDetails = new[]
    {
        new Databricks.Inputs.GrantsGrantArgs
        {
            Principal = "string",
            Privileges = new[]
            {
                "string",
            },
        },
    },
    Model = "string",
    ForeignConnection = "string",
    Function = "string",
    ExternalLocation = "string",
    Metastore = "string",
    Catalog = "string",
    Pipeline = "string",
    Recipient = "string",
    Schema = "string",
    Share = "string",
    StorageCredential = "string",
    Table = "string",
    Volume = "string",
});

example, err := databricks.NewGrants(ctx, "grantsResource", &databricks.GrantsArgs{
	Grants: databricks.GrantsGrantArray{
		&databricks.GrantsGrantArgs{
			Principal: pulumi.String("string"),
			Privileges: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Model:             pulumi.String("string"),
	ForeignConnection: pulumi.String("string"),
	Function:          pulumi.String("string"),
	ExternalLocation:  pulumi.String("string"),
	Metastore:         pulumi.String("string"),
	Catalog:           pulumi.String("string"),
	Pipeline:          pulumi.String("string"),
	Recipient:         pulumi.String("string"),
	Schema:            pulumi.String("string"),
	Share:             pulumi.String("string"),
	StorageCredential: pulumi.String("string"),
	Table:             pulumi.String("string"),
	Volume:            pulumi.String("string"),
})

var grantsResource = new Grants("grantsResource", GrantsArgs.builder()
    .grants(GrantsGrantArgs.builder()
        .principal("string")
        .privileges("string")
        .build())
    .model("string")
    .foreignConnection("string")
    .function("string")
    .externalLocation("string")
    .metastore("string")
    .catalog("string")
    .pipeline("string")
    .recipient("string")
    .schema("string")
    .share("string")
    .storageCredential("string")
    .table("string")
    .volume("string")
    .build());

grants_resource = databricks.Grants("grantsResource",
    grants=[databricks.GrantsGrantArgs(
        principal="string",
        privileges=["string"],
    )],
    model="string",
    foreign_connection="string",
    function="string",
    external_location="string",
    metastore="string",
    catalog="string",
    pipeline="string",
    recipient="string",
    schema="string",
    share="string",
    storage_credential="string",
    table="string",
    volume="string")

const grantsResource = new databricks.Grants("grantsResource", {
    grants: [{
        principal: "string",
        privileges: ["string"],
    }],
    model: "string",
    foreignConnection: "string",
    "function": "string",
    externalLocation: "string",
    metastore: "string",
    catalog: "string",
    pipeline: "string",
    recipient: "string",
    schema: "string",
    share: "string",
    storageCredential: "string",
    table: "string",
    volume: "string",
});

type: databricks:Grants
properties:
    catalog: string
    externalLocation: string
    foreignConnection: string
    function: string
    grants:
        - principal: string
          privileges:
            - string
    metastore: string
    model: string
    pipeline: string
    recipient: string
    schema: string
    share: string
    storageCredential: string
    table: string
    volume: string

Grants Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Grants resource accepts the following input properties:

GrantDetails List<GrantsGrant>
Catalog string
ExternalLocation string
ForeignConnection string
Function string
Metastore string
Model string
Pipeline string
Recipient string
Schema string
Share string
StorageCredential string
Table string
Volume string

Grants []GrantsGrantArgs
Catalog string
ExternalLocation string
ForeignConnection string
Function string
Metastore string
Model string
Pipeline string
Recipient string
Schema string
Share string
StorageCredential string
Table string
Volume string

grants List<GrantsGrant>
catalog String
externalLocation String
foreignConnection String
function String
metastore String
model String
pipeline String
recipient String
schema String
share String
storageCredential String
table String
volume String

grants GrantsGrant[]
catalog string
externalLocation string
foreignConnection string
function string
metastore string
model string
pipeline string
recipient string
schema string
share string
storageCredential string
table string
volume string

grants Sequence[GrantsGrantArgs]
catalog str
external_location str
foreign_connection str
function str
metastore str
model str
pipeline str
recipient str
schema str
share str
storage_credential str
table str
volume str

grants List<Property Map>
catalog String
externalLocation String
foreignConnection String
function String
metastore String
model String
pipeline String
recipient String
schema String
share String
storageCredential String
table String
volume String

Outputs

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

Get an existing Grants 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?: GrantsState, opts?: CustomResourceOptions): Grants

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog: Optional[str] = None,
        external_location: Optional[str] = None,
        foreign_connection: Optional[str] = None,
        function: Optional[str] = None,
        grants: Optional[Sequence[GrantsGrantArgs]] = None,
        metastore: Optional[str] = None,
        model: Optional[str] = None,
        pipeline: Optional[str] = None,
        recipient: Optional[str] = None,
        schema: Optional[str] = None,
        share: Optional[str] = None,
        storage_credential: Optional[str] = None,
        table: Optional[str] = None,
        volume: Optional[str] = None) -> Grants

func GetGrants(ctx *Context, name string, id IDInput, state *GrantsState, opts ...ResourceOption) (*Grants, error)

public static Grants Get(string name, Input<string> id, GrantsState? state, CustomResourceOptions? opts = null)

public static Grants get(String name, Output<String> id, GrantsState 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:

Catalog string
ExternalLocation string
ForeignConnection string
Function string
GrantDetails List<GrantsGrant>
Metastore string
Model string
Pipeline string
Recipient string
Schema string
Share string
StorageCredential string
Table string
Volume string

Catalog string
ExternalLocation string
ForeignConnection string
Function string
Grants []GrantsGrantArgs
Metastore string
Model string
Pipeline string
Recipient string
Schema string
Share string
StorageCredential string
Table string
Volume string

catalog String
externalLocation String
foreignConnection String
function String
grants List<GrantsGrant>
metastore String
model String
pipeline String
recipient String
schema String
share String
storageCredential String
table String
volume String

catalog string
externalLocation string
foreignConnection string
function string
grants GrantsGrant[]
metastore string
model string
pipeline string
recipient string
schema string
share string
storageCredential string
table string
volume string

catalog str
external_location str
foreign_connection str
function str
grants Sequence[GrantsGrantArgs]
metastore str
model str
pipeline str
recipient str
schema str
share str
storage_credential str
table str
volume str

catalog String
externalLocation String
foreignConnection String
function String
grants List<Property Map>
metastore String
model String
pipeline String
recipient String
schema String
share String
storageCredential String
table String
volume String

Supporting Types

GrantsGrant, GrantsGrantArgs

Principal string
Privileges List<string>

Principal string
Privileges []string

principal String
privileges List<String>

principal string
privileges string[]

principal str
privileges Sequence[str]

principal String
privileges List<String>

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Databricks v1.46.1 published on Friday, Jun 28, 2024 by Pulumi

pulumi/pulumi-databricks

databricks.Grants

On this page

On this page

Import

Create Grants Resource

Constructor syntax

Parameters

Constructor example

Grants Resource Properties

Inputs

Outputs

Look up Existing Grants Resource

Supporting Types

GrantsGrant, GrantsGrantArgs

Package Details

On this page

On this page