@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
137 lines (136 loc) • 5.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* [](https://docs.databricks.com/aws/en/release-notes/release-types)
*
* Request for Access (RFA) access request destinations allow you to configure where notifications are sent when users request access to securable objects in Unity Catalog. This resource enables you to manage access request destinations for specific securable objects, such as tables, catalogs, or schemas.
*
* When a user requests access to a securable object, notifications can be sent to various destinations including email addresses, Slack channels, or Microsoft Teams channels. This resource allows you to configure these destinations to ensure that the appropriate stakeholders are notified of access requests.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const customerDataTable = new databricks.RfaAccessRequestDestinations("customer_data_table", {
* destinations: [
* {
* destinationId: "john.doe@databricks.com",
* destinationType: "EMAIL",
* },
* {
* destinationId: "https://www.databricks.com/",
* destinationType: "URL",
* },
* {
* destinationId: "456e7890-e89b-12d3-a456-426614174001",
* destinationType: "SLACK",
* },
* {
* destinationId: "789e0123-e89b-12d3-a456-426614174002",
* destinationType: "MICROSOFT_TEAMS",
* },
* {
* destinationId: "012e3456-e89b-12d3-a456-426614174003",
* destinationType: "GENERIC_WEBHOOK",
* },
* ],
* securable: {
* type: "SCHEMA",
* fullName: "main.customer_data",
* },
* areAnyDestinationsHidden: false,
* });
* ```
*
* ## Import
*
* As of Pulumi v1.5, resources can be imported through configuration.
*
* hcl
*
* import {
*
* id = ""
*
* to = databricks_rfa_access_request_destinations.this
*
* }
*
* If you are using an older version of Pulumi, import the resource using the `pulumi import` command as follows:
*
* ```sh
* $ pulumi import databricks:index/rfaAccessRequestDestinations:RfaAccessRequestDestinations this ""
* ```
*/
export declare class RfaAccessRequestDestinations extends pulumi.CustomResource {
/**
* Get an existing RfaAccessRequestDestinations 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?: RfaAccessRequestDestinationsState, opts?: pulumi.CustomResourceOptions): RfaAccessRequestDestinations;
/**
* Returns true if the given object is an instance of RfaAccessRequestDestinations. 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 RfaAccessRequestDestinations;
/**
* (boolean) - Indicates whether any destinations are hidden from the caller due to a lack of permissions.
* This value is true if the caller does not have permission to see all destinations
*/
readonly areAnyDestinationsHidden: pulumi.Output<boolean>;
/**
* The access request destinations for the securable
*/
readonly destinations: pulumi.Output<outputs.RfaAccessRequestDestinationsDestination[] | undefined>;
/**
* The securable for which the access request destinations are being retrieved
*/
readonly securable: pulumi.Output<outputs.RfaAccessRequestDestinationsSecurable>;
/**
* Create a RfaAccessRequestDestinations 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: RfaAccessRequestDestinationsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RfaAccessRequestDestinations resources.
*/
export interface RfaAccessRequestDestinationsState {
/**
* (boolean) - Indicates whether any destinations are hidden from the caller due to a lack of permissions.
* This value is true if the caller does not have permission to see all destinations
*/
areAnyDestinationsHidden?: pulumi.Input<boolean>;
/**
* The access request destinations for the securable
*/
destinations?: pulumi.Input<pulumi.Input<inputs.RfaAccessRequestDestinationsDestination>[]>;
/**
* The securable for which the access request destinations are being retrieved
*/
securable?: pulumi.Input<inputs.RfaAccessRequestDestinationsSecurable>;
}
/**
* The set of arguments for constructing a RfaAccessRequestDestinations resource.
*/
export interface RfaAccessRequestDestinationsArgs {
/**
* The access request destinations for the securable
*/
destinations?: pulumi.Input<pulumi.Input<inputs.RfaAccessRequestDestinationsDestination>[]>;
/**
* The securable for which the access request destinations are being retrieved
*/
securable: pulumi.Input<inputs.RfaAccessRequestDestinationsSecurable>;
}